GET
/
1.0
/
inventory
curl --request GET \
  --url https://api.shipbob.com/1.0/inventory \
  --header 'Authorization: Bearer <token>'
[
  {
    "dimensions": {
      "depth": 0.1,
      "length": 0.1,
      "weight": 0.1,
      "width": 0.1
    },
    "fulfillable_quantity_by_fulfillment_center": [
      {
        "awaiting_quantity": 0,
        "committed_quantity": 0,
        "fulfillable_quantity": 0,
        "id": 0,
        "internal_transfer_quantity": 0,
        "name": "Cicero",
        "onhand_quantity": 0
      }
    ],
    "fulfillable_quantity_by_lot": [
      {
        "awaiting_quantity": 0,
        "committed_quantity": 0,
        "expiration_date": "2019-08-24T14:15:22Z",
        "fulfillable_quantity": 0,
        "fulfillable_quantity_by_fulfillment_center": [
          {
            "awaiting_quantity": 0,
            "committed_quantity": 0,
            "fulfillable_quantity": 0,
            "id": 0,
            "internal_transfer_quantity": 0,
            "name": "Cicero",
            "onhand_quantity": 0
          }
        ],
        "internal_transfer_quantity": 0,
        "lot_number": "1234",
        "onhand_quantity": 0
      }
    ],
    "id": 0,
    "is_active": true,
    "is_case_pick": true,
    "is_digital": true,
    "is_lot": true,
    "name": "Medium Blue T-Shirt",
    "packaging_attribute": "None",
    "total_awaiting_quantity": 0,
    "total_backordered_quantity": 0,
    "total_committed_quantity": 0,
    "total_exception_quantity": 0,
    "total_fulfillable_quantity": 0,
    "total_internal_transfer_quantity": 0,
    "total_onhand_quantity": 0,
    "total_sellable_quantity": 0
  }
]

Use the Inventory Resource to retrieve ShipBob inventory items and quantities.

An inventory item is a representation of a physical good that may or may not have physical stock in ShipBob’s fulfillment centers. Every product will have one or more inventory items mapped to it.

A bundle product (a set of products that are sold as one combined package – e.g., gift packs or multipacks) is an example of a product that has two or more inventory items mapped to it.

Lot items are physical items that have expiration dates or batch numbers and should be fulfilled in a FIFO (First In, First Out) manner. Most food items are lot items. Quantities by lot number and/or expiration date are also listed in the Inventory object.

Authorizations

​
Authorization
string
header
required

Authentication using Personal Access Token (PAT) token

Query Parameters

​
Page
number

Page of inventory items to get

Required range: 0 <= x <= 2147483647
​
Limit
number

Amount of inventory items per page to request

Required range: 1 <= x <= 250
​
IsActive
boolean

Whether the inventory should be active or not

​
IsDigital
boolean

Whether the inventory is digital or not

​
IDs
string

Comma separated inventory ids to filter by

​
Sort
string

Sort will default to ascending order for each field. To sort in descending order please pass a "-" in front of the field name. For example, Sort=-onHand,name will sort by onHand descending

​
Search
string

Search is available for 2 fields, Inventory ID and Name -

  1. Expected behavior for search by Inventory ID is exact match
  2. Expected behavior for search by Inventory Name is partial match, i.e. does not have to be start of word, but must be consecutive characters. This is not case sensitive.
​
LocationType
string

LocationType is valid for hub, spoke, or lts. LocationType will default to all locations.

Response

200
application/json

Success

The response is of type object[].