List Merchandise Plans
GET/api/open-to-buy/merchandise-plans
Paginated Open-to-Buy plan grid. Each row carries its live OTB breakdown (otb_value, committed_value, effective_otb_value, otb_remaining_value, status) computed on read.
Effective budget = min(computed OTB, budget_cap_value) when a manual cash cap is set; otb_remaining_value = effective budget − committed.
Requires a Bearer token with the inventory read/write scope (middleware: scope.rw:inventory).
Request
Responses
- 200
- 401
- 403
- 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.
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.