API ReferenceInventory

Get Inventory Levels

View as Markdown

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

Authentication

AuthorizationBearer

Authentication using Personal Access Token (PAT) token or OAuth2

Path parameters

inventoryIdstringRequiredformat: "int32"

Response

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

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

total_fulfillable_quantityinteger or null

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

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

Total quantity available for sale (fulfillable plus awaiting)

Errors