Sign in

v1

latestOpenAPI 3.0.1Apache 2.02026-07-26193304444.4 KB
Inventory

List inventory levels for a single product.

Returns a paginated list of inventory levels for a single product.

🔒 Requires: inventory:read scope

get/inventory_levels/{product_id}

Path parameters

product_idstring uuid required

The product to fetch inventory levels for.

Query parameters

include_inactiveboolean

Whether to include inactive products in the response.

Response

average_costnumber double

The average cost of inventory available to sell.

🔒 Requires: product:cost:view scope

brand_idstring uuid
current_inventory_levelnumber double

Total inventory available to sell.

location_idstring uuid
namestring
product_idstring uuid
product_type_idstring uuid
quantity_to_procurenumber double

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

reorder_amountnumber double

The quantity of stock to reorder. For FIXED, this is the static amount configured when the reorder method was set up. For MIN_MAX, this is dynamically computed as reorder_target minus current_inventory_level (or zero if current stock already meets or exceeds the target). Omitted if no reorder method is configured.

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

The reorder strategy in use. FIXED uses a static reorder amount each time the threshold is reached. MIN_MAX dynamically computes the reorder amount to bring stock up to the configured maximum. Omitted if no reorder method is configured.

reorder_targetnumber double

The target inventory level for replenishment. For FIXED, this equals reorder_threshold + reorder_amount. For MIN_MAX, this is the maximum inventory level to restock to. Omitted if no reorder method is configured.

reorder_thresholdnumber double

The inventory level at which reordering is triggered. For FIXED, this is the reorder point below which a reorder is suggested. For MIN_MAX, this is the minimum inventory level. Omitted if no reorder method is configured.

root_product_idstring uuid

The root product ID of the product's variant family.

supplier_idstring uuid
total_costnumber double

The total cost of inventory available to sell.