Update Merchandise Plan (cell save / cash cap)
PATCH/api/open-to-buy/merchandise-plans/:merchandisePlan
Update editable plan cell(s) — a debounced save — and recompute OTB. PATCH only the changed fields.
Fields (all optional / 'sometimes'):
- planned_sales_value (numeric >= 0)
- planned_sales_units (integer >= 0)
- planned_markdown_value (numeric >= 0)
- planned_eop_value (numeric >= 0)
- planned_eop_units (integer >= 0)
- budget_enforced (boolean)
- budget_cap_value (nullable, numeric >= 0) — set a manual cash ceiling; pass null to clear it (back to the full computed OTB)
When a cash cap below the computed OTB is set, effective_otb_value and otb_remaining_value drop to the cap.
Requires the inventory read/write scope.
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 429
OK
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 Content
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.