Reports

List order revenues

Use this endpoint to retrieve one row per order, with gross, net and VAT revenue totals and a breakdown of final revenue by revenue centre. Only submitted and settled orders are included. The response also includes a CSV variant when requesting with Accept: text/csv.

get/shop/reports/order-revenues

Query parameters

site_idstring uuid required

Restrict the report to orders belonging to the given site.

revenue_date_fromstring date required

Filter to orders with revenues on or after this date.

revenue_date_tostring date required

Filter to orders with revenues on or before this date.

Response

The order revenues were successfully retrieved.

Example response

{
  "data": [
    {
      "order_ref": "TRY03",
      "status": "settled",
      "currency": "GBP",
      "payment_methods": [
        "adyen"
      ],
      "card_brands": [
        "visa"
      ]
    }
  ],
  "meta": {
    "revenue_centres": [
      {
        "name": "Website"
      }
    ]
  }
}

Changes

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