Search

POST

/api/v1/generic-api-service/royal/hotel/search

The search endpoint is used to return a list of hotels suitable for a certain date range and number of people in a given destination.

Request

{
  "hotelCodes": ["djuk19kyv9zd"],
  "checkIn": "2023-04-18",
  "checkOut": "2023-04-21",
  "clientNationality": "TR",
  "feedId": "1714d37c-2a14-460d-8344-cdff5cf02018",
  "rooms": [
    {
      "adults": 2,
      "child": 1,
      "childAges": [2]
    }
  ]
}

Response

{
  "totalHotelCount": 1,
  "hotels": [
    {
      "hotelCode": "djuk19kyv9zd",
      "hotelName": "Quality Inn",
      "destinations": [
        {
          "id": 631,
          "type": "COUNTRY",
          "typeId": 0,
          "name": "United States"
        },
        {
          "id": 104369,
          "type": "CITY",
          "typeId": 0,
          "name": "Forsyth"
        },
        {
          "id": 98951,
          "type": "TOWN",
          "typeId": 0,
          "name": "Macon"
        }
      ],
      "rooms": [
        {
          "pax": {
            "adult": 2,
            "child": 1,
            "childAges": [2]
          },
          "totalPrice": 226.44,
          "nightlyPrices": [
            {
              "date": "2023-04-20",
              "amount": 12.71,
              "currency": "EUR"
            }
          ],
          "roomType": "Standard Room, 2 Double Beds, Non Smoking",
          "roomCode": "201467946",
          "mealType": "Bed and Breakfast",
          "mealTypeCode": "BB",
          "taxes": [
            {
              "type": "tax_and_service_fee",
              "price": 38.13,
              "currency": "EUR",
              "description": "tax and service fee",
              "included": false
            }
          ],
          "fees": [
            {
              "type": "hotel_fee",
              "price": 10.2,
              "currency": "EUR",
              "description": "hotel fee",
              "included": true
            }
          ],
          "refundable": true
        }
      ]
      "geoLocation": {
        "lat": 36.8847,
        "lon": 30.7052
      }
    }
  ]
}

Request Details

Name	Type	Required	Description
hotelCodes	string-list	Yes	'hotelCodes' parameter enables a search for the hotel(s) to be searched. If a destination search is to be made, your destinations must be mapped with the Etstur structure, so that these hotels can be searched.
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'.
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.
clientNationality	string	Yes	The country of the guests who will be included in the reservation. It must be sent as a 2-digit country code. If the reservation includes guests from more than one country, the country of the first guest of the reservation must be sent.
feedId	UUID	Yes	'feedId' parameter refers to pricetype(B2B,B2C). The unique feed ID provided must be submitted.
rooms	object-array	Yes	It is the information of the room to be reserved. Currently, only 1 room can be reserved per 1 reservation. When the multi-room feature is provided, it will be seen in the document.
rooms/adults	int	Yes	The number of adults that can be accommodated. It can take a value between 1 and X.
rooms/child	int	No	The number of children that can be accommodated. It can take a value between 1 and X.
rooms/childAges	int-array	No	If there are children in the reservation, age of the children must be sent. It can take values between 0 and X.

Response Details

Name	Type	Required	Description
totalHotelCount	int	Yes	It is the number of hotels that return availability as a result of the search.
hotels	object-array	Yes	Information of the hotels with availability as a result of the search is returned with the Hotels object.
hotels/hotelCode	string	Yes	Hotel code returned as a result of the search is displayed with the 'hotelCode' parameter.
hotels/hotelName	string	Yes	Hotel name returned as a result of the search is displayed with the 'hotelName' parameter.
hotels/destinations	object-array	Yes	The destinations where the hotel is located are placed in the 'destinationCode' object.
hotels/destinations/id	int	Yes	Destination id in Etstur structure.
hotels/destinations/type	string	Yes	Destination type in Etstur structure.
hotels/destinations/typeId	int	Yes	Destination typeId in Etstur structure.
hotels/destinations/name	string	Yes	Destination name in Etstur structure.
hotels/currency	string	Yes
hotels/rooms	object-array	Yes	Information about the cheapest room of the hotel is returned with the 'Rooms' object.
hotels/rooms/pax	object-array	Yes	Information about the guests in the room.
hotels/rooms/pax/adult	int	Yes	The number of adults that can be accommodated.
hotels/rooms/pax/child	int	No	The number of children that can be accommodated.
hotels/rooms/pax/childAges	int-array	No	If there are children in the reservation, age of the children must be sent.
hotels/rooms/totalPrice	decimal	Yes	Total price of the room.
hotels/rooms/nightlyPrices	object-array	Yes	An object that allows the room's nightly prices to be displayed separately and Price must be big decimal type.
hotels/rooms/nightlyPrices/date	string	Yes	Date of the day, date format must be YYYY-MM-DD
hotels/rooms/nightlyPrices/amount	decimal	Yes	Price amount of the day
hotels/rooms/nightlyPrices/currency	string	Yes	Information in which currency the reservation amount is in is returned with the 'currency' parameter.
hotels/rooms/roomType	string	Yes	Room type in Etstur structure.
hotels/rooms/roomCode	string	Yes	Room code in Etstur structure.
hotels/rooms/mealType	string	Yes	Meal type in Etstur structure.
hotels/rooms/mealTypeCode	string	Yes	Meal type code in Etstur structure.
hotels/rooms/taxes	object-array	No	If there is a tax related to accommodation, it will be included in this field.
hotels/rooms/taxes/type	string	No	Tax type
hotels/rooms/taxes/price	decimal	No	Tax amount
hotels/rooms/taxes/currency	string	No	Tax currency
hotels/rooms/taxes/description	string	No	Tax description
hotels/rooms/taxes/included	boolean	No	Information whether the tax price is included in the total amount. Included if it is True and not included if it is False.
hotels/rooms/fees	object-array	No	If there is an extra fee related to accommodation, it will be included in this field.
hotels/rooms/fees/type	string	No	Fee type
hotels/rooms/fees/price	decimal	No	Fee amount
hotels/rooms/fees/currency	string	No	Fee currency
hotels/rooms/fees/description	string	No	Fee description
hotels/rooms/fees/included	boolean	No	Information whether the extra fee is included in the total amount. Included if it is True and not included if it is False.
hotels/rooms/refundable	boolean	Yes	Information about whether the reservation is cancelled. Refundable if it is True, nonrefundable if it is False.
hotels/geoLocation/lat	decimal	Yes	Latitude information of hotel.
hotels/geoLocation/lon	decimal	Yes	Longitude information of hotel.