Skip to main content

Create Scenario

POST 
/api/v2/pro-forma/scenarios

Save a what-if scenario snapshot for the authenticated user.

Body fields:

  • name (required, string, max 255)
  • channel_type (required, string, max 50) — e.g. amazon, shopify, ebay, custom
  • product_id (optional, nullable, integer, exists:products) — null for hypothetical products (store the manual profile in inputs.manual_profile)
  • integration_instance_id (optional, nullable, integer, exists:integration_instances)
  • inputs (required, object) — full input snapshot: prices, fee overrides, advanced levers, manual_profile
  • outputs (required, object) — computed metrics snapshot: net_profit, margin_pct, roi_pct, breakeven_price, ...
  • rate_card_version (optional, nullable, string, max 50) — rate-card version used, enables "superseded rates" prompts

Requires Bearer token (products scope).

Request​

Responses​

OK

Response Headers
    Content-Type