Sign in
Availability

List availability by day for an offering

Returns one OfferingDateAvailability per day in the date_from..date_to range, indicating whether the offering has any bookable slots on that day plus the cheapest slot price. Use this to drive a calendar UI that greys-out unbookable days without firing a slot-level query per day.

The maximum supported range is 31 days. Larger ranges return 400 Bad Request.

Supports appointment, session, package, and area_booking offering types.

get/shop/item-availability/offering-dates

Query parameters

date_fromstring date required

First date in the requested window (inclusive), ISO-8601 YYYY-MM-DD in the offering's site timezone.

date_tostring date required

Last date in the requested window (inclusive). For most offerings the range may not exceed 31 days.

offering_idstring required
Example:5dcb47800000000000000010

The offering whose date-by-date availability should be returned. Must be paired with offering_type so the platform knows which catalogue to look the ID up in (appointments, sessions or packages). Returns 422 if the ID does not resolve to a live offering of the supplied type.

offering_type'appointment' | 'session' | 'package' | 'area_booking' required

The kind of offering offering_id refers to.

quantityinteger

Number of guests/instances the slot must accommodate. Defaults to 1.

partner_idstring

Restrict the check to the given partner's allotment. Pass the partner's partner_id (e.g. ota).

Response

Per-day availability for an offering across the requested date range. Each entry is one calendar day.

metaobject

Booking-window metadata derived from the offering — min_advance_bookings_interval, max_advance_bookings_interval, currency, and practitioner roster for appointment types.

Changes

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