Get OTB Breakdown
GET/api/open-to-buy/merchandise-plans/:merchandisePlan/otb
Live OTB + remaining + committed breakdown for a plan row.
Returns: otb_value, otb_units, bop_value, bop_units, on_order_value, committed_value, budget_cap_value (nullable), effective_otb_value (= min(otb_value, cap)), otb_remaining_value (= effective − committed), and status (under_budget | near_budget | over_budget).
Requires the inventory read/write scope.
Request
Responses
- 200
- 401
- 403
- 404
- 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.
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.