Sign in

v1

latestOpenAPI 3.0.32026-07-23183961.3 KB

Retrieve a list of reservations filtered by date type and a date range via fromDate & toDate. Max duration is 31 days. Only confirmed and cancelled reservations are returned.

get/reservations

Query parameters

dateType'checkIn' | 'checkOut' | 'bookedOn' required

The type of date to filter reservations by. - checkIn: Filter by the guest's check-in date (arrival date) - checkOut: Filter by the guest's check-out date (departure date) - bookedOn: Filter by the date the reservation was created/booked

fromDatestring date required

The start date of the date range (inclusive). Cannot be more than 365 days in the past.

toDatestring date required

The end date of the date range (inclusive).

pageinteger

The page number of the results to fetch.

perPageinteger

The number of results per page.

Headers

x-sm-api-idstring required

The api id for channel

x-sm-api-keystring required

The api key for channel

Response

Successful response. Returns a list of reservations.

bookingReferenceIdstring required

Unique identifier for the booking.

propertyUuidstring required

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

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 currency of the reservation amount.

paymentTotalnumber required

The total reservation amount in the reservation currency.

status'Confirmed' | 'Cancelled' required

The status of the reservation.

channelCommissionAmountnumber required

The channel commission amount in the reservation currency.