POST
/
receiving
curl --request POST \
  --url https://api.shipbob.com/2.0/receiving \
  --header 'Authorization: <api-key>' \
  --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",
  "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",
  "inventory_quantities": [
    {
      "expected_quantity": 0,
      "inventory_id": 0,
      "received_quantity": 0,
      "sku": "string",
      "stowed_quantity": 0
    }
  ],
  "last_updated_date": "2019-08-24T14:15:22Z",
  "package_type": "Package",
  "purchase_order_number": "string",
  "status": "Awaiting"
}

Authorizations

​
Authorization
string
header
required

Provide your personal access token in the format 'Bearer {your_personal_access_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

Information about a box shipment to be added to a receiving order

​
expected_arrival_date
string
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

201
application/json
Success
​
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
​
expected_arrival_date
string

Expected date that all packages will have arrived

​
fulfillment_center
object

Information about a fulfillment center

​
id
integer

Unique id of the warehouse receiving order

​
insert_date
string

Insert date of the receiving order

​
inventory_quantities
object[] | null

Inventory items and quantities within the WRO

​
last_updated_date
string

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

Was this page helpful?