Skip to main content

List Plan vs Actual For A Period

GET 

/api/open-to-buy/merchandise-plans/plan-vs-actual

Plan vs actual for every plan row of a retail period in one call. Each row carries node_type and node_id plus the same fields as Get Plan vs Actual.

Required scope: inventory:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

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).

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​

OK

Response Headers
    Content-Type