Reports

Revenue by order label report (v2)

Returns submitted/settled basket revenue grouped by order label, in a JSON-native shape suitable for programmatic consumption. Each entry also includes a per-revenue-centre breakdown. All money fields are integers in minor units.

For the legacy display-formatted variant see /shop/reports/revenue-by-order-label.

get/shop/reports/revenue-by-order-label-v2

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.

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.

labelsstring[]

A comma-separated list of order label IDs to filter on. Pass none to restrict to baskets with no order labels.

revenue_centrestring[]

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

Response

The report was successfully generated.

Example response

{
  "data": [
    {
      "label_id": "69c128c05a210879a60ac1af",
      "label_name": "VIP",
      "gross_revenue": 250000,
      "net_revenue": 208000,
      "revenue_centres": [
        {
          "revenue_centre": "spa",
          "gross_revenue": 120000,
          "net_revenue": 100000
        }
      ]
    }
  ],
  "meta": {
    "revenue_centres": [
      {
        "name": "Website"
      }
    ]
  }
}

Changes

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