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
AuthorizationBearer
OAuth2 authentication using JWT tokens

Path parameters

inventoryIdstringRequiredformat: "int32"

Response

OK
inventory_idinteger
Unique identifier for the inventory item
namestring or null
Name of the inventory item
skustring or null
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_damaged_quantityinteger
Total quantity currently marked as damaged
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_in_fulfillment_quantityinteger
Total quantity of inventory items that are currently in the fulfillment process
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_quarantine_quantityinteger
Total quantity currently in quarantine status
total_sellable_quantityinteger

Total quantity available for sale (fulfillable plus awaiting minus quarantine minus damaged)

userIdinteger

Errors

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