| Query parameter | Description |
|---|---|
apiKey Required | API key assigned to the affiliate |
userTrackId Required | Client-specific unique identifier to identify this user. There are no restrictions on this value, but it should be unique to the client and remain the same for the duration of the client’s session |
hotel Required | Key of the hotel to search |
onlyIfComplete Default: false | Specifies whether the server should respond with a Refer to |
searchTimeout | Maximum time in milliseconds to wait for the search to complete. If the search does not complete within the specified time, only the results gathered until that point will be returned |
checkin | Check-in date |
checkout | Check-out date |
rooms | Number of rooms and guests. Required when searching with check-in and check-out dates |
languageCode Default: EN | Language in which the results should be returned |
currencyCode | Currency in which rates should be returned. Defaults to the currency based on user's location |
includeTaxesInTotal | Specifies whether rates should include taxes (VAT/sales tax, not local taxes payable at the hotel). If not specified, the standard market-specific logic based on client IP address will be applied |
includeLocalTaxesInTotal | Specifies whether rates should include local taxes (i.e. taxes and fees payable at the hotel). If not specified, the standard-market-specific logic based on client IP address will be applied. All taxes are included when this parameter is set to true |
responseOptions | Optional details to include in the response |
| Responses |
|---|
200 - application/json {
"id": 53213,
"key": "khotel:53213",
"name": "Novotel Paris les Halles",
"address": "8 Place Marguerite de Navarre",
"hotelCountryCode": "FR",
"latitude": 48.86061,
"longitude": 2.346624,
"starRating": 4,
"isSelfRated": false,
"lowestRate": 123,
"isComplete": false,
"searchTime": 141,
"totalResults": 0,
"currencyCode": "USD",
"languageCode": "EN",
"countryCode": "US",
"policies": [
{
"code": "checkin",
"name": "Check-in",
"description": "From 2:00 pm"
},
{
"code": "checkout",
"name": "Check-out",
"description": "Prior to 12:00 pm"
}
],
"providers": [
{
"code": "BOOKINGDOTCOMAFFILIATE",
"name": "Booking.com",
"logo": "https://content.r9cdn.net/rimg/provider-logos/hotels/h/BOOKINGDOTCOM.png?crop=false&width=88&height=31&fallback=default2.png&_v=1233faf051a0a6b9d9807846b1316f74",
"isDirect": false,
"isLanguageSupported": true
}
],
"results": [
{
"roomName": "Superior Room, 1 Double Bed with Sofa bed",
"totalRate": 496.57,
"isCheapestRate": true,
"hasFreeCancellation": true,
"canPayLater": false,
"isBundledRate": false,
"inclusions": [
0
],
"availableRooms": 5,
"providerIndex": 0,
"isDeprioritisedForExcludedCharges": false,
"bookUri": "https://sandbox-en-us.kayakaffiliates.com/in?cluster=5&a=test&p=&cc=us&mc=USD&lc=EN&url=%2Fbook%2Fhotel%3Fcode%3DePGkPeZiuU.WfxetRcZFwD1Q7IXP-_L1Py0tDCcY098_zlHXEqg5Jg.8011.34725.MTczNTAxNjQwMDAwMF4xNzM1MTg5MjAwMDAwXjFeMl4%3D%26h%3D15934f2d29fb%26sub%3D0%26_pt_%3D1&utid=Y2JlZWVkZTctOGQwMy00YjNmLTk0YjItNmEyOTgyNmIwZGFj&cookieOverrides=e0r-vV17CTyHTY65FOuSfpuiSi532wQJ5efdFnxzSuKhG6hIIkTjCcazxC1bHSnyNDLZSN6LSQ92RWM8UC2QrTiqSq74qWiWmqrB6bGpmBAMa6U3OZ4OyZLfeXwRDHnM1tHUoT5wROmaDjmSIwQkTfyq0BGn6FcFYK-0mxtf-FM"
}
]
} |