v1

latestOpenAPI 3.0.12026-07-245277551.2 MB
Reservation

getReservationsWithRateDetails

Returns a list of reservations with added information regarding booked rates and sources.<br /> Please note that some reservations modification may not be reflected in this timestamp.

get/getReservationsWithRateDetails

Query parameters

propertyIDstring

Property ID

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. If it is not set, will return the reservations up to current date

modifiedFromstring date-time

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

modifiedTostring date-time

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

sortByRecentboolean

Sort response results by most recent action

reservationIDstring

Reservation identifiers, comma-separated, i.e. 37,345,89, used to return transactions limited to the selected reservations.

reservationCheckOutFromstring date

Superior limit datetime, used to filter reservations, based on reservation check-out date.

reservationCheckOutTostring date

Superior limit datetime, used to filter reservations, based on reservation check-out date.

includeDeletedboolean

Include deleted reservations

excludeStatusesstring

List of statuses (separated by comma) to be excluded from search

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

guestIDstring

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

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