List variants (forecast and replenishment)
inventoryplanner_list_variantsRead-only
List product variants with Inventory Planner's computed metrics (forecast, replenishment, days to sell out, lost revenue, lead time, review period and ~200 more). Always pass fields to pick the metrics you need (default: id,sku,lead_time,review_period,replenishment,oos,under_value; oos = forecasted days to sell out, under_value = forecasted lost revenue, replenishment = recommended order quantity). Use filters and sort for questions like "which SKUs need reordering". Removed variants are excluded unless include_removed. GET /api/v1/variants.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number, counting from 0 (default 0). Pass the previous reply's next_page. | |
| sort | No | Sort by one field, e.g. {"field": "under_value", "direction": "desc"}. | |
| limit | No | Results per page, 1-1000 (default 25). | |
| fields | No | ||
| filters | No | Filters, as {"<field>": value} or {"<field>_<operator>": value}. Operators: eq (default), eqi (case-insensitive), ne, gt, gte, lt, lte, range ("5-10"), match (regex), in (comma-separated). Example: {"replenishment_gt": 0, "sku_match": "^TSHIRT"}. | |
| include_removed | No |