Booking
2-stepbooking process through: reserving availability and making the booking.
When making a reservation for availability this is performed in 2 steps:
- 1.Check Availability: Check for availability using the POST /availability endpoint to retrieve the
availabilityId
. - 2.Booking Reservation: Create the booking which reserves that availability. The booking will keep the status
ON_HOLD
until the booking is confirmed or the reservationexpirationMinutes
expires. A reservation can be extended by calling the POST /bookings/:uuid/extend endpoint.
We have described the possible Booking calls here:
- 1.Booking Endpoints
- 1.Reserve - stage 1 reserves the availability by providing the
availabilityId
. The Availability ID comes from checking inventory. - 2.Confirm - stage 2 finalizes the booking. You will store the
supplierReferenceNumber
. - 3.Cancel (Optional) - allows cancelling a confirmed booking.
- 4.Update (Optional) - allows updating of an existing booking.
- 5.Extend (Optional) - allows extending the
expirationMinutes
or hold time.
- 2.Access to Existing Bookings
- 1.Get Booking - this end point will retrieve a single valid booking associated with your reseller account
- 2.List Bookings - this end point will retrieve a list of bookings associated with your reseller account
post
https://api.zaui.io/octo
/suppliers/:sid/bookings
Bookings - Reserve
{
"productId": 121,
"optionId": "328d132f3cf710bbe34cd48be09e439b2948f43d",
"availabilityId": "2021-07-05T10:00:00-07:00",
"expirationMinutes": 10,
"notes": "Optional notes that can be passed to the supplier system",
"unitItems": [
{ "unitId": "adults" },
{ "unitId": "children" }
]
}
post
https://api.zaui.io/octo
/suppliers/{sid}/bookings/{id}/confirm
Bookings - Confirm
{
"resellerReference": "VOUCHER-0123",
"contact": {
"fullName": "Muddy Waters",
"emailAddress": "[email protected]",
"phoneNumber": "+1604-566-9284",
"locales": ["en-GB", "en-US", "en"],
"country": "CA"
}
}
delete
https://api.zaui.io/octo
/suppliers/{sid}/bookings/{uuid}/cancel
Bookings - Cancel
{
"reason": "CUSTOMER_REQUESTED",
"reasonDetails": "Child came down with the flu the day before the activity."
}
post
https://api.zaui.io/octo
/suppliers/{sid}/bookings/{uuid}/extend
Bookings - Extend Reservation
patch
https://api.zaui.io/octo
/suppliers/{sid}/bookings/{uuid}
Booking - Update
get
https://api.zaui.io/octo
/suppliers/{sid}/bookings/{uuid}/
Get Booking
get
https://api.zaui.io/octo
/suppliers/{sid}/bookings/
List Bookings
When using this endpoint you must include one of the following parameters:
resellerReference
- The reference number from your platformsupplierReference
- The booking reference number from the supplierlocalDate
- Local travel datelocalDateStart
andlocalDateEnd
- local travel start/end dates
Additional optional parameters for further filtering include:
productId
- a single product ID bookedoptionId
- a single optionId as part of the booking