check_availability
Check availability. Check what is free for a party on a date, or at a time. Call it before create_booking. Each free time lists the booking types, lengths and any deposit. When the asked time is taken the result offers the nearest times, the next days, and with acrossVenues the key’s other venues. The summary can be read to the guest. outcome needs_venue means the party is too large to book online: offer an enquiry instead.
It only reads data. Calling it again with the same input has no further effect.
Parameters
Section titled “Parameters”| Name | Type | Required | Description |
|---|---|---|---|
date |
string | Yes | Venue-local date as yyyy-MM-dd. |
partySize |
integer | Yes | Number of guests. |
time |
string | No | Venue-local time as HH:mm. Leave it out to list the whole day. |
venueId |
string (uuid) | No | The venue’s id from list_venues. Leave it out when this key is for one venue only. |
bookingTypeId |
string (uuid) | No | Only this booking type (from get_venue). |
acrossVenues |
boolean | No | Also look at this key’s other venues when the asked time is taken. |
REST equivalent
Section titled “REST equivalent”CheckAvailability: POST /public/v1/availability/search, which needs the bookings.create capability.