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

Search is available for 3 fields: Inventory ID, Name, and SKU. Expected behavior for search by Inventory ID is exact match. Expected behavior for search by Inventory Name or SKU is partial match (consecutive characters, case insensitive).

InventoryIdsstringOptional

Comma-separated list of inventory IDs to filter results. Use this to retrieve inventory levels for specific inventory items only.

IsActivebooleanOptional
Filter inventory levels by active status. Set to true to return only active inventory items, false for inactive items. Omit to return all items regardless of status.
IsDigitalbooleanOptional
Filter inventory levels by digital product status. Set to true to return only digital products, false for physical products. Digital products are items that don't require physical fulfillment.
PageSizestringOptionalformat: "int32"
Number of inventory level items to return per page. Controls pagination size for the response.
SortBystringOptional

Sort results by field name. Default is ascending order. Prefix with ’-’ for descending order (e.g., ‘-total_on_hand_quantity’ sorts by quantity descending). Multiple fields can be comma-separated.

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