v1

latestOpenAPI 3.0.12026-07-245277551.2 MB
Reservation

getReservations

Returns a list of reservations that matched the filters criteria.<br /> Please note that some reservations modification may not be reflected in this timestamp. ### Group account support

get/getReservations

Query parameters

propertyIDstring

ID for the properties to be queried (comma-separated, i.e. 37,345,89).<br /> It can be omitted if the API key is single-property, or to get results from all properties on an association.

status'not_confirmed' | 'confirmed' | 'canceled' | 'checked_in' | 'checked_out' | 'no_show'

Filter by current reservation status

resultsFromstring date-time

Inferior limit datetime, used to filter reservations, based on booking date

resultsTostring date-time

Superior limit datetime, used to filter reservations, based on booking date

modifiedFromstring date-time

Inferior limit datetime, used to filter reservations, based on booking modification date

modifiedTostring date-time

Superior limit datetime, used to filter reservations, based on booking modification date

checkInFromstring date

Filters reservations result to return only reservations with check-in date range starting on this date

checkInTostring date

Filters reservations result to return only reservations with check-in date range ending on this date

checkOutFromstring date

Filters reservations result to return only reservations with check-out date range starting on this date

checkOutTostring date

Filters reservations result to return only reservations with check-out date range ending on this date

datesQueryMode'booking' | 'rooms'

If we should consider the booking's check-in/check-out dates or the start and end dates for the associated rooms.

roomIDstring

Filters reservation with the supplied room ID. CheckIn/checkOut dates OR status are required. If dates are provided and span more than one day, more than one reservation can be returned. If roomID supplied, roomName is ignored.

roomNamestring

Filters reservation with the supplied room name (customizable by each property). CheckIn/checkOut dates OR status are required. If dates are provided and span more than one day, more than one reservation can be returned.

roomTypeIDstring

Filters reservation with the supplied Room Type ID.

includeGuestsDetailsboolean

If guests details should be included or not

includeGuestRequirementsboolean

Includes guest requirements data in the response. Requires includeGuestsDetails=true.

includeCustomFieldsboolean

If reservation custom fields should be included or not

includeAllRoomsboolean

When specified, the response will include an additional rooms field that combines both unassigned and assigned rooms.

sourceIdstring

Filters reservation with the supplied source ID.

sourceReservationIdstring

Filters reservation with the supplied reservation source ID.

ratePlanIdstring

Filters reservation with the supplied rate plan ID.

firstNamestring

Filters reservation with the supplied primary guest first name.

lastNamestring

Filters reservation with the supplied primary guest last name.

guestIDstring

Filters reservation with the supplied Guest ID (Including additional guests).

allotmentBlockCodestring

Filters reservation with the supplied allotment block code.

groupCodestring

Filters reservation with the supplied group code.

sortByRecentboolean

Sort response results by most recent action

pageNumberinteger

Results page number

pageSizeinteger

Results page size. Max = 100

Response

200 Response

successboolean

Returns if the request could be completed

countinteger

Number of results returned

totalinteger

Total number of results