---
title: "Item revenues report"
method: GET
path: "/shop/reports/item-revenues"
tags: ["Reports"]
---

# Item revenues report

`GET /shop/reports/item-revenues`

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`](/endpoints/Reports#queueItemRevenuesExport).

## Query parameters

- `site_id` string, uuid, required
- `page` integer
- `revenue_date_from` string, date
- `revenue_date_to` string, date
- `item_date_from` string, date
- `item_date_to` string, date
- `order_submitted_at_from` string, date-time
- `order_submitted_at_to` string, date-time
- `offering_type` string
- `offering_ids` string[]
- `revenue_centres` string[]

## Response `200`

The report was successfully generated.

- ItemRevenuesResponse
  - `data` ItemRevenue[], required
    - `id` string, object-id, required — The ID of the basket item.
    - `basket_id` string, object-id, required
    - `order_ref` string, required
    - `offering_type` string, required
    - `offering_id` string, object-id, required
    - `offering_name` string, required
    - `total_cost` integer, required — The total cost of the item, in minor units.
    - `net_total` integer, required — The net total of the item after tax, in minor units.
    - `gross_revenue` integer, required — The sum of all gross revenue allocations on this item, in minor units.
    - `net_revenue` integer, required — The sum of all net revenue allocations on this item, in minor units.
    - `date` string, required — The earliest date the item takes place on, or an empty string if the item has no date.
    - `revenues` ItemRevenueAllocation[], required — Revenue allocations on this item, grouped by revenue centre.
      - `revenue_centre` string, nullable, required
      - `gross_revenue` integer, required
      - `net_revenue` integer, required
  - `meta` ItemRevenuesMeta, required
    - `revenue_centres` object[], required — Lookup of the revenue centres referenced in `data`.
      - `key` string, required
      - `name` string
  - `links` PaginationLinks, required — Hypermedia navigation links for paging through a list response. Each property is a fully-qualified URL that preserves the original query string (filters, sort, page size) and only swaps the `page` parameter. `next` and `prev` are `null` at the ends of the result set; `first` and `last` are always present.
    - `first` string, required — The url of the first page for the paginated results set
    - `next` string, nullable, required — The url of the next page for the paginated results set
    - `prev` string, nullable, required — The url of the previous page for the paginated results set
    - `last` string, required — The url of the last page for the paginated results set

## Other responses

- `400` — The request failed.

---

[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)