Get Plan vs Actual
GET/api/open-to-buy/merchandise-plans/:merchandisePlan/plan-vs-actual
Plan vs actual for a plan row: actual sales ($ and units), markdowns ($, line + order discounts on sales of the node's products) and purchase-order receipts ($ at cost and units) for the period, beside the planned figures, with variance % = (actual - plan) / plan x 100 (null when the planned figure is zero).
inventory:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
period_status: not_started (no actuals; actual and variance_pct are null) | in_season (actuals from the period start to today) | closed (period ended or locked; actuals for the whole period).
Planned receipts = planned sales + planned markdowns + planned EOP - BOP.
Requires the merchandise_planning.index permission and the inventory 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
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.