Version: 202607
List inventory levels
GET/openapi/2026-07/inventory_levels
Returns a paginated list of inventory levels.
Request
Query Parameters
inventory_item_ids string[]
List of inventory item IDs. Example: ?inventory_item_ids=1003&inventory_item_ids=1004
location_ids string[]
Location to filter inventory details (optional) ID. Example: ?location_ids=3001&location_ids=3002
cursor string
Cursor for pagination
page_size int32
A limit on the number of objects to return
updated_at_min string
Minimum update time (ISO 8601 format, e.g., 2018-10-01T16:15:47-04:00)
Responses
- 200
OK
- application/json
- Schema
- Example
Schema
- Array [
- ]
codestring
error code
messagestring
error message
data object
inventory_levels object[]
List of inventory levels
inventory_item_idstring
Inventory item ID
location_idstring
Location ID
stockint64
Stock quantity
updated_atstring
Last update timestamp, in ISO-8601 format
cursorstring
Cursor for pagination
has_moreboolean
Whether there are more records
{
"code": "string",
"message": "string",
"data": {
"inventory_levels": [
{
"inventory_item_id": "string",
"location_id": "string",
"stock": 0,
"updated_at": "string"
}
],
"cursor": "string",
"has_more": true
}
}