Skip to main content
POST
/
1.0
/
receiving
Create Warehouse Receiving Order (DEPRECATED)
curl --request POST \
  --url https://api.shipbob.com/1.0/receiving \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "box_packaging_type": "EverythingInOneBox",
  "boxes": [
    {
      "box_items": [
        {
          "inventory_id": 0,
          "lot_date": "2019-08-24T14:15:22Z",
          "lot_number": "2222",
          "quantity": 1
        }
      ],
      "tracking_number": "860C8CDC8F0B4FC7AB69AC86C20539EC"
    }
  ],
  "expected_arrival_date": "2019-08-24T14:15:22Z",
  "fulfillment_center": {
    "id": 0
  },
  "package_type": "Package",
  "purchase_order_number": "string"
}
'
{
  "box_labels_uri": "https://api.shipbob.com/1.0/receiving/1/labels",
  "box_packaging_type": "EverythingInOneBox",
  "boxes": [
    {
      "arrived_date": "2019-08-24T14:15:22Z",
      "box_id": 0,
      "box_items": [
        {
          "inventory_id": 0,
          "lot_date": "2019-08-24T14:15:22Z",
          "lot_number": "string",
          "quantity": 0,
          "received_quantity": 0
        }
      ],
      "box_number": 0,
      "box_status": "Awaiting",
      "counting_started_date": "2019-08-24T14:15:22Z",
      "received_date": "2019-08-24T14:15:22Z",
      "tracking_number": "860C8CDC8F0B4FC7AB69AC86C20539EC"
    }
  ],
  "expected_arrival_date": "2019-08-24T14:15:22Z",
  "fulfillment_center": {
    "address1": "5900 W Ogden Ave",
    "address2": "Suite 100",
    "city": "Cicero",
    "country": "USA",
    "email": "[email protected]",
    "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:22Z",
  "last_updated_date": "2019-08-24T14:15:22Z",
  "package_type": "Package",
  "purchase_order_number": "string",
  "status": "Awaiting"
}
API 1.0 is deprecated and will be sunset on July 31, 2026. Please migrate to the latest API version. See our Versioning Policy for details.

Authorizations

Authorization
string
header
required

Authentication using Personal Access Token (PAT) token

Body

application/json

The receiving order to create

Information to create a new receiving order

box_packaging_type
enum<string>
required
Available options:
EverythingInOneBox,
OneSkuPerBox,
MultipleSkuPerBox
boxes
object[] | null
required

Box shipments to be added to this receiving order

expected_arrival_date
string<date-time>
required

Expected arrival date of all the box shipments in this receiving order

fulfillment_center
object
required

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_type
enum<string>
required
Available options:
Package,
Pallet,
FloorLoadedContainer
purchase_order_number
string | null

Purchase order number for this receiving order

Response

Success

Information about a receiving order

box_labels_uri
string | null

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

Example:

"https://api.shipbob.com/1.0/receiving/1/labels"

box_packaging_type
enum<string>
Available options:
EverythingInOneBox,
OneSkuPerBox,
MultipleSkuPerBox
boxes
object[] | null

Information about the boxes being shipped in this receiving order

expected_arrival_date
string<date-time>

Expected date that all packages will have arrived

fulfillment_center
object

Information about a fulfillment center

id
integer<int32>

Unique id of the warehouse receiving order

insert_date
string<date-time>

Insert date of the receiving order

last_updated_date
string<date-time>

Last date the receiving order was updated

package_type
enum<string>
Available options:
Package,
Pallet,
FloorLoadedContainer
purchase_order_number
string | null

Purchase order number for a receiving order

status
enum<string>
Available options:
Awaiting,
Processing,
Completed,
Cancelled,
Incomplete,
Arrived,
PartiallyArrived,
PartiallyArrivedAtHub,
ArrivedAtHub,
ProcessingAtHub,
InternalTransfer