Skip to main content
Documentation

Domain

Booking capabilities

12 capabilities, all acting on a booking. A reference to one from another domain is spelled booking_id — never a bare id — and every one of those fields names the capability that produces it, so a model can chain calls without guessing.
CapabilityWhat it doesEffect
booking.servicesPOST /api/v1/booking/servicesList the services this shop takes online bookings for, with pricesread-only
booking.deposit_policyPOST /api/v1/booking/deposit_policyCheck the price and the deposit a booking would requireread-only
booking.availabilityPOST /api/v1/booking/availabilityList the open appointment times for a booking, day by dayread-only
booking.holdPOST /api/v1/booking/holdReserve a slot for a few minutes before taking the bookingwrites
booking.bookPOST /api/v1/booking/bookTake a booking for a customer at a chosen appointment timewrites · reaches the customer
booking.getPOST /api/v1/booking/getRead one booking back by its manage tokenread-only
booking.reschedulePOST /api/v1/booking/rescheduleMove an existing booking to a different timewrites · reaches the customer
booking.cancelPOST /api/v1/booking/cancelCancel a booking, after the customer verifies with a codewrites · reaches the customer
booking.shop_infoPOST /api/v1/booking/shop_infoRead the opening hours and contact details for a booking callerread-only
booking.addonsPOST /api/v1/booking/addonsList the paid extras sold alongside a booking, with their pricesread-only
booking.locationsPOST /api/v1/booking/locationsList the branches of this business taking booking, and whereread-only
booking.approval_queuePOST /api/v1/booking/approval_queueCount the booking requests waiting for the shop to say yesread-only

← Every domain