Skip to main content
GET
List Inventory Levels

List Inventory Levels

Returns inventory levels for product variants. Each inventory item maps to a product variant (or to a product when it has no variants); inventory_item_id is the variant ID (or product ID for variant-less products).

Request

Parameters

integer
default:"1"
Page number for pagination
integer
default:"50"
Number of items per page
string
Return inventory levels for all variants of this product (returns the product-level stock when the product has no variants)
string
Return the inventory level for a single variant

Response

Returns the standard response envelope. The data object contains an inventory_levels array. When listing all items (no product_id / variant_id filter), data also includes flat total, page, and limit fields.
array
Array of inventory level objects
integer
Total number of inventory items (only present when listing all items)

Example Response

When filtering by product_id or variant_id, the total, page, and limit fields are omitted:

Error Response

If a product_id or variant_id filter is supplied and no matching record exists: