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.

Authentication

AuthorizationBearer

Authentication using Personal Access Token (PAT) token or OAuth2

Query parameters

SearchBystringOptional
InventoryIdsstringOptional
IsActivebooleanOptional
IsDigitalbooleanOptional
PageSizestringOptionalformat: "int32"
SortBystringOptional

Response

OK
firststring or null
URL to retrieve the first page of results. Null if already on the first page.
itemslist of objects or null
Array of inventory quantity items in the current page of results.
laststring or null
URL to retrieve the last page of results. Null if already on the last page.
nextstring or null
URL to retrieve the next page of results. Null if on the last page.
prevstring or null
URL to retrieve the previous page of results. Null if on the first page.

Errors