Sample Flows

This article provides sample flows focusing on the technical details of retrieving availability for appointment-based services and classes. See our complete step-by-step overview of the full booking process, including service selection, availability checks, booking creation, and payment for end-to-end flows.

Book an appointment

You can check availability for appointment-based services to help customers find and book suitable time slots.

To book an appointment:

  1. Call Query Services to identify the business time zone and relevant service ID.
  2. Call List Availability Time Slots specifying serviceId, timeZone, fromLocalDate, and toLocalDate as filters. Save the relevant time slot details.
  3. To obtain the selected slot's full capacity and booking-policy status, call Get Availability Time Slot. Specify the selected slot's localStartDate and localEndDate.
  4. Call Create Booking to complete the booking.

Book a class session

You can check availability for class sessions to help customers find and book available spots.

To book a class session:

  1. Call Query Services to identify the business time zone and relevant service ID.
  2. Call List Event Time Slots specifying serviceId, timeZone, fromLocalDate, toLocalDate, and the number of openSpots the customer intends to book as filters. Save the eventId from the selected time slot.
  3. To obtain the selected slot's full capacity and booking-policy status, call Get Event Time Slot. Specify eventId to get detailed information about the class session.
  4. Call Create Booking to complete the booking.

Check availability for multi-service bookings

You can check availability for multiple services in sequence to help customers book comprehensive service packages.

To check availability for multi-service bookings:

  1. Call Query Services with filter ?type=APPOINTMENT to identify the business time zone and relevant service IDs.
  2. Call List Multi Service Availability Time Slots specifying the sequence of serviceIds, timeZone, fromLocalDate, toLocalDate, and location as filters. Use bookable: true to get only bookable slots and cursorPaging.limit: 100 for pagination.
  3. To obtain the selected multi-service slot's full capacity and booking-policy status, call Get Multi Service Availability Time Slot. Specify the exact localStartDate and localEndDate values from the selected slot.
  4. Call Create Multi Service Booking to complete the booking.
Did this help?