Skip to main content

Get Contribution Margin Summary

GET 
/api/reporting/contribution-margin/summary

Contribution margin measures profitability after both cost of goods sold and allocated operating costs:

  • Gross Profit = Revenue − COGS
  • Contribution Dollars = Gross Profit − Allocated Costs
  • Contribution Margin % = Contribution Dollars ÷ Revenue × 100
Required scope: reports:read

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

Revenue and COGS come from per-order-line financial records that are kept current by background financial calculations. Allocated costs come from the cost allocation system (cost entries prorated across products, orders, brands, suppliers, or sales channels).

Returns the account-wide profitability summary as a single Overall row: total revenue, COGS, allocated costs, gross profit, contribution dollars, margin percentages, units sold, and order count. Entity filters (product, brand, supplier, sales channel) narrow the underlying sales data; cost_entry_type_id narrows the allocated-cost figures.

Date filtering: date_from and date_to must BOTH be provided for date filtering to apply — if either is omitted the report covers all available history. Sales figures are filtered by order date; allocated costs are matched by their allocation period when one is set (any overlap with the requested range counts), otherwise by their allocation date.

Authentication: Requires Bearer token. Scope: reports (read/write).

Request​

Responses​

OK

Response Headers
    Content-Type