Skip to main content

Get Pro Forma Context

GET 
/api/v2/pro-forma/context

Full Pro Forma Analyzer bootstrap payload.

Required scope: products:read

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

Returns one channel tab per connected sales-channel family (Amazon, Shopify, eBay, ...) plus a custom tab. Each tab includes:

  • instances — sync-active integration instances of that family
  • listing (includes product_listing_id) — the product's listing prefill (price, is_fba, listing_sku, asin) when product_id is given
  • fee_defaults — engine-resolved default fee lines (rate cards, instance settings, listing overrides) with provenance source
  • supports_live_fees — true for Amazon (use POST /amazon-fees)
  • fulfillment_options — ["fba", "fbm"] for Amazon, empty otherwise
  • history — 12-month realized actuals on that channel including returns economics (avg_refund_pct, recovery_rate_pct; both null when no returns); null when no orders

Also returns the product's per-unit cogs_breakdown from open FIFO layers (falls back to a single average-cost line) and its saved proforma_assumptions. The product object includes default_price — the price at the product default pricing tier, used as the selling-price fallback when a channel has no listing price (null when no default-tier price is set).

Channel families with no sync-active instance are excluded unless the product has order history there, in which case the tab is kept with an "(inactive)" label.

Requires Bearer token (products scope).

Request​

Responses​

OK

Response Headers
    Content-Type