List Forecast Run Lines
GET/api/inventory-forecasting/schedule-runs/:runId/lines
List the stored per-line breakdown for a forecast run, paginated. Each line captures the recommended quantity, confidence tier and drivers, and the inventory/sales snapshots that fed the calculation.
purchase-orders:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Requires Bearer token.
Path parameter: runId - the forecast run to read lines for.
Pagination: page (default 1), per_page (default 15).
final_quantity is a whole number for products ordered in whole units. When the configuration's rounding keeps decimals (for example a product sold by weight), it is a decimal such as 2.7.
inputs.event_units (number, present when dated events apply) is the extra units that dated events — a promo window's next occurrence or a manual event — add on the event days that fall inside this order's cover. They are added once to the order rather than raising the everyday daily average.
Request
Responses
- 200
- 401
- 403
- 404
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.