Sign in

v1

latestOpenAPI 3.0.32026-07-23183961.3 KB

Returns information regarding a specific reservation based on the provided booking reference ID. Only confirmed and cancelled reservations will return results. Reservations in pending status will return 404.

get/reservations/{bookingReferenceId}

Path parameters

bookingReferenceIdstring required

The unique identifier of the reservation. Only one booking reference ID can be passed per request.

Headers

x-sm-api-idstring required

The api id for channel

x-sm-api-keystring required

The api key for channel

Response

Successful response

bookingReferenceIdstring required

Unique identifier for the booking.

propertyUuidstring required

The unique identifier of the property for which the reservation is made.

propertyNamestring required

The name of the property.

bookedOnDatestring date required

The date the reservation was made.

checkInDatestring date required

The check-in date for the reservation.

checkOutDatestring date required

The check-out date for the reservation.

currencyCodestring required

The booking currency of the reservation.

paymentTotalnumber required

The total amount for the reservation, in the booking currency.

totalTaxesnumber required

The total amount of taxes applied to the reservation, in the booking currency.

totalFeesnumber required

The total amount of fees applied to the reservation, in the booking currency.

status'Confirmed' | 'Cancelled' required

The status of the reservation.

channelCommissionPercentagenumber required

The channel commission amount for the reservation, in the booking currency.

channelCommissionAmountnumber required

The channel commission amount in the reservation currency.

siteminderCommissionAmountnumber required

The SiteMinder commission amount for the reservation, in the booking currency.

nonRefundableDateTimestring date-time nullable required

The datetime when the reservation becomes non-refundable, in the property's timezone.