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 Inventory Levels
      • GETGet All Inventory Levels Grouped By Fulfillment Center
      • GETGet Inventory
      • GETGet All Inventory Levels
      • GETGet Inventory Levels Grouped By Fulfillment Center
      • GETGet Inventory Levels Grouped By Lot
      • GETGet All Inventories
      • GETGet All Inventory Levels Grouped By Lot
LogoLogo
API ReferenceInventory

Get Inventory Levels

||View as Markdown|
GET
https://sandbox-api.shipbob.com/2026-01/inventory-level/:inventoryId
GET
/2026-01/inventory-level/:inventoryId
$curl https://sandbox-api.shipbob.com/2026-01/inventory-level/1 \
>     -H "Authorization: Bearer <token>"
1{
2  "inventory_id": 0,
3  "name": "string",
4  "sku": "string",
5  "total_awaiting_quantity": 0,
6  "total_backordered_quantity": 0,
7  "total_committed_quantity": 0,
8  "total_exception_quantity": 0,
9  "total_fulfillable_quantity": 0,
10  "total_internal_transfer_quantity": 0,
11  "total_on_hand_quantity": 0,
12  "total_sellable_quantity": 0
13}

Retrieves the aggregated inventory levels for a specific inventory item across all locations, including available, on-hand, committed, and other quantity types.

Was this page helpful?
Next

Get All Inventory Levels Grouped By Fulfillment Center

Built with

Authentication

AuthorizationBearer

Authentication using Personal Access Token (PAT) token

OR
AuthorizationBearer
OAuth2 authentication using JWT tokens

Path parameters

inventoryIdintegerRequired
Unique identifier for the inventory item to retrieve quantity levels for. Use this to get aggregated inventory levels across all locations for a specific item.

Response

OK
inventory_idinteger
Unique identifier for the inventory item
namestring
Name of the inventory item
skustring
Stock keeping unit identifier
total_awaiting_quantityinteger
Total quantity expected to arrive from receiving or transfers
total_backordered_quantityinteger
Total quantity on backorder for pending shipments
total_committed_quantityinteger
Total quantity reserved for existing orders and allocations
total_exception_quantityinteger

Total quantity in exception status (damaged, lost, or under investigation)

total_fulfillable_quantityinteger

Total quantity available to fulfill new orders (on-hand minus committed)

total_internal_transfer_quantityinteger
Total quantity currently in transit between fulfillment centers
total_on_hand_quantityinteger
Total quantity physically present in all fulfillment centers
total_sellable_quantityinteger

Total quantity available for sale (fulfillable plus awaiting)

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error
503
Service Unavailable Error