Reservation List

POST

/api/v1/generic-api-service/royal/hotel/book/list?page=0&size=100

The reservation list endpoint shows all the reservations of the agency/sales channel.

Request

{
  "filterType": "creation",
  "from": "2023-08-01",
  "to": "2023-08-30"
}

Response

{
  "reservations": [
    {
      "voucher": "ETSR202981718",
      "status": "CANCELLED",
      "bookingNumber": "112413646",
      "bookDetailPriceResponse": {
        "amount": 464.95,
        "currency": "EUR"
      },
      "clientReferenceId": null,
      "hotelCode": "sxk9jqw4pthy",
      "checkIn": "2023-10-11",
      "checkOut": "2023-10-13",
      "saleDate": "2023-08-16T11:01:38.365253"
    },
    {
      "voucher": "ETSR202954764",
      "status": "CANCELLED",
      "bookingNumber": "112389724",
      "bookDetailPriceResponse": {
        "amount": 1514.1,
        "currency": "EUR"
      },
      "clientReference": null,
      "hotelCode": "swr046bytpxn",
      "checkIn": "2023-10-11",
      "checkOut": "2023-10-15",
      "saleDate": "2023-08-10T08:38:58.513935"
    }
  ]
}

Request Details

Name	Type	Required	Description
filterType	String	Yes	Enum: "creation" "check_in" "check_out" Parameter used to define whether start and end fields are filtering by check-in ,check-out date or by booking creation date.
from	String	Yes	Defines the starting date of the range of bookings to be returned.
to	String	Yes	Defines the ending date of the range of bookings to be returned. value.

Response Details

Name	Type	Required	Description
reservations	object-Array	Yes	Reservation list.
reservations/voucher	string	Yes	Voucher number that will be created in our system when the reservation is completed successfully.
reservations/status	string	Yes	Reservation status.
reservations/bookingNumber	string	Yes	Booking number that will be created in our system when the reservation is completed successfully
reservations/bookDetailPriceResponse	object	Yes	Price details of the reservation.
reservations/bookDetailPriceResponse/amount	int	Yes	Price amount of the reservation.
reservations/bookDetailPriceResponse/currency	string	Yes	Price currency of the reservation.
reservations/clientReference	string	No	[ 1 .. 20 ] characters. Internal booking reference.
reservations/hotelCode	string	Yes	It is the code of the hotel that the reservation is made.
reservations/checkIn	string	Yes	'checkIn' parameter refers to the day of check-in to the hotel. It should be sent in the format 'YYYY-MM-DD'.
reservations/checkOut	string	Yes	'checkout' parameter refers to the day of departure from the hotel. It should be sent in YYYY-MM-DD format. The date to be sent in the checkout parameter must be after the date to be sent in the checkin parameter.
reservations/saleDate	string	Yes	This is the time when the reservation is complete.. It should be sent in the format 'YYYY-MM-DD hh:mm:ss tt'