Create Merchandise Plan
POST/api/open-to-buy/merchandise-plans
Create a plan row for a node/period and compute its initial OTB.
Fields:
- retail_period_id (required, integer, exists)
- node_type (required, enum: category | brand | department | product)
- node_id (required, integer >= 0)
- planned_sales_value (optional, numeric >= 0)
- planned_sales_units (optional, integer >= 0)
- planned_markdown_value (optional, numeric >= 0)
- planned_eop_value (optional, numeric >= 0)
- planned_eop_units (optional, integer >= 0)
- budget_enforced (optional, boolean) — enforce the OTB guardrail on forecast buys
- budget_cap_value (optional, nullable, numeric >= 0) — manual cash ceiling; effective budget = min(computed OTB, this)
Requires the inventory read/write scope.
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.