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

Authorizations

​
Authorization
string
header
required

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

Information about an inventory item's dimensions

​
fulfillable_quantity_by_fulfillment_center
object[] | null

Fulfillable quantity of this inventory item broken down by fulfillment center location

Break down of fulfillable quantity by fulfillment center

​
fulfillable_quantity_by_lot
object[] | null

Fulfillable quantity of this inventory item broken down by lot

Break down of fulfillable quantity by lot

​
id
integer

Unique id of the inventory item

​
is_active
boolean

Whether the inventory is active or not

​
is_case_pick
boolean

True if the inventory item is marked as case pick

​
is_digital
boolean

True if the inventory item is marked as a digital item

​
is_lot
boolean

True if this inventory item is organized into lots

​
name
string | null

Name of the inventory item

Example:

"Medium Blue T-Shirt"

​
packaging_attribute
enum<integer>
​
total_awaiting_quantity
integer

Total quantity in unreceived receiving orders for this inventory item

​
total_backordered_quantity
integer

The amount of the item you need to send to ShipBob to fulfill all exception orders containing the item. This is the exception_quantity less the fulfillable_quantity of the item.

​
total_committed_quantity
integer

Total committed quantity of this inventory item

​
total_exception_quantity
integer

The total quantity of all items that are contained within orders that are in exception/out of stock status. Out of stock orders have not been processed and therefore do not have lot or fulfillment centers assigned.

​
total_fulfillable_quantity
integer

Total fulfillable quantity of this inventory item

​
total_internal_transfer_quantity
integer

The total quantity of all items that are in the process of internal transit between ShipBob fulfillment centers. These items are not pickable or fulfillable until they have been received and moved to the "On Hand" quantity of the destination FC. Internal transit quantities for each FC represent the incoming transfer stock for that specific location.

​
total_onhand_quantity
integer

Total onhand quantity of this inventory item

​
total_sellable_quantity
integer

Total quantity that can be sold without overselling the inventory item. This is calculated by subtracting the total exception quantity from the fulfillable quantity.

Was this page helpful?