Book services using APIs
The service booking workflow lets you create appointments, reserve time slots, confirm bookings, and collect payment through the Zenoti API. This four-step process mirrors the booking flow in Zenoti Web and can be used to build custom booking interfaces for your Webstore, mobile app, or third-party integration.
For complete endpoint documentation including request/response schemas and code examples, see the individual API reference articles linked below.
On this page
- Before you begin
- Steps
- Step 1: Create a booking
- Step 2: Reserve a slot
- Step 3: Confirm the booking
- Step 4: Collect payment
- Tips
- Related articles
Before you begin
- You need a valid API key or access token. See Set up API authentication.
- Services must be configured for the center. This requires an Administrator or Owner role.
- Employee schedules must be set up with at least one available employee.
- Center operating hours must be configured.
- Blockout times must be established for employees and rooms.
- A payment processor must be enabled for the center.
Permission: Manage API Keys (under Administrator) -- Required to access Zenoti APIs.
Steps
Step 1: Create a booking
Before creating a booking, gather the required information using these APIs:
Look up the guest. Use the Search for a Guest API to find the guest by name, email, phone, or other criteria. If the guest does not exist, use the Create a Guest API to create a new guest record.
Select a service. Use the List All Services of a Center API to retrieve the available services for the center. Select the service the guest wants to book.
Assign a therapist (optional). Use the List All Therapists of a Center API to retrieve available therapists. Assign a preferred therapist, or let Zenoti auto-assign one.
Select a room (optional). Use the List All Rooms of a Center API to retrieve available rooms. Rooms must have a service-level association to be eligible for the selected service.
Create the booking. Use the Create a Service Booking API with the guest, service, therapist, and room details.
After creating the booking, you can use the Reschedule Booking API or Cancel Booking API if needed.
Note: External bookings can be tagged with a source (External-Webstore, External-CMA, or Bot). See Configure custom API sources.
Step 2: Reserve a slot
Get available slots. Use the Retrieve Available Slots for a Service Booking API to get the list of available time slots. Slot duration is customizable (for example, 5-minute or 15-minute intervals).
Reserve a slot. Use the Reserve a Slot for a Service Booking API to lock in the selected time slot. This prevents other bookings from taking the same slot.
Step 3: Confirm the booking
Confirm the booking. Use the Confirm a Service Booking API to finalize the appointment. The response includes invoice details.
Check in the guest (when they arrive). Use the Check-in API to mark the guest as arrived. This triggers an appointment check-in notification to the provider (if configured).
Undo check-in (if needed). Use the Undo Check-in API if the guest was checked in by mistake.
Step 4: Collect payment
After the service is complete, collect payment for the invoice:
Verify invoice details. Use the Retrieve Invoice Details API to confirm the invoice amount and line items.
Retrieve saved cards. Use the Retrieve Saved Cards API to check if the guest has a card on file.
Collect payment. Use one of the following approaches:
- Saved card -- Use the Add Credit/Debit Card for Guest API with the saved card details.
- New card -- Process a new card payment through the API.
- Custom payment -- Use the Insert Custom Payments API for third-party payment processors.
- Cash -- Record a cash payment through the API.
Verify completion. Use the Retrieve Invoice Details API to confirm the invoice is closed.
Mandatory card on file. If your organization requires a card on file, ensure the guest has a saved card before completing checkout.
Tips
- Use the Retrieve a Booking API to check the current state of a booking at any point in the workflow.
- Implement error handling for each step. If slot reservation fails, retrieve available slots again, as the selected slot may have been taken.
- For high-traffic booking scenarios, reserve the slot immediately after selection to minimize the chance of conflicts.
- After checkout, you can use the Undo Complete API if you need to reverse a completed appointment.