API ReferenceInventory

Get All Inventories

View as Markdown
Retrieves a paginated list of all inventory items. Supports filtering by active status, tags, and various product attributes. Use query parameters to search and filter results.

Authentication

AuthorizationBearer

Authentication using Personal Access Token (PAT) token

OR
AuthorizationBearer
OAuth2 authentication using JWT tokens

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).

FilterOperationslist of objectsOptional

Advanced filtering operations. Apply multiple key-value filters to refine inventory results. Each filter operation contains a ‘key’ (field name) and ‘rawValue’ (filter value) to match.

InventoryIdslist of integersOptional

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

IsActivebooleanOptional
Filter by active status. True returns only active inventory items, False returns only inactive items. Omit to return both.
IsDigitalbooleanOptional

Filter by digital product status. True returns only digital products (no physical fulfillment), False returns only physical products. Omit to return both.

PageSizeintegerOptional
Number of items to return per page. Controls pagination size for the response.
SortBystringOptional

Sort results by field name. Results are returned in ascending order by default; append ’ desc’ to a field for descending order (e.g., ‘name desc’ sorts by name descending).

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 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

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