List inventory records
Returns a paginated list of inventory records.
🔒 Requires: inventory:read scope
Request body
The lower limit for the version numbers to be included in the response.
The upper limit for the version numbers to be included in the response.
Whether to include inventory records for deleted products.
Optional filter to restrict results to the specified product. 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.
The maximum number of inventory records to return.
Whether to sort the response by ascending or descending.
When true (and product_id is set), matches all variant products sharing the same root_product_id, rather than just the exact product.
Response
The average cost of inventory available to sell.
Current inventory level.
The deletion timestamp in UTC, or null if not deleted.
Auto-generated object ID.
The ID of the outlet associated with this inventory record.
The ID of the product associated with this inventory record.
Quantity of stock to procure in order to satisfy current fulfilments and service orders.
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.
The reorder strategy in use. Either FIXED or MIN_MAX. Null if no reorder method is configured.
The inventory level at which a product should be automatically included in stock orders.
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.
Auto-incrementing object version number.