Skip to main content

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.

Required scope: inventory:write

Grant 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​

Created

Response Headers
    Content-Type