Sign in
Reports

Item revenues report

Paginated list of submitted/settled basket items annotated with their per-revenue-centre allocations. Useful for reconciling revenue by offering, by revenue centre, or by item date. Money fields are integers in minor units.

For large date ranges or background CSV delivery use /shop/reports/item-revenues/queue.

get/shop/reports/item-revenues

Query parameters

site_idstring uuid required

Restrict to items at the given site.

pageinteger

The page to retrieve results from

revenue_date_fromstring date
Example:2026-06-01

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

revenue_date_tostring date
Example:2026-06-30

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

item_date_fromstring date

Restrict to items dated on or after this date.

item_date_tostring date

Restrict to items dated on or before this date.

order_submitted_at_fromstring date-time

Restrict to items belonging to baskets submitted on or after this time.

order_submitted_at_tostring date-time

Restrict to items belonging to baskets submitted on or before this time.

offering_typestring
Example:appointment

Filter to items of a particular offering type. Pass all to include every type (the default when filters omit this).

offering_idsstring[]

A comma-separated list of offering IDs to filter on.

revenue_centresstring[]

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

Response

The report was successfully generated.

Example response

{
  "data": [
    {
      "id": "60a8c0901d210625e3a87667",
      "basket_id": "60a8c0901d210625e3a87668",
      "order_ref": "TRY03",
      "offering_type": "appointment",
      "offering_name": "60 Minute Massage",
      "total_cost": 15000,
      "net_total": 12500,
      "date": "2026-06-15",
      "revenues": [
        {
          "revenue_centre": "spa",
          "gross_revenue": 15000,
          "net_revenue": 12500
        }
      ]
    }
  ],
  "links": {
    "first": "http://example.com?page=1",
    "next": "https://example.com?page=3",
    "prev": "https://example.com?page=1",
    "last": "https://example.com?page=4"
  }
}

Changes

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