Reports

Revenue by sales channel report

Breaks down submitted and settled basket revenue by sales channel — useful for attributing income to the originating booking journey (website widget, in-spa POS, partner integration, etc.). Each entry also returns a per-revenue-centre split so the same totals can be sliced further.

For exports over very large date ranges, queue a CSV with /shop/reports/revenue-by-sales-channel/queue.

get/shop/reports/revenue-by-sales-channel

Query parameters

site_idstring uuid

Restrict the report to baskets at the given site.

revenue_date_fromstring date

Example:2026-06-01

Restrict to baskets with a revenue date on or after this date.

revenue_date_tostring date

Example:2026-06-30

Restrict to baskets with a revenue date on or before this date.

submitted_at_fromstring date

Restrict to baskets submitted on or after this date.

submitted_at_tostring date

Restrict to baskets submitted on or before this date.

item_date_fromstring date

Restrict to baskets containing items dated on or after this date.

item_date_tostring date

Restrict to baskets containing items dated on or before this date.

sales_channelstring[]

A comma-separated list of sales channel IDs to filter on.

revenue_centrestring[]

A comma-separated list of revenue centre keys or IDs to filter on.

Response

The report was successfully generated.

Example response

{
  "data": [
    {
      "sales_channel_id": "69c128bf5a210879a60ac186",
      "gross_revenue": 250000,
      "net_revenue": 208000,
      "revenue_centres": [
        {
          "revenue_centre": "spa",
          "gross_revenue": 120000,
          "net_revenue": 100000
        }
      ]
    }
  ],
  "meta": {
    "sales_channels": [
      {
        "name": "Website"
      }
    ],
    "revenue_centres": [
      {
        "name": "Website"
      }
    ]
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.