Update Warehouse Receiving Order | ShipBob Developer API

curl -X PATCH https://api.shipbob.com/Experimental/receiving/1 \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "boxes": [
    {
      "box_items": [
        {
          "quantity": 1,
          "inventory_id": 0,
          "lot_date": "2019-08-24T14:15:22+00:00",
          "lot_number": "2222",
          "sku": "string"
        }
      ],
      "tracking_number": "860C8CDC8F0B4FC7AB69AC86C20539EC"
    }
  ],
  "expected_arrival_date": "2099-08-24T14:15:22+00:00",
  "fulfillment_center": {
    "id": 0
  },
  "purchase_order_number": "string"
}'

{
  "box_labels_uri": "https://api.shipbob.com/1.0/receiving/1/labels",
  "box_packaging_type": "EverythingInOneBox",
  "expected_arrival_date": "2019-08-24T14:15:22+00:00",
  "external_sync_timestamp": "2019-08-24T14:15:22+00:00",
  "fulfillment_center": {
    "address1": "5900 W Ogden Ave",
    "address2": "Suite 100",
    "city": "Cicero",
    "country": "USA",
    "email": "example@example.com",
    "id": 0,
    "name": "Cicero (IL)",
    "phone_number": "555-555-5555",
    "state": "IL",
    "timezone": "Central Standard Time",
    "zip_code": "60804"
  },
  "id": 0,
  "insert_date": "2019-08-24T14:15:22+00:00",
  "inventory_quantities": [
    {
      "expected_quantity": 0,
      "inventory_id": 0,
      "received_quantity": 0,
      "sku": "string",
      "stowed_quantity": 0
    }
  ],
  "last_updated_date": "2019-08-24T14:15:22+00:00",
  "package_type": "Package",
  "purchase_order_number": "string",
  "status": "Awaiting",
  "status_history": [
    {
      "id": 0,
      "status": "Processing",
      "timestamp": "2019-08-24T14:15:22+00:00"
    }
  ]
}

Updates an existing warehouse receiving order. Only the fields included in the request body are changed; omit a field to leave it as it is. The fulfillment center, expected arrival date and boxes can only be changed while the order is awaiting arrival and none of its boxes have started processing, and not once ShipBob shipping labels have been purchased or generated for it. The purchase order number can be changed in any status except complete. Supplying boxes replaces the entire set of boxes and their contents, so send the complete set rather than only the ones that changed.

Authentication

AuthorizationBearer

Authentication using Personal Access Token (PAT) token

AuthorizationBearer

OAuth2 authentication using JWT tokens

Path parameters

idintegerRequired

Id of the receiving order

Request

The changes to apply. Omit a field to leave it unchanged.

boxeslist of objects or nullOptional

Replaces every box on this receiving order and their contents — boxes that are not included are removed, so send the complete set. Only editable while the receiving order is awaiting arrival and none of its boxes have started processing.

expected_arrival_datedatetime or nullOptional

Expected arrival date of all the box shipments in this receiving order. Must be in the future, and only editable while the receiving order is awaiting arrival and none of its boxes have started processing.

fulfillment_centerobject or nullOptional

Fulfillment center this receiving order is being shipped to. Only editable while the receiving order is awaiting arrival and none of its boxes have started processing. Wrapped in allOf so the nullability applies: in OpenAPI 3.0 a keyword alongside $ref is ignored.

purchase_order_numberstring or nullOptional

Purchase order number for this receiving order. Send an empty or blank string to clear it. Surrounding whitespace is trimmed. Editable in any status except complete.

Response

Success

box_labels_uristring or nullOptional

URL to the packing slip to be included in each box shipment for this receiving order

box_packaging_typeenumOptional

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

freightobject or nullOptional

Optional container/freight metadata for this receiving order (null when none was provided)

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

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

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error