Sign in
Reports

List service charge items

Use this endpoint to retrieve a paginated list of basket items with their service charge amounts.

get/shop/reports/service-charge-items

Query parameters

site_idstring uuid

Filter the list of items by site.

pageinteger

The page to retrieve results from

offering_typestring[]

Filter by the offering type.

offering_idstring[]

Filter by the offering ID.

offering_categorystring

Filter by the offering's category.

sold_by_idstring[]

Filter by the ID of the user who sold the item.

order_statusstring

Filter by the status of the order.

statusstring

Filter by the status of the item.

date_fromstring date

Restrict results to those on or after this date, ISO-8601 YYYY-MM-DD.

date_tostring date

Restrict results to those on or before this date, ISO-8601 YYYY-MM-DD.

revenue_date_fromstring date

Filter to items with an order revenue date on or after this date.

revenue_date_tostring date

Filter to items with an order revenue date on or before this date.

order_submitted_at_fromstring date-time

Filter on orders with a submitted date on or after this time.

order_submitted_at_tostring date-time

Filter on orders with a submitted date before this time.

order_labelstring[]

Filter to items in orders with these labels.

item_date_fromstring date

Filter on items which are booked in for on or after this date.

item_date_tostring date

Filter on items which are booked in for before this date.

practitioner_idstring[]

Filter to items assigned to these practitioners.

room_idstring[]

Filter to items assigned to these rooms.

zone_idstring[]

Filter to items assigned to resources in these zones.

Response

The list of items was successfully retrieved

Example response

{
  "data": [
    {
      "order_ref": "TRY03",
      "order_status": "settled",
      "quantity": 1,
      "offering_type": "appointment",
      "offering_name": "60 Minute Massage",
      "total_cost": 15000,
      "net_total": 12000,
      "service_charge": 1000,
      "practitioner": {
        "id": "5dcb47800000000000000000",
        "name": "Jane Doe"
      },
      "sales_channel": "Website",
      "payment_methods": "Card, Cash"
    }
  ],
  "meta": {
    "from": 1,
    "to": 2,
    "total": 2,
    "current_page": 1,
    "last_page": 2,
    "per_page": 15,
    "path": "http://example.com/api"
  },
  "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"
  },
  "totals": {
    "service_charge_total": 760,
    "total_unique_orders": 2,
    "total_items": 5
  }
}

Changes

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