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. Use this endpoint to answer how much stock or how many fulfillable units of an item are available.

Authentication

AuthorizationBearer

Authentication using Personal Access Token (PAT) token

OR
AuthorizationBearer
OAuth2 authentication using JWT tokens

Path parameters

inventoryIdintegerRequired

Response

OK
inventory_idintegerOptional
namestring or nullOptional
skustring or nullOptional
total_awaiting_quantityintegerOptional
total_backordered_quantityintegerOptional
total_committed_quantityintegerOptional
total_exception_quantityintegerOptional
total_fulfillable_quantityintegerOptional
total_internal_transfer_quantityintegerOptional
total_on_hand_quantityintegerOptional
total_sellable_quantityintegerOptional

Errors

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