Create Manual Run
POST/api/inventory-forecasting/schedule-runs/manual
Create and persist a manual (ad-hoc) forecast run record. Called when users run forecasts manually from the UI.
Any valid API token can call this endpoint — no specific scope required. Manage tokens.
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.