Sign in
Reports

List tip items

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

get/shop/reports/tips

Query parameters

site_idstring uuid

Filter the list of baskets by site.

pageinteger

The page to retrieve results from

revenue_date_fromstring date

Filter to baskets with a revenue date on or after this date.

revenue_date_tostring date

Filter to baskets with a revenue date on or before this date.

submitted_at_fromstring date

Filter to baskets submitted on or after this date.

submitted_at_tostring date

Filter to baskets submitted on or before this date.

Response

The list of items was successfully retrieved

Example response

{
  "data": [
    {
      "order_ref": "TRY03",
      "order_status": "settled",
      "total_cost": 15000,
      "net_total": 12000,
      "tip_amount": 2500,
      "gross_tip_amount": 3000,
      "tip_breakdown": [
        {
          "tip_item_id": "a0f41964-78e1-474c-9fff-44ebaad9a6d1",
          "basket_item_id": "697b8493694753489003695e",
          "amount": 1389,
          "gross_amount": 1667,
          "allocation_method": "direct allocation (package ratio 16.67%)",
          "offering_name": "Consultation with Dr. Smith"
        }
      ],
      "practitioners": [
        {
          "name": "Jasmine"
        }
      ],
      "payment_methods": "Manual (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": {
    "total_tip_items": 2500,
    "total_unique_orders": 10,
    "tip_total": 5,
    "gross_tip_amount": 6000
  }
}

Changes

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