Offerings

List the most popular offerings

Returns the offerings most often sold over the trailing four weeks, capped by per_page and ordered by sales count descending. Useful for "Popular at this site" sections on the storefront and operator quick-pick lists.

Filters mirror the main offering search:

  • offering_type accepts a comma-separated list; prefix a type with - to exclude it (e.g. appointment,-package).
  • practitioner_id narrows appointment results to those tied to the given practitioners.

Requires the RESERVATIONS_VIEW permission on the targeted site.

get/shop/offering-search/most-popular

Query parameters

offering_typeOfferingType[]

Filter by specific offering types.

[
  "appointment"
]
practitioner_idstring[]

Filter by specific practitioner IDs.

site_idstring uuid required

The site ID the offerings belong to.

per_pageinteger

The number of results to return per page

Response

The most popular offerings.

Example response

{
  "data": [
    {
      "offering_type": "appointment"
    }
  ]
}

Changes

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