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. Returns the inventory item catalog (item records and their attributes), not stock quantities; for current stock counts use the inventory levels endpoint (GET /inventory-level).

Authentication

AuthorizationBearer

Authentication using Personal Access Token (PAT) token

OR
AuthorizationBearer
OAuth2 authentication using JWT tokens

Query parameters

SearchBystringOptional
FilterOperationslist of objectsOptional
InventoryIdslist of integersOptional
IsActivebooleanOptional
IsDigitalbooleanOptional
PageSizeintegerOptional
SortBystringOptional

Sort results by field name. Valid fields: id, inventory_id, name, barcode, sku. 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 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