API ReferenceInventory

Get All Inventory Levels

View as Markdown

Retrieves current inventory levels across all locations. Returns available, on-hand, committed, and other quantity types. Supports filtering by inventory IDs and product attributes. Use this endpoint for current or real-time stock questions, for example what is in stock or out of stock right now.

Authentication

AuthorizationBearer

Authentication using Personal Access Token (PAT) token

OR
AuthorizationBearer
OAuth2 authentication using JWT tokens

Query parameters

SearchBystringOptional
InventoryIdslist of integersOptional
IsActivebooleanOptional
IsDigitalbooleanOptional
PageSizeintegerOptional
SortBystringOptional
Sort results by field name. Valid fields: id, inventory_id, name, sku, total_fulfillable_quantity, total_on_hand_quantity, total_committed_quantity, total_sellable_quantity, total_awaiting_quantity, total_exception_quantity, total_internal_transfer_quantity, total_backordered_quantity, total_in_fulfillment_quantity. Results are returned in ascending order by default; append ' desc' to a field for descending order (e.g., 'total_on_hand_quantity desc' sorts by quantity descending).

Response

OK
firststring or nullOptional
itemslist of objects or nullOptional
laststring or nullOptional
nextstring or nullOptional
prevstring or nullOptional

Errors

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