---
title: "List tip items"
method: GET
path: "/shop/reports/tips"
tags: ["Reports"]
---

# List tip items

`GET /shop/reports/tips`

Use this endpoint to retrieve a paginated list of items that have tip amounts associated with them.

## Query parameters

- `site_id` string, uuid
- `page` integer
- `revenue_date_from` string, date
- `revenue_date_to` string, date
- `submitted_at_from` string, date
- `submitted_at_to` string, date

## Response `200`

The list of items was successfully retrieved

- ListTipItemsResponse
  - `data` TipItem[], required
    - `id` string, object-id, required — The ID of the item.
    - `basket_id` string, object-id, required — The ID of the basket this item belongs to.
    - `order_ref` string, required — The order ref of the basket this item belongs to.
    - `order_status` string, required — The status of the basket this item belongs to.
    - `order_date` string, date-time, nullable — The date and time the order was submitted.
    - `revenue_date` string, date, nullable — The revenue date of the basket this item belongs to.
    - `total_cost` integer, nullable — The total cost of the item, in minor units. Null for package items.
    - `net_total` integer, nullable — The net total of the item, in minor units. Null for package items.
    - `tip_amount` integer, nullable — The tip amount for this item, in minor units. Null for package items.
    - `gross_tip_amount` integer, nullable — The gross tip amount for this item, in minor units, before any deductions. Null for package items.
    - `tip_breakdown` TipBreakdownItem[] — Detailed breakdown of the tip allocation.
      - `tip_item_id` string, uuid, required — The unique identifier for the tip item.
      - `basket_item_id` string, object-id, required — The basket item ID to which the tip is applied.
      - `amount` integer, required — The amount of tip, in minor units.
      - `gross_amount` integer, required — The gross tip amount, in minor units, before any deductions.
      - `allocation_method` string, required — The method used to allocate the tip (e.g., direct allocation, package ratio).
      - `offering_name` string, required — The name of the offering associated with the basket item.
    - `practitioners` SchemasPractitionerSummary[]
      - `id` string, mongo-id, required — The ID of the practitioner.
      - `name` string, required — The name of the practitioner.
    - `payment_methods` string
  - `meta` PaginationMeta, required — Counts and positional information for the current page of a list response. Use `current_page` and `last_page` to drive pagination UI, `total` for result counts, and `per_page` to confirm the page size the server actually applied (which may differ from the requested value when capped).
    - `from` integer, required — The item number from which this results set starts from
    - `to` integer, required — The item number from which this results set ends at
    - `total` integer, required — The total number of results
    - `current_page` integer, required — The current page number
    - `last_page` integer, required — The page number of the last result set
    - `per_page` integer, required — The number of results per page
    - `path` string, required — The path of this api request
  - `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
  - `totals` TipItemTotals, required
    - `total_tip_items` integer — The total number of orders with tips.
    - `total_unique_orders` integer — The total count of orders for the given filters.
    - `tip_total` integer — The total of all tip amounts for the matching items.
    - `gross_tip_amount` integer — The total of all gross tip amounts for the matching items, before any deductions.

## Other responses

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