v1

latestSwagger 2.02026-07-141993129.2 KB
Bookings

Find bookings matching the given filter criteria.

Here you can easily find bookings matching various criteria. The booking you are looking for has to fullfill all the specified criteria at the same time. So if you specify a customer name and a channel code you will get all bookings where the firstname or lastname of a guest or a contact contains the specified value and that have been done through the defined channel. A booking can consist of multiple reservations, so even if you are looking for a specific reservation which is part of a multi-room booking you will get all reservations for this booking returned.

get/api/booking/v0/bookings

Query parameters

hotelIdinteger

Only return bookings for this specific hotel.

cancellationIdstring

Return bookings for this cancellation id.

reservationNumberinteger

Return bookings matching this reservation number. Please note that reservation numbers are only unique within a hotel. If you don´t specify a hotel filter at the same time you could get back multiple bookings from different hotels.

customerNamestring

Return all bookings where the first or lastname of one of the guests or the contact contains the specified value. The search is executed case insensitive and also stripping of any whitespaces.

customerEmailstring

Return all bookings where the primary email address of one of the guests or the contact contains the specified value. The search is executed case insensitive and also stripping of any whitespaces.

customerIdstring

Return all bookings the id of one of the guests or the contact matches the specified value.

roomNumberstring

Return all bookings having the specified room number assigned.

externalIdstring

Return all bookings exactly matching the specified external id. This filter is case sensitive.

companyNamestring

Return all bookings where the name of the linked company or travel agent profile contains the specified value. The search is executed case insensitive and also stripping of any whitespaces.

companyIdstring

Return all bookings the id of the company or travel agent profile matches the specified value.

companyEmailstring

Return all bookings where the primary email address of the company or the travel agent profile contains the specified value. The search is executed case insensitive and also stripping of any whitespaces.

blockCodestring

Return all bookings where the block code matches the specified value.

reservationStatusesstring[]

Return all bookings where the reservation status is one of the specified values.

marketCodesstring[]

Return all bookings where the market code is one of the specified values.

channelCodesstring[]

Return all bookings where the channel code is one of the specified values.

subChannelCodesstring[]

Return all bookings where the subchannel code is one of the specified values.

roomTypesstring[]

Return all bookings where the room type is one of the specified values.

ratePlanCodesstring[]

Return all bookings where the rate plan code is one of the specified values.

labelsstring[]

Return all reservations with at least one of the specified labels.

fromstring date-time

Start date for the selected date filter. If you select arrival date as date filter the bookings returned will have at least one reservation arriving on the specified date or later.

tostring date-time

End date for the selected date filter. If you select arrival date as date filter the bookings returned will have at least one reservation arriving on the specified date or earlier.

dateFilter'ArrivalDate' | 'DepartureDate' | 'StayDate' | 'CreationDate' | 'ModificationDate'

Select a date field you want to filter bookings by. Only one filter at a time can be applied. The to and from dates will then define the time range.

exclude'Customers'

To be able to request reservations without personal data based on GDPR.

skipinteger

Amount of items to skip.

topinteger

Amount of items to select.

inlinecount'None' | 'AllPages'

Return total number of items for a given filter criteria.

Headers

App-Idstring required

Application identifier

App-Keystring required

Application key.

Response

A list of reservations for the requested hotel identifier.

_countinteger

The number of items matching your request in total for all pages.

_linksobject

Collection of links to related resources