Sign in

v3

latestOpenAPI 3.0.42026-07-312008682.1 MB
Reservations

Get all reservations (ver 2017-04-12)

Use Get all reservations (ver 2023-06-06).

post/api/connector/v1/reservations/getAll

Request body

ClientTokenstring required

Token identifying the client application.

AccessTokenstring required

Access token of the client application.

Clientstring required

Name and version of the client application.

ServiceIdsstring[] required

Unique identifiers of the Services from which the reservations are requested.

ServiceIdstring uuid nullable
GroupIdsstring[] nullable

Unique identifiers of the requested Reservation groups.

ReservationIdsstring[] nullable

Unique identifiers of the requested Reservations.

CustomerIdsstring[] nullable

Unique identifiers of the Customers which own the reservations.

AssignedResourceIdsstring[] nullable

Unique identifiers of Resources assigned to the reservations.

RateIdsstring[] nullable

Unique identifiers of Rates assigned to the reservations.

BusinessSegmentIdsstring[] nullable

Unique identifiers of Business segments assigned to the reservations.

ChannelNumbersstring[] nullable

Set of numbers or references used by the Channel (i.e. OTA, GDS, CRS, etc.) in case the reservation group originates there, e.g. Booking.com confirmation numbers.

Numbersstring[] nullable

Confirmation numbers of Reservations.

StartUtcstring date-time nullable

Start of the interval in UTC timezone in ISO 8601 format. Required when used in conjunction with the TimeFilter or States search parameter.

EndUtcstring date-time nullable

End of the interval in UTC timezone in ISO 8601 format. Required when used in conjunction with the TimeFilter or States search parameter.

TimeFilter'Colliding' | 'Created' | 'Updated' | 'Start' | 'End' | 'Overlapping' | 'Canceled'
Currencystring currency nullable

ISO-4217 code of the Currency the item costs should be converted to.

StatesServiceOrderStateOld[] nullable

States the reservations should be in. If not specified, reservations in Confirmed, Started or Processed states or reservations specified by ReservationIds regardless of state are returned.

Response

OK

Cursorstring uuid nullable

Unique identifier of the last and hence oldest reservation returned. This can be used in Limitation in a subsequent request to fetch the next batch of older reservations.