GET
/
receiving
curl --request GET \
  --url https://api.shipbob.com/1.0/receiving \
  --header 'Authorization: <api-key>'
{
  "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"
}

Authorizations

Authorization
string
header
required

Provide your personal access token in the format 'Bearer {your_personal_access_token}'

Query Parameters

purchaseOrderNumber
string

Purchase order number of the receiving order

Response

200
application/json
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

Information about a box shipment included in a receiving order

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

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