Persist Forecast Run Lines
POST/api/inventory-forecasting/schedule-runs/:runId/lines
Build a forecast from the supplied configuration and store its per-line breakdown against an existing forecast run. The work runs in the background; the response returns immediately with a job reference to poll for progress.
Authentication: Requires Bearer token.
Path parameter: runId - the forecast run to attach the persisted lines to.
Body: configuration (required) - the full forecast configuration (forecast type, stock targets, filters, and demand modifiers) to build from.
Returns 202 Accepted with a job reference (tracked_job_log_id).
Request
Responses
- 202
- 401
- 403
- 404
- 422
- 429
Accepted
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.
Validation failed — the body is a field → messages map (Laravel shape) or the platform envelope with a stable machine-readable code. Fix the payload and resubmit.
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.