Skip to main content

Get Channel Sales History (Pro Forma)

GET 
/api/v2/pro-forma/history

Historical realized actuals for one product on a set of sales channels — the "pro forma vs. actuals" comparison.

Required scope: products:read

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

Metrics (per the period):

  • orders — distinct order count (drafts and cancelled excluded)
  • units — total units sold
  • avg_unit_revenue / avg_unit_cogs / avg_unit_fees — per-unit averages from sales order line financials (fees = allocated settlement/channel costs)
  • avg_unit_shipping — fulfillment costs prorated to the product by quantity share
  • avg_margin_pct — profit / revenue * 100
  • return_rate_pct — quantity-weighted share of lines with credits or returned COGS
  • avg_refund_pct — refund $ as % of gross revenue over returned lines (null when the period has no returns)
  • recovery_rate_pct — COGS recovered (restocked) as % of COGS over returned lines (null when the period has no returns)

data is null when the product has no qualifying orders in the period.

Requires Bearer token (products scope).

Request​

Responses​

OK

Response Headers
    Content-Type