Get a Warehouse Receiving Order by Purchase Order Number (DEPRECATED)

curl --request GET \
  --url https://api.shipbob.com/1.0/receiving \
  --header 'Authorization: Bearer <token>'

{
  "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"
}

GET

1.0

receiving

Get a Warehouse Receiving Order by Purchase Order Number (DEPRECATED)

curl --request GET \
  --url https://api.shipbob.com/1.0/receiving \
  --header 'Authorization: Bearer <token>'

{
  "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

Authentication using Personal Access Token (PAT) token

Query Parameters

purchaseOrderNumber

string

Purchase order number of the 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

Show child attributes

boxes.arrived_date

string<date-time> | null

Date the box arrived

boxes.box_id

integer<int32>

boxes.box_items

object[] | null

Information about the items included in the box

Show child attributes

boxes.box_items.inventory_id

integer<int32>

Unique identifier of the inventory item

boxes.box_items.lot_date

string<date-time> | null

Expiration date of the item's lot

boxes.box_items.lot_number

string | null

Lot number the item belongs to

boxes.box_items.quantity

integer<int32>

Quantity of the item included

boxes.box_items.received_quantity

integer<int32>

Quantity of the item that was received after processing the receiving order

boxes.box_number

integer<int32>

The number of the box in the receiving order

boxes.box_status

enum<string>

Available options:

Awaiting,

Arrived,

Completed,

Counting,

Stowing,

Cancelled

boxes.counting_started_date

string<date-time> | null

Date counting of the box's inventory items started

boxes.received_date

string<date-time> | null

Date the box was received

boxes.tracking_number

string | null

Tracking number of the box shipment

Example:

"860C8CDC8F0B4FC7AB69AC86C20539EC"

expected_arrival_date

string<date-time>

Expected date that all packages will have arrived

fulfillment_center

object

Information about a fulfillment center

Show child attributes

fulfillment_center.address1

string | null

Address line one of the fulfillment center

Example:

"5900 W Ogden Ave"

fulfillment_center.address2

string | null

Address line two of the fulfillment center

Example:

"Suite 100"

fulfillment_center.city

string | null

City the fulfillment center is located in

Example:

"Cicero"

fulfillment_center.country

string | null

Country the fulfillment center is located in

Example:

"USA"

fulfillment_center.email

string | null

Email contact for the fulfillment center

Example:

"[email protected]"

fulfillment_center.id

integer<int32>

Unique identifier of the fulfillment center

fulfillment_center.name

string | null

Name of the fulfillment center

Example:

"Cicero (IL)"

fulfillment_center.phone_number

string | null

Phone number contact for the fulfillment center

Example:

"555-555-5555"

fulfillment_center.state

string | null

State the fulfillment center is located in

Example:

"IL"

fulfillment_center.timezone

string | null

Timezone the fulfillment center is located in

Example:

"Central Standard Time"

fulfillment_center.zip_code

string | null

Postal code of the fulfillment center

Example:

"60804"

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

Cancel Warehouse Receiving Order (DEPRECATED) Create Warehouse Receiving Order (DEPRECATED)

⌘I

API Reference

Authorizations

Query Parameters

Response