BookingList
GET {{endpoint}}/hotel-api/1.0/bookings?start={{startDate}}&end={{endDate}}&from=1&to=25
The BookingList operation returns a list of bookings based on the search criteria.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
start | string | Initial value of the date range to search for reservations. The format must be YYYY-MM-DD | |
end | string | Final value of the date range to search for reservations. The format must be YYYY-MM-DD | |
filterType | string | Defines the criteria of the date range filter (if affects creation date, check-in date or cancellation policies date) Values: |
CHECKIN: for check-in date
CREATION: for creation date
MODIFIED: for modification date
CLXPOLICIES: for cancellation policies |
| status | string | | The parameter is used to get all bookings, including or excluding cancelled bookings. Values:
"ALL" displays all bookings.
"CONFIRMED" displays only confirmed bookings.
"CANCELLED" displays only cancelled bookings. |
| from | number | | Number "from" of bookings to be returned. |
| to | number | | Number "to" of bookings to be returned. |
| clientReference | string | | Parameter to filter the result by the client reference included in the booking. |
| country | string | | Parameter to filter the results by the country of the hotel. |
| destination | string | | Parameter to filter the results by the destination of the hotel. |
| hotel | string | | Parameter to filter the results by the hotels reserved in the bookings. |
| extend | boolean | | Extends the response info to show tax breakdown, commission, passenger structure and remarks. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Api-key | string | API Key used in the request | |
X-Signature | string | SHA256 hash in Hex format from your API Key, your secret plus current timestamps in seconds | |
Accept | string | Defines response format, posible values: application/xml, application/json | |
Accept-Encoding | string | Defines type of encoding used on the data |