Transfers

Booking Reservation

Create transfer booking

post

This endpoint creates a new transfer booking. Note All newly created bookings have a default status of ON_HOLD.

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

The transferId id for this booking.

Example: 66fea92a0d31eeda7cff116a
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: 08167870-f83f-430e-90e1-2623ae6fbc36
uuidany | nullableOptional

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

Responses
200

Object of booking

application/json
post
/bookings (Transfers)
JS
200

Object of booking

Booking Confirmation

Booking Transfers 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 (Transfers)
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 (Transfers)
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
sortstring · enumOptional

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: PRICEPossible values:
orderstring · enumOptional

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: DESCENDINGPossible values:
typestring · enumOptional

Determines the type of bookings.

Example: TRANSFERPossible values:
Header parameters
octo-capabilitiesstringOptional

Comma-separated list of capabilities supported by the client. Possible values are: - octo/pricing

Example: octo/pricing
Responses
200

An object

application/json
get
/bookings (Transfers)
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 bookingTransfer

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

Object of bookingTransfer

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
transferIdstringRequired

The transferId id for this booking.

Example: 66fea92a0d31eeda7cff116a
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: 08167870-f83f-430e-90e1-2623ae6fbc36
resellerReferencestringRequired

Your reference for this booking.

Example: asda343
Responses
200

Object of booking

application/json
patch
/bookings/{id} (Transfers)
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 (Transfers)
JS
200

Object of booking

Last updated