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:

  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 reservation expirationMinutes 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.

    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. Get Bookings - this end point will retrieve a list of bookings associated with your reseller account.

Create booking

post

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.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
availabilityIdstringRequired

The availability id for this booking.

Example: {{AVAILABILITY_ID}}
expirationMinutesnumberRequired

This attribute extends the ON_HOLD status of the reserve and its value is represented in minutes (Min 20 - Max 200).

Example: 200
notesstringOptional

Optional notes for the booking.

Example: My notes
optionIdstringRequired

The option id for this booking.

Example: DEFAULT
productIdstringRequired

The product id for this booking.

Example: {"[object Object]":null}
uuidany | nullableOptional

A UUID used as an idempotency key when creating the booking.

Responses
200

Object of booking

application/json
post
/bookings (Products)
JS
200

Object of booking

Booking Confirmation

Booking Confirmation

post

This endpoint confirms the booking so it's ready to be used.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired

The booking id.

Body
emailReceiptstringRequired

Whether you want RhonTrip Cloud to email the guest a copy of their receipt. (defaults to false)

Example: john@email.com
resellerReferencestringRequired

Your reference for this booking. Also known as a Voucher Number.

Example: u7ut5rr
Responses
200

Object of booking

application/json
post
/bookings/{id}/confirm (Products)
JS
200

Object of booking

Booking Cancellation

Booking Cancellation

post

For cancelling bookings. - Note You can only cancel a booking if booking.cancellable is TRUE, and is within the booking cancellation cut-off window.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired

The booking id.

Body
reasonstringOptional

A text value explaining the reason for the cancellation.

Example: Lorem ipsum dolor sit amet
Responses
200

Object of booking

application/json
post
/bookings/{id}/cancel (Products)
JS
200

Object of booking

Get Bookings

Get Bookings

get

Get full booking details for all bookings

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
pagenumberOptional

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.

Example: 1
limitnumberOptional

Specifies the maximum number of results to retrieve per page. This parameter controls how many items will be returned on each page of the response.

Example: 100
sortstringOptional

Defines 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.

Example: PRICE
orderstringOptional

Determines 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).

Example: DESCENDING
typestringOptional

Determines the type of bookings.

Example: Product
Responses
200

An object

application/json
get
/bookings (Products)
JS
200

An object

Get Booking

Get Booking

get

Get the details of an existing booking.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired

The booking id.

Responses
200

Object of booking

application/json
get
/bookings/{id} (Products)
JS
200

Object of booking

Booking Update

Booking Update

patch

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.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired

The booking id.

Body
availabilityIdstringRequired

The availability id for this booking.

Example: 2024-09-30T14:00:00+00:00
emailReceiptstringOptional

Whether you want RhonTrip Cloud to email the guest a copy of their receipt. (defaults to false)

Example: user@email.com
expirationMinutesnumberOptional

This attribute extends the ON_HOLD status of the reserve and its value is represented in minutes (Min 20 - Max 200).

Example: 344
optionIdstringRequired

The option id for this booking.

Example: DEFAULT
productIdstringRequired

The product id for this booking.

Example: 66d9cda3026dcae628481e4b
resellerReferencestringRequired

Your reference for this booking.

Example: asda343
Responses
200

Object of booking

application/json
patch
/bookings/{id} (Products)
JS
200

Object of booking

Extend Reservation

Extend Reservation

post

Use this endpoint to hold the availability for a booking longer if the status is ON_HOLD.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired

The booking id.

Body
expirationMinutesnumberRequired

This attribute extends the ON_HOLD status of the reserve and its value is represented in minutes (Min 20 - Max 200).

Example: 200
Responses
200

Object of booking

application/json
post
/bookings/{id}/extend (Products)
JS
200

Object of booking

Last updated