Add a guest or group of guests to the Queue

Purpose: The purpose of this API is to add a guest or a group of guests to the queue for a given center.

Response Object

NameTypeDescription
is_confirmedboolIndicates that the appointment is confirmed. True: Guest is added to the queue and the appointment for the guest is confirmed.
invoice_idguidUnique identifier of the invoice.
appointment_group_idguidUnique identifier of the appointment group.
bookingsobjectObject containing the information about the guest or group of guests added to the queue, appointment wait time, and service information.

bookings Object

NameTypeDescription
idguidUnique identifier of the guest.
first_namestringFirst name of the guest who is added to the queue.
last_namestringLast name of the guest who is added to the queue.
wait_time_in_minstringIndicates the wait time for the guest to receive the service after being added to the queue.
appointmentsobjectObject containing the appointment details, therapist details, and the service details.

appointments Object

NameTypeDescription
idguidUnique identifier of the appointment.
invoice_item_idguidUnique identifier of the item added to an invoice.
start_time_in_centerdate & timeAppointment start date and time in the center.
end_time_in_centerdate & timeAppointment end date and time in the center.
employeeobjectObject containing the therapist or stylist details who is providing the service to the guest.
servicesobjectObject containing the services information.

employee Object

NameTypeDescription
idguidUnique identifier of the employee who is providing the service to the guest.
display_namestringName of the employee that is shown on the queue.
genderstringGender of the employee (stylist/therapist) M: Male, F: Female.
nick_namestringNick name of the employee as per the employee profile in Zenoti.
full_namestringFull name of the employee as per the employee profile in Zenoti.
first_namestringFirst name of the employee as per the employee profile in Zenoti.
last_namestringLast name of the employee as per the employee profile in Zenoti.

service Object

NameTypeDescription
idguidUnique identifier of the service.
namestringName of the service.
durationintDuration of the service performed on the guest.
category_idguidUnique identifier of the service category.
is_addOnboolIndicates if the service is an add-on. True: The service is an add-on. False: The service is not an add-on.
has_addOnsboolIndicates if the service has any add-ons. True: The service has add-ons associated with it. False: The service does not have any associated add-ons.

error Object

MessageCodeDescription
Guest doesn't existAA018When the guest_id is not mentioned in the body of the request.
Slot is not available for reservationQA010When there are no slots available for the requested time, service, stylist, and center.
Language
Credentials
Header
Click Try It! to start a request and see the response here!