GET
/
2.0
/
inventory
curl --request GET \
  --url https://api.shipbob.com/2.0/inventory \
  --header 'Authorization: Bearer <token>'
{
  "first": "string",
  "items": [
    {
      "barcode": "string",
      "dimensions": {
        "height": 0.1,
        "is_locked": true,
        "length": 0.1,
        "unit": "string",
        "validated": true,
        "width": 0.1
      },
      "inventory_id": 0,
      "is_case": true,
      "is_lot": true,
      "name": "string",
      "sku": "string",
      "user_id": 0,
      "variant": {
        "hazmat": {
          "is_hazmat": true,
          "validated": true
        },
        "is_active": true,
        "is_bundle": true,
        "is_digital": true
      },
      "weight": {
        "unit": "string",
        "value": 0.1
      }
    }
  ],
  "last": "string",
  "next": "string",
  "prev": "string"
}

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

​
SearchBy
string
​
FilterOperations
string
​
InventoryIds
string
​
IsActive
boolean
​
IsDigital
boolean
​
PageSize
string
​
SortBy
string

Response

200
application/json

OK

The response is of type object.