For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
DocumentationAPI Reference
DocumentationAPI Reference
  • API Reference
      • GETGet an inventory item
      • GETGet a list of inventory items by product id
      • GETList inventory items
LogoLogo
API ReferenceInventory

List inventory items

||View as Markdown|
GET
https://sandbox-api.shipbob.com/1.0/inventory
GET
/1.0/inventory
$curl -G https://sandbox-api.shipbob.com/1.0/inventory \
>     -H "Authorization: Bearer <token>" \
>     -d Page=2147483647 \
>     -d Limit=1 \
>     -d IsActive=true \
>     -d IsDigital=true \
>     -d IDs=0 \
>     -d Sort=string \
>     -d Search=string \
>     -d LocationType=string
1[
2  {
3    "dimensions": {
4      "depth": 0.1,
5      "length": 0.1,
6      "weight": 0.1,
7      "width": 0.1
8    },
9    "fulfillable_quantity_by_fulfillment_center": [
10      {
11        "awaiting_quantity": 0,
12        "committed_quantity": 0,
13        "fulfillable_quantity": 0,
14        "id": 0,
15        "internal_transfer_quantity": 0,
16        "name": "Cicero",
17        "onhand_quantity": 0
18      }
19    ],
20    "fulfillable_quantity_by_lot": [
21      {
22        "awaiting_quantity": 0,
23        "committed_quantity": 0,
24        "expiration_date": "2019-08-24T14:15:22+00:00",
25        "fulfillable_quantity": 0,
26        "fulfillable_quantity_by_fulfillment_center": [
27          {
28            "awaiting_quantity": 0,
29            "committed_quantity": 0,
30            "fulfillable_quantity": 0,
31            "id": 0,
32            "internal_transfer_quantity": 0,
33            "name": "Cicero",
34            "onhand_quantity": 0
35          }
36        ],
37        "internal_transfer_quantity": 0,
38        "lot_number": "1234",
39        "onhand_quantity": 0
40      }
41    ],
42    "id": 0,
43    "is_active": true,
44    "is_case_pick": true,
45    "is_digital": true,
46    "is_lot": true,
47    "name": "Medium Blue T-Shirt",
48    "packaging_attribute": "None",
49    "total_awaiting_quantity": 0,
50    "total_backordered_quantity": 0,
51    "total_committed_quantity": 0,
52    "total_exception_quantity": 0,
53    "total_fulfillable_quantity": 0,
54    "total_internal_transfer_quantity": 0,
55    "total_onhand_quantity": 0,
56    "total_sellable_quantity": 0
57  }
58]
Was this page helpful?
Previous

Get a list of inventory items by product id

Next

Get one Shipment's status timeline by Shipment Id

Built with

Authentication

AuthorizationBearer

Authentication using Personal Access Token (PAT) token

OR
AuthorizationBearer
OAuth2 authentication using JWT tokens

Query parameters

PageintegerOptional0-2147483647
Page of inventory items to get
LimitintegerOptional1-250
Amount of inventory items per page to request
IsActivebooleanOptional
Whether the inventory should be active or not
IsDigitalbooleanOptional
Whether the inventory is digital or not
IDslist of integersOptional
Comma separated inventory ids to filter by
SortstringOptional

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

SearchstringOptional
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.
LocationTypestringOptional
LocationType is valid for hub, spoke, or lts. LocationType will default to all locations.

Response

Success
dimensionsobject
Information about an inventory item's dimensions
fulfillable_quantity_by_fulfillment_centerlist of objects
Fulfillable quantity of this inventory item broken down by fulfillment center location
fulfillable_quantity_by_lotlist of objects
Fulfillable quantity of this inventory item broken down by lot
idinteger
Unique id of the inventory item
is_activeboolean
Whether the inventory is active or not
is_case_pickboolean
True if the inventory item is marked as case pick
is_digitalboolean
True if the inventory item is marked as a digital item
is_lotboolean
True if this inventory item is organized into lots
namestring
Name of the inventory item
packaging_attributeenum
total_awaiting_quantityinteger
Total quantity in unreceived receiving orders for this inventory item
total_backordered_quantityinteger

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_quantityinteger
Total committed quantity of this inventory item
total_exception_quantityinteger

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_quantityinteger
Total fulfillable quantity of this inventory item
total_internal_transfer_quantityinteger
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_quantityinteger
Total onhand quantity of this inventory item
total_sellable_quantityinteger
Total quantity that can be sold without overselling the inventory item. This is calculated by subtracting the total exception quantity from the fulfillable quantity.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error

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.