Products (In Progress)
2-step booking process through: reserving availability and making the booking.
When making a reservation for availability this is performed in 2 steps:
Check Availability: Check for availability using the POST /availability endpoint to retrieve the
availabilityId.Booking Reservation: Create the booking which reserves that availability. The booking will keep the status
ON_HOLDuntil the booking is confirmed or the reservationexpirationMinutesexpires. A reservation can be extended by calling the POST /bookings/:uuid/extend endpoint.
We have described the possible Booking calls here:
Booking Endpoints
Reserve - stage 1 reserves the availability by providing the
availabilityId. The Availability ID comes from checking inventory.Confirm - stage 2 finalizes the booking.
Cancel (Optional) - allows cancelling a confirmed booking.
Update (Optional) - allows updating of an existing booking.
Extend (Optional) - allows extending the
expirationMinutesor hold time.
Access to Existing Bookings
Get Booking - this end point will retrieve a single valid booking associated with your reseller account.
Get Bookings - this end point will retrieve a list of bookings associated with your reseller account.
This endpoint creates a new booking. Before creating the booking, it checks the availability of the requested service. - Note All newly created bookings have a default status of ON_HOLD.
The availability id for this booking.
{{AVAILABILITY_ID}}This attribute extends the ON_HOLD status of the reserve and its value is represented in minutes (Min 20 - Max 200).
200Optional notes for the booking.
My notesThe option id for this booking.
DEFAULTThe product id for this booking.
{"[object Object]":null}A UUID used as an idempotency key when creating the booking.
Object of booking
Object of booking
Booking Confirmation
This endpoint confirms the booking so it's ready to be used.
The booking id.
Whether you want RhonTrip Cloud to email the guest a copy of their receipt. (defaults to false)
john@email.comYour reference for this booking. Also known as a Voucher Number.
u7ut5rrObject of booking
Object of booking
Booking Cancellation
For cancelling bookings. - Note You can only cancel a booking if booking.cancellable is TRUE, and is within the booking cancellation cut-off window.
The booking id.
A text value explaining the reason for the cancellation.
Lorem ipsum dolor sit ametObject of booking
Object of booking
Get Bookings
Get full booking details for all bookings
Specifies the page number of the results to retrieve. This parameter is used to paginate the query results, allowing users to navigate between different pages of data.
1Specifies the maximum number of results to retrieve per page. This parameter controls how many items will be returned on each page of the response.
100Defines the field by which to sort the results. This parameter allows users to specify which property of the data will be used to order the list of results.
PRICEDetermines the order in which results are returned. Allowed values are 'Descending' for sorting results in descending order (from highest to lowest), and 'Ascending' for sorting results in ascending order (from lowest to highest).
DESCENDINGDetermines the type of bookings.
ProductAn object
An object
Get Booking
Booking Update
Updates a booking before and after it has been confirmed as long as it hasn''t been redeemed or within the cancellation cutoff window. To know if the booking can be updated check the booking''s cancellable field. If the booking can be cancelled, it can also be updated. It''s generally preferred to update a booking rather than cancelling it and rebooking.
The booking id.
The availability id for this booking.
2024-09-30T14:00:00+00:00Whether you want RhonTrip Cloud to email the guest a copy of their receipt. (defaults to false)
user@email.comThis attribute extends the ON_HOLD status of the reserve and its value is represented in minutes (Min 20 - Max 200).
344The option id for this booking.
DEFAULTThe product id for this booking.
66d9cda3026dcae628481e4bYour reference for this booking.
asda343Object of booking
Object of booking
Extend Reservation
Use this endpoint to hold the availability for a booking longer if the status is ON_HOLD.
The booking id.
This attribute extends the ON_HOLD status of the reserve and its value is represented in minutes (Min 20 - Max 200).
200Object of booking
Object of booking
Last updated