Sign in
Inventory

List inventory records for a single product

Returns inventory records for a single product at all outlets.

🔒 Requires: inventory:read scope

get/inventory/{product_id}

Path parameters

product_idstring required

The product to fetch inventory levels for. When combined with variants: true, it's treated as a root product ID and matches all variants of that product; otherwise it matches the exact product.

Query parameters

afterinteger

The lower limit for the version numbers to be included in the response.

beforeinteger

The upper limit for the version numbers to be included in the response.

page_sizeinteger

The maximum number of items to be returned in the response.

variantsboolean

When true (and product_id is set), matches all variant products sharing the same root_product_id, rather than just the exact product.

include_deletedboolean

Whether to include inventory records for deleted products.

order_direction'asc' | 'desc'

Whether to order the results ascending or descending by version.

Response

average_costnumber double nullable

The average cost of inventory available to sell.

current_inventory_levelnumber double

Current inventory level.

deleted_atstring date-time nullable

The deletion timestamp in UTC, or null if not deleted.

idstring

Auto-generated object ID.

outlet_idstring

The ID of the outlet associated with this inventory record.

product_idstring

The ID of the product associated with this inventory record.

quantity_to_procurenumber double

Quantity of stock to procure in order to satisfy current fulfilments and service orders.

reorder_amountnumber double nullable

The quantity to order to reach the desired stock level. For the FIXED method, this is a static amount that was set when the reorder method was configured. For MIN_MAX, this is dynamically computed as the difference between reorder_target and current_inventory_level, or zero if current stock exceeds the target. This computation is independent of reorder_point and may produce a non-zero value even when current_inventory_level is above the reorder point. It is null if no reorder method is configured.

reorder_method'FIXED' | 'MIN_MAX' | 'null' nullable

The reorder strategy in use. Either FIXED or MIN_MAX. Null if no reorder method is configured.

reorder_pointnumber double nullable

The inventory level at which a product should be automatically included in stock orders.

reorder_targetnumber double nullable

The desired stock level to restore to when reordering. For reorder_method MIN_MAX, this is the target the reorder amount is computed against. For FIXED, this equals reorder_point + reorder_amount. Null if no reorder method is configured.

versioninteger

Auto-incrementing object version number.

Changes

No recorded changes to this endpoint across all 1 revision of this API.