object InboundShipment

Fields

Field Type Description

id

String

Public API ID for this identifiable.

legacy_id

BigInt

Numeric legacy ID for this identifiable; use only where legacy IDs are required.

account_id

String

Public API account ID that identifies the related record.

warehouse_id

String

Public API warehouse ID. Use this when passing or filtering by a warehouse; warehouse fields are display values or nested objects.

status

InboundShipmentStatus

Current status; use the API status values returned by this field when filtering or updating.

carrier

String

Carrier name or carrier code used for shipping.

pro_number

String

Pro number for this inbound shipment.

bol_reference

String

Bol reference for this inbound shipment.

bol_url

String

URL for the BOL URL resource.

expected_dock

String

Expected dock for this inbound shipment.

dock_used

String

Dock used for this inbound shipment.

container_number

String

Container number for this inbound shipment.

notes

String

Human-readable notes for this inbound shipment.

estimated_truck_arrival

ISODateTime

Estimated truck arrival as an ISO-8601 datetime, returned in UTC unless otherwise noted.

truck_arrived_at

ISODateTime

Truck arrived at as an ISO-8601 datetime, returned in UTC unless otherwise noted.

truck_unload_started_at

ISODateTime

Truck unload started at as an ISO-8601 datetime, returned in UTC unless otherwise noted.

truck_unload_finished_at

ISODateTime

Truck unload finished at as an ISO-8601 datetime, returned in UTC unless otherwise noted.

truck_departure_at

ISODateTime

Truck departure at as an ISO-8601 datetime, returned in UTC unless otherwise noted.

booking_contact_email

String

Email address for the booking contact contact.

booking_contact_name

String

Booking contact name for this inbound shipment.

booking_contact_number

String

Booking contact number for this inbound shipment.

container_size

InboundShipmentContainerSize

Container size for this inbound shipment.

load_type

InboundShipmentLoad

Load type for this inbound shipment.

shipment_type

InboundShipmentShipment

Shipment type for this inbound shipment.

number_carton

Int

Number carton as a whole-unit count.

pallets_quantity

Int

Pallets quantity as a whole-unit count.

people_for_unload

Int

People for unload as a whole-unit count.

people_for_receiving

Int

People for receiving as a whole-unit count.

vendor_id

String

Public API vendor ID that identifies the related record.

created_at

ISODateTime

Created at as an ISO-8601 datetime, returned in UTC unless otherwise noted.

scheduled_at

ISODateTime

Scheduled at as an ISO-8601 datetime, returned in UTC unless otherwise noted.

status_updated_at

ISODateTime

Status updated at as an ISO-8601 datetime, returned in UTC unless otherwise noted.

warehouse

Warehouse

Warehouse display value or nested warehouse object for this record. Use warehouse_id when passing a warehouse reference.

purchase_orders

PurchaseOrderConnection

List of purchase orders associated with this inbound shipment.

Argument	Type	Required
`sort`	`String`	No
`before`	`String`	No
`after`	`String`	No
`first`	`Int`	No
`last`	`Int`	No

Referenced By

Example

{
  "id": "UmVjb3JkOjEyMzQ=",
  "legacy_id": 1234,
  "account_id": "SW5ib3VuZFNoaXBtZW50OjEyMzQ=",
  "warehouse_id": "SW5ib3VuZFNoaXBtZW50OjEyMzQ=",
  "status": "{id: \"SW5ib3VuZFNoaXBtZW50U3RhdHVzRW51bToxMjM0\"}",
  "carrier": "ups",
  "pro_number": "PRO1234567",
  "bol_reference": "BOL-100045",
  "bol_url": "https://example.com/resource",
  "expected_dock": "Dock 3",
  "dock_used": "Dock 3",
  "container_number": "CONT-100045",
  "notes": "Customer requested expedited handling.",
  "estimated_truck_arrival": "2026-07-09T15:30:00Z",
  "truck_arrived_at": "2026-07-09T15:30:00Z",
  "truck_unload_started_at": "2026-07-09T15:30:00Z",
  "truck_unload_finished_at": "2026-07-09T15:30:00Z",
  "truck_departure_at": "2026-07-09T15:30:00Z",
  "booking_contact_email": "customer@example.com",
  "booking_contact_name": "Inbound Shipment 1001",
  "booking_contact_number": "+1-555-0100",
  "container_size": "{id: \"SW5ib3VuZFNoaXBtZW50Q29udGFpbmVyU2l6ZUVudW06MTIzNA==\"}",
  "load_type": "{id: \"SW5ib3VuZFNoaXBtZW50TG9hZEVudW06MTIzNA==\"}",
  "shipment_type": "{id: \"SW5ib3VuZFNoaXBtZW50U2hpcG1lbnRFbnVtOjEyMzQ=\"}",
  "number_carton": 2,
  "pallets_quantity": 2,
  "people_for_unload": 2,
  "people_for_receiving": 2,
  "vendor_id": "SW5ib3VuZFNoaXBtZW50OjEyMzQ=",
  "created_at": "2026-07-09T15:30:00Z",
  "scheduled_at": "2026-07-09T15:30:00Z",
  "status_updated_at": "2026-07-09T15:30:00Z",
  "warehouse": {id: "V2FyZWhvdXNlOjEyMzQ=", identifier: "Primary Warehouse"},
  "purchase_orders": [{id: "T3JkZXI6MTIzNA==", order_number: "SO-100045"}]
}