Sign in
Reports

List order items

Use this endpoint to retrieve a paginated list of individual order items, with optional filters and sorting. The response also includes a CSV variant when requesting with Accept: text/csv.

get/shop/reports/order-items

Query parameters

site_idstring uuid

Restrict the report to order items belonging to the given site. Omit to include items from every site the caller's API key can access; the response groups them under their own site_id field.

pageinteger

The page to retrieve results from

per_pageinteger

The number of results to return per page

order_labelstring[]

A comma-separated list of order labels IDs to filter on.

order_label_idsstring[]

A comma-separated list of order labels IDs to filter on.

sales_channel_idstring[]

A comma-separated list of sales channel IDs to filter on.

sales_channel_idsstring[]

A comma-separated list of sales channel IDs to filter on.

offering_idstring[]

A comma-separated list of offering IDs to filter on.

offering_idsstring[]

A comma-separated list of offering IDs to filter on.

offering_typestring[]

A comma-separated list of item types to filter on.

offering_typesstring[]

A comma-separated list of item types to filter on.

offering_categorystring

Filter by the offering's category.

offering_category_idsstring[]

A comma-separated list of offering category ids to filter on.

statusstring

Filter by the status of the item.

statusesstring[]

A comma-separated list of statuses to filter on.

order_statusstring[]

A comma-separated list of order statuses to filter on.

order_statusesstring[]

A comma-separated list of order statuses to filter on.

revenue_date_fromstring date

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

revenue_date_tostring date

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

date_fromstring date-time

Filter on items with a start time on or after this date.

date_tostring date-time

Filter on items with a start time 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.

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.

category_idstring[]

A comma-separated list of category IDs to filter on.

category_idsstring[]

A comma-separated list of stock category IDs to filter on.

brand_idsstring[]

A comma-separated list of stock brand IDs to filter on.

revenue_centresstring[]

A comma-separated list of revenue centre names to filter on.

sold_by_idstring[]

A comma-separated list of user IDs to filter for items sold by that user.

sold_by_idsstring[]

A comma-separated list of user IDs to filter for items sold by that user.

practitioner_idstring[]

A comma-separated list of practitioner IDs to filter on.

practitioner_idsstring[]

A comma-separated list of practitioner IDs to filter on.

shop_category_idsstring[]

A comma-separated list of shop category ids to filter on (includes offering and voucher categories).

room_idstring[]

A comma-separated list of room IDs to filter on.

room_idsstring[]

A comma-separated list of room IDs to filter on.

zone_idstring[]

A comma-separated list of zone IDs to filter on.

zone_idsstring[]

A comma-separated list of zone IDs to filter on.

sortstring

The field to order results by.

sort_order'asc' | 'desc'

The direction to order results by.

Response

The data 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,
      "revenues": [
        {
          "revenue_centre": "spa",
          "fee_type": "joining_fee",
          "revenue_centre_name": "Spa",
          "amount": 12000,
          "net_amount": 10000
        }
      ]
    }
  ],
  "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": {
    "total_items": 120,
    "total_unique_orders": 45,
    "net_total": 1200000
  }
}

Changes

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