Create Guardrail Override
POST/api/open-to-buy/merchandise-plans/:merchandisePlan/overrides
Keep a forecast line that exceeds the plan's remaining open-to-buy. When the plan enforces its budget, a forecast build scoped to this plan will no longer flag or trim the line for this supplier product (it still counts toward committed spend and is marked otb_status = overridden). Re-posting for the same supplier product replaces the override. Every create and delete is recorded in the activity log with the user and reason.
inventory:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Fields:
- supplier_product_id (required, integer, must exist)
- reason (required, string, max 500)
- approved_quantity (optional, number > 0): the override only covers the line up to this quantity
Requires the merchandise_planning.override permission and the inventory scope.
Request
Responses
- 201
- 401
- 403
- 404
- 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.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Unprocessable Entity
Response Headers
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.