---
title: "List order revenues"
method: GET
path: "/shop/reports/order-revenues"
tags: ["Reports"]
---

# List order revenues

`GET /shop/reports/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`.

## Query parameters

- `site_id` string, uuid, required
- `revenue_date_from` string, date, required
- `revenue_date_to` string, date, required

## Response `200`

The order revenues were successfully retrieved.

- OrderRevenuesReportResponse
  - `data` OrderRevenueReportItem[], required
    - `fiscal_receipt_id` string, nullable, required — The fiscal receipt ID for the order, if it has been fiscalised.
    - `order_ref` string, required — The order reference.
    - `revenue_date` string, date, nullable, required — The revenue date of the order.
    - `settled_at` string, date-time, nullable, required — The date and time the order was settled.
    - `status` string, required — The status of the order.
    - `gross_amount` integer, required — The gross revenue amount for the order, across all final revenue lines, in minor units.
    - `net_amount` integer, required — The net revenue amount for the order, across all final revenue lines, in minor units.
    - `vat` integer, required — The VAT amount for the order, calculated as the gross amount minus the net amount, in minor units.
    - `currency` string, required — The ISO currency code for the order's amounts.
    - `payment_methods` string[], required — The unique payment processors used to pay for the order.
    - `card_brands` string[], required — The unique card brands used to pay for the order.
    - `revenue_centres` object, required — A breakdown of revenue for the order by revenue centre, keyed by revenue centre code. Only revenue centres with a final revenue line for this order are included.
  - `meta` OrderRevenuesReportMeta, required
    - `revenue_centres` RevenueCentreSummary[], required — The site's configured revenue centres combined with any revenue centres present in the results. Revenue centres that appear in the results but are no longer configured on the site have a `null` name.
      - `key` string, required — The ID of the revenue centre.
      - `name` string, required — The name of the revenue centre.

## Other responses

- `400` — The request failed.
- `401` — The user is unauthenticated

---

[API](https://skmtc.dev/try/apis/trybe-api.md) · [All operations](https://skmtc.dev/try/apis/trybe-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/try/trybe-api/revisions/f37f92702da5/schema)