For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
This page is for version 2026-07 (default).
For other versions, use one of these documentation indexes:
- 2026-07 (default): https://developer-stage.shipbob.dev/2026-07/llms.txt
- 2026-01: https://developer-stage.shipbob.dev/2026-01/llms.txt
- 2025-07: https://developer-stage.shipbob.dev/2025-07/llms.txt
- v2.0: https://developer-stage.shipbob.dev/v2.0/llms.txt
- v1.0: https://developer-stage.shipbob.dev/v1.0/llms.txt
- Experimental: https://developer-stage.shipbob.dev/experimental/llms.txt
Authentication using Personal Access Token (PAT) token
OR
AuthorizationBearer
OAuth2 authentication using JWT tokens
Request
The receiving order to create
box_packaging_typeenumRequired
Allowed values:
boxeslist of objectsRequired
Box shipments to be added to this receiving order
expected_arrival_datedatetimeRequired
Expected arrival date of all the box shipments in this receiving order. Requires a full RFC 3339 date-time, for example 2026-08-05T00:00:00Z; a bare date such as 2026-08-05 is rejected.
fulfillment_centerobjectRequired
Model containing information that assigns a receiving order to a fulfillment center.
If the fulfillment center provided is in a receiving hub region, then the response will be the receiving hub location.
package_typeenumRequired
Allowed values:
final_destination_fulfillment_center_idinteger or nullOptional>=1
Fulfillment center the inventory is routed to after it is received at fulfillment_center, such as a spoke site served by a receiving hub. Only allowed for certain fulfillment centers and merchants. Fees may apply when routing to it requires cross-region transportation.
purchase_order_numberstring or nullOptional
Purchase order number for this receiving order
Response
Created
box_labels_uristring or nullOptional
URL to the packing slip to be included in each box shipment for this receiving order
box_packaging_typeenumOptional
Allowed values:
expected_arrival_datedatetimeOptional
Expected date that all packages will have arrived. Returned as a full RFC 3339 date-time, for example 2026-08-05T00:00:00Z.
external_sync_timestampdatetime or nullOptional
The timestamp in UTC when a 3rd party integrator has set in our system
final_destination_fulfillment_center_idinteger or nullOptional
Fulfillment center the inventory is routed to after it is received at fulfillment_center, when one was set on the receiving order. Null otherwise.
fulfillment_centerobjectOptional
Information about a fulfillment center
idintegerOptional
Unique id of the warehouse receiving order
insert_datedatetimeOptional
Insert date of the receiving order. Returned as a full RFC 3339 date-time, for example 2026-08-05T00:00:00Z.
inventory_quantitieslist of objects or nullOptional
Inventory items and quantities within the WRO
last_updated_datedatetimeOptional
Last date the receiving order was updated. Returned as a full RFC 3339 date-time, for example 2026-08-05T00:00:00Z.
package_typeenumOptional
Allowed values:
purchase_order_numberstring or nullOptional
Purchase order number for a receiving order
statusenumOptional
status_historylist of objects or nullOptional
The history of status changes for this receiving order