Skip to main content
GET
List Inventory Levels

List Inventory Levels

Returns inventory levels for product variants across all locations.

Request

Parameters

page
integer
default:"1"
Page number for pagination
limit
integer
default:"50"
Number of items per page (max 250)
location_id
string
Filter by inventory location ID
inventory_item_ids
string
Comma-separated list of inventory item IDs to retrieve
variant_ids
string
Comma-separated list of variant IDs to retrieve
updated_at_min
string
Filter inventory updated after this date (ISO 8601)

Response

success
boolean
Whether the request succeeded
data.items
array
Array of inventory level objects
data.pagination
object
Pagination information

Example Response

Inventory Quantities Explained

FieldDescription
on_handTotal physical inventory at the location
committedReserved for unfulfilled orders
incomingExpected from purchase orders or transfers
availableCan be sold (on_hand - committed)

Error Codes

CodeDescription
UNAUTHORIZEDInvalid or missing access token
FORBIDDENApp doesn’t have read_inventory scope