Appointment Bookings - API Reference

Appointment Bookings

Bookings are for appointments, seats, hire items, etc. Not for events.

End Point URL

https://api.cms-tool.net/webapps/api/booking

API Parameters and Filters

GET Parameters

Name	Description	Example	Data Type
id	If ID is specified, then only a single element is returned if found. Otherwise, an array is returned, even if only one item matches.	id=12345	int
pid	Product Id	pid=12345	int
resourceid	Resource Id, You can get the full information regarding resources using the /bookingresource endpoint	resourceid=123	int
includePastBookings	To include bookings which have occured before the present day.	includePastBookings=1	string
bookingStartAfter	Get bookings which start after time provided	bookingStartAfter ="2021-01-22 10:30:00"	string
bookingStartBefore	Get bookings which start before time provided	bookingStartBefore ="2021-01-22 10:30:00"	string
bookingFinishAfter	Get bookings which end after the time provided	bookingFinishAfter ="2021-02-22 16:00:00"	string
bookingFinishBefore	Get bookings which end before the time provided	bookingFinishBefore ="2021-02-22 16:00:00"	string

Data Dictionary

Key	Definition	Type	Format
b_id	Order ID Reference to basket/order ID	int
bi_id	Order Item Line ID Reference to basket/order item line ID	int
booking_detail	Details Details of the boooking, eg what the booking is for	text
booking_finish	Finish Timestamp Booking Finish, and/or end of repetition	timestamp	e.g. 2025-12-31 23:59:59
booking_freq	Repeat Frequency If a repeat frequence is used, then this bookin represents a series of bookings, eg booking_start + booking_freq	interval	e.g. 01:00:00
bookingid	ID Unique booking for this ID (Serial)	Integer (Unique ID)	e.g. 123456
booking_lastmodified	Last Modified Considered when syncing between calendar platforms	timestamp	e.g. 2025-12-31 23:59:59
booking_reminder_sent	Reminder Sent Last reminder Sent (via email)	timestamp	e.g. 2025-12-31 23:59:59
booking_status	Status Status of the booking.	text
booking_synced_down	Synced down Timestamp to confirm if/when this booking was synced down from a third party calendar (eg imported from google calendar)	timestamp	e.g. 2025-12-31 23:59:59
booking_synced_up	Synced up Timestamp to confirm if/when this booking was synced up from a third party calendar (eg exported to google calendar)	timestamp	e.g. 2025-12-31 23:59:59
booking_time	Booking Start Timestamp Booking start time including date	timestamp	e.g. 2025-12-31 23:59:59
bookingtype	bookingtype Type of booking.	text
caldav_event_id	caldav event id If entry has been synced with a calendar, this this is the GUID for that calendar item	text
cid	Website ID ID of the website	int	e.g. 123456
debugdata	Debug Data for internal purposes and debugging	text
duration	Duration The duration of the booking. Some bookings have a frequence, which means that the duration is not the start - finish time	interval	e.g. 01:00:00
mbr_id	Member ID Customer ID of the person who made the booking, or whome the booking is for	int
page	Page ID Page on which this order was placed, eg the shopping page or the bookings page	int	e.g. 123456
pid	Product ID Only if this booking is for a specific product	int
resourceid	Resouce ID ID of the resource for this calendar event belongs. Every booking needs to be for a specific resource	int

Usage Instructions and Examples

Accepted date format is yyy-MM-dd HH:mm:ss. If the time is not provided, then it will default to midnight time.

Adding a new booking:

Bookings must have a resource_id, booking_time, booking_finish, and duration.

Sample Object


{"duration":"01:00:00",
"resourceid":12345,
"booking_finish":"2022-01-19 20:34:00.0",
"booking_time":"2022-01-19 19:34:00.0"
}