Skip to main content
GET
List all inventories

Authorizations

Authorization
string
header
required

Access token

Query Parameters

page
integer
default:1

Page number, starting at 1. Non-integer values and values below 1 return 400.

Required range: x >= 1
limit
integer
default:25

Results per page. Values outside 1–100 are clamped to that range. Non-integer input returns 400.

Required range: 1 <= x <= 100
sort_by
string

JSON string format: {"field1":"asc", "field2":"desc"} json string in format {'field_name':'asc', 'other_field_name':'desc', ...}

filters
string

JSON object

Example:

"{\"condition\":\"AND\",\"filters\":[{\"type\":\"data\",\"field\":\"status\",\"operator\":\"equals\",\"value\":\"success\"}]}"

product_id
string
product_variant_id
string
view
enum<string>

List stock by item. Use warehouse to include warehouse details alongside each item; quantities remain totals across the item’s warehouses.

Available options:
item,
warehouse

Response

OK

message
string
required
success
boolean
required
content
object
required