Seed Plan From Forecast / Last Year
POST/api/open-to-buy/merchandise-plans/seed
Seed a period's grid in bulk from a forecast or last-year actuals. Each incoming node row upserts a plan and gets its OTB computed.
Fields:
- retail_period_id (required, integer, exists)
- source (required, one of: forecast, last_year)
- rows (required, array, min 1)
- rows.*.node_type (required, enum: category | brand | department | product)
- rows.*.node_id (required, integer >= 0)
- rows.*.planned_sales_value (optional, numeric >= 0)
- rows.*.planned_sales_units (optional, integer >= 0)
- rows.*.planned_markdown_value (optional, numeric >= 0)
- rows.*.planned_eop_value (optional, numeric >= 0)
- rows.*.planned_eop_units (optional, integer >= 0)
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.