Hotels Parameters
Page Type | Description | Landing Page |
---|---|---|
home-view | Hotels Home | Link |
day-view | Hotels Day View | Link |
hotel-details | Hotel Details | Link |
For more details on the supported verticals and page types, please visit Verticals and Page Types.
Hotels Home View Schema
/hotels/home-view
A schema definition for the hotels home-view microsite supported parameters.
Hotels Home View Properties
Property | Type | Required |
---|---|---|
checkin | string | Optional |
checkout | string | Optional |
adults | integer | Optional |
rooms | integer | Optional |
skyscanner_node_code | string | Optional |
market | string | Optional |
locale | string | Optional |
currency | string | Optional |
checkin
Required | Type | Format |
---|---|---|
Optional | string | YYYY-MM-DD |
checkout
Required | Type | Format |
---|---|---|
Optional | string | YYYY-MM-DD |
adults
Number of adults. The number of adults should be greater than or equal to the number of rooms.
Required | Type | Format |
---|---|---|
Optional | integer | e.g. 2 |
rooms
Number of rooms. The number of rooms should be less than or equal to the number of adults.
Required | Type | Format |
---|---|---|
Optional | integer | e.g. 1 |
skyscanner_node_code
The IATA code of the destination. IATA codes are available for airlines, airports and cities. They are often used internationally and recognised by multiple airlines and airports. Search IATA Codes
Required | Type | Format |
---|---|---|
Optional | string | e.g. EDI , BCN , LIS |
market
The preferred market for searching results.
When unspecified, we use detection logic to determine the market, so it is unlikely you will need to use this parameter. If you want to learn more, please visit our Localisation page.
Required | Type | Format |
---|---|---|
Optional | string | e.g. UK , US , FR |
locale
The preferred locale for the desired page.
When unspecified, we use detection logic to determine the locale, so it is unlikely you will need to use this parameter. If you want to learn more, please visit our Localisation page.
Required | Type | Format |
---|---|---|
Optional | string | e.g. es-ES , en-GB , fr-FR |
currency
The preferred currency for the desired page.
When unspecified, we use detection logic to determine the currency, so it is unlikely you will need to use this parameter. If you want to learn more, please visit our Localisation page.
Required | Type | Format |
---|---|---|
Optional | string | e.g. GBP , EUR , USD |
Hotels Day View Schema
/hotels/day-view
A schema definition for the hotels day-view
microsite supported parameters.
Hotels Day View Properties
Property | Type | Required |
---|---|---|
entity_id | string | Required |
checkin | string | Optional |
checkout | string | Optional |
adults | integer | Optional |
rooms | integer | Optional |
sort | string | Optional |
market | string | Optional |
locale | string | Optional |
currency | string | Optional |
entity_id
The ID of the geo location for which the search will be performed.
For more information on the entity_id
supported values, have a look at the IATA codes and Entity IDs page.
Required | Type |
---|---|
Required | string |
checkin
Required | Type | Format |
---|---|---|
Optional | string | YYYY-MM-DD |
checkout
Required | Type | Format |
---|---|---|
Optional | string | YYYY-MM-DD |
adults
Number of adults. The number of adults should be greater than or equal to the number of rooms.
Required | Type | Format |
---|---|---|
Optional | integer | e.g. 2 |
rooms
Number of rooms. The number of rooms should be less than or equal to the number of adults.
Required | Type | Format |
---|---|---|
Optional | integer | e.g. 1 |
sort
Defines the order in which search results appear. If not specified, results will be sorted by best
.
Learn more
Required | Type |
---|---|
Optional | enum |
The value of this property must be equal to one of the following values:
ENUM values | Explanation |
---|---|
price | Sorts by price in ascending order |
-price | Sorts by price in descending order |
distance | Sorts by distance from the city centre in ascending order |
-hotel_rating | Sorts by hotel rating in descending order |
stars | Sorts by hotel stars in ascending order |
-stars | Sorts by hotel stars in descending order |
market
The preferred market for searching results.
When unspecified, we use detection logic to determine the market, so it is unlikely you will need to use this parameter. If you want to learn more, please visit our Localisation page.
Required | Type | Format |
---|---|---|
Optional | string | e.g. UK , US , FR |
locale
The preferred locale for the desired page.
When unspecified, we use detection logic to determine the locale, so it is unlikely you will need to use this parameter. If you want to learn more, please visit our Localisation page.
Required | Type | Format |
---|---|---|
Optional | string | e.g. es-ES , en-GB , fr-FR |
currency
The preferred currency for the desired page.
When unspecified, we use detection logic to determine the currency, so it is unlikely you will need to use this parameter. If you want to learn more, please visit our Localisation page.
Required | Type | Format |
---|---|---|
Optional | string | e.g. GBP , EUR , USD |
Hotel Details Schema
/hotels/hotel-details
A schema definition for the hotel details microsite supported parameters.
Hotel Details Properties
Property | Type | Required |
---|---|---|
hotelId | string | Required |
checkin | string | Optional |
checkout | string | Optional |
adults | integer | Optional |
rooms | integer | Optional |
market | string | Optional |
locale | string | Optional |
currency | string | Optional |
hotelId
The entity ID of the hotel.
For more information on the hotelId
supported values, have a look at the IATA codes and Entity IDs page.
Required | Type |
---|---|
Required | string |
checkin
Required | Type | Format |
---|---|---|
Optional | string | YYYY-MM-DD |
checkout
Required | Type | Format |
---|---|---|
Optional | string | YYYY-MM-DD |
adults
Number of adults. The number of adults should be greater than or equal to the number of rooms.
Required | Type | Format |
---|---|---|
Optional | integer | e.g. 2 |
rooms
Number of rooms. The number of rooms should be less than or equal to the number of adults.
Required | Type | Format |
---|---|---|
Optional | integer | e.g. 1 |
market
The preferred market for searching results.
When unspecified, we use detection logic to determine the market, so it is unlikely you will need to use this parameter. If you want to learn more, please visit our Localisation page.
Required | Type | Format |
---|---|---|
Optional | string | e.g. UK , US , FR |
locale
The preferred locale for the desired page.
When unspecified, we use detection logic to determine the locale, so it is unlikely you will need to use this parameter. If you want to learn more, please visit our Localisation page.
Required | Type | Format |
---|---|---|
Optional | string | e.g. es-ES , en-GB , fr-FR |
currency
The preferred currency for the desired page.
When unspecified, we use detection logic to determine the currency, so it is unlikely you will need to use this parameter. If you want to learn more, please visit our Localisation page.
Required | Type | Format |
---|---|---|
Optional | string | e.g. GBP , EUR , USD |