List inventory levels
Returns a paginated list of inventory levels.
🔒 Requires: inventory:read scope
Request body
If filtering by root_product_ids and group_variants is true, one aggregated level will be returned for each variant family at each outlet.
Include composite products in the response.
Include inactive products in the response.
Optional outlet IDs to filter response by.
How many inventory levels to skip.
Optional product IDs to filter response by. Mutually exclusive with root_product_ids. When omitted, returns inventory levels for all products.
Optional root product IDs to filter response by. Mutually exclusive with product_ids. When omitted, returns inventory levels for all products.
How many inventory levels to return.
Whether to sort the response ascending or descending.
Which response field to sort by.
Optional supplier IDs to filter response by.
Only include inventory with a positive quantity to procure.
Response
The average cost of inventory available to sell.
🔒 Requires: product:cost:view scope
Total inventory available to sell.
Quantity of stock to procure in order to satisfy current fulfilments and service orders.
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.
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.
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.
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.
The root product ID of the product's variant family.
The total cost of inventory available to sell.