Create Manual Run
POST/api/inventory-forecasting/schedule-runs/manual
Create and persist a manual (ad-hoc) forecast run record, for example right after calling the build endpoint, so the run appears in the runs list.
purchase-orders:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
The run's per-product lines are stored in the background, rebuilt from configuration_snapshot (include supplier_ids and the same settings you sent to build, including baseline_method, trend_damping_factor, trend_max_growth_pct, trend_half_life_days and exclude_detected_anomalies). Read them with List Forecast Run Lines once the background job finishes; until then that list is empty. Runs with stored lines are kept for at least 37 days so forecast accuracy can be scored.
Authentication: Requires Bearer token.
configuration_snapshot: required — stores the forecast config used.
results_summary: required — stores aggregate results.
purchase_order_ids: optional — IDs of POs created from this run.
Returns 201.
Request
Responses
- 201
- 401
- 403
- 422
- 429
Created
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.
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.