Introduction
The Booking API provides comprehensive endpoints for creating and managing bookings in your reservation system. It supports multiple booking types and workflows for both customers and merchants.Booking Types
The API supports three types of bookings:Appointment
One-on-one bookings between a customer and a service provider
Event
Single-occurrence group bookings for special occasions
Class
Recurring group bookings for scheduled classes or sessions
Booking Statuses
Bookings progress through several statuses during their lifecycle:| Status | Description |
|---|---|
booked | Initial booking created |
confirmed | Booking confirmed by merchant or customer |
completed | Service completed successfully |
cancelled | Booking cancelled by merchant or customer |
no-show | Customer did not show up for the booking |
Booking Workflows
Customer Workflow
Customers can:- Create bookings for appointments or join group bookings (events/classes)
- View their booking details
- Cancel bookings before the cancellation deadline
Merchant Workflow
Merchants have full control over bookings:- Create bookings for any customer
- Update booking times and notes
- Cancel bookings with a reason
- View all bookings in a calendar view
Core Data Model
A booking consists of the following core fields:Unique booking identifier
Current booking status:
booked, confirmed, completed, cancelled, or no-showType of booking:
appointment, event, or classWhether this booking is part of a recurring series
ID of the merchant providing the service
ID of the assigned employee (for appointments)
ID of the service being booked
ID of the location where service is provided
Start date and time of the booking
End date and time of the booking
ID of the recurring booking series (if recurring)
Booking Details
Each booking has associated details for pricing and participants:Price charged per participant
Cost to merchant per participant
Total price for the booking
Total cost for the booking
Minimum number of participants required
Maximum number of participants allowed
Current number of registered participants
Internal notes from the merchant
When the merchant cancelled the booking
Reason provided for cancellation
Recurring Bookings
Recurring bookings (classes) follow the iCalendar recurrence rule (RRULE) format:iCalendar recurrence rule defining the pattern
Start date of the recurring series
Timezone for the recurring series
Whether the recurring series is still active
Next Steps
Create Bookings
Learn how to create appointments and group bookings
Manage Bookings
Update, cancel, and manage existing bookings