2.2.1.4 Get Hotel Static Content
About 1373 wordsAbout 5 min
2025-11-03
Warning
- Mandatory
- Klook uses this interface to retrieve all static content (such as name, address, policies, images, room types, etc.) for a specified supplier hotel ID and language.
URL
Integrator to define and provide to Klook
Input Parameters
| Field | Type | Mandatory | Description |
|---|---|---|---|
supplierHotelId | String | true | Integrator Hotel ID |
language | String | true | Standard language code,default en_US 1: Please refer to 3.3 Dictionary Description (e.g., en_US, zh_CN) 2: Klook will iterate through all languages based on the 'Supported languages for static data' in 2.2.2.5 Offline Provision and Fixed Configuration Data Description |
Base Input Parameter Extension Fields
| Field | Type | Mandatory | Description |
|---|---|---|---|
supplierAccount | String | false | openApi supplier account data Integrator defines the account data1: The account is used for different product types for specific use cases. For example, a Member account returns rates for Members only, non-Members will not see the rate. It supports multiple accounts2: If the integrator does not have multiple accounts, the value passed is null3: Length does not exceed 128 characters |
Input Parameter Example
Example
{
"base": {
"requestId": "xxxx",
"requestTime": "xxx",
"requestAgent": "xxx",
"openApiSign": "xx",
"supplierAccount": "account1",
"version": "xxx"
},
"requestData": {
"supplierHotelId": "ABC123",
"language": "en_US"
}
}Output Parameters
| Field | Type | Mandatory | Description |
|---|---|---|---|
hotelId | String | true | Integrator Hotel ID |
hotelName | String | true | Integrator Hotel Name |
categoryId | String | true | Integrator Hotel Category Klook will convert based on the supplier dictionary supplierKey toKlook category data ( dataType = 7) |
star | String | false | Integrator Hotel Star Rating Klook will convert based on the supplier dictionary supplierKey toKlook category data ( dataType = 19) |
group | String | false | Integrator Hotel Group Klook will convert based on the brand to Klook's own hotel group ( dataType = 5) |
brand | String | false | Integrator Hotel Brand Klook will convert based on the supplier dictionary supplierKey toKlook category data ( dataType = 5) |
roomNum | int | false | Number of Rooms |
floors | int | false | Number of Floors |
openDate | String | false | Opening Date |
lastDecorationDate | String | false | Last Renovation Date |
contactInfo | ContactInfo | true | Contact Information |
addressInfo | AddressInfo | true | Hotel Address Information |
hotelAttrList | List<String> | true | Integrator Hotel Amenities Klook will convert based on the supplier dictionary supplierKey( dataType = 1) |
themeList | List<String> | false | Integrator Hotel Themes Klook will convert based on the supplier dictionary supplierKey( dataType = 13) |
policyInfo | PolicyInfo | true | Hotel Policy |
hotelImgList | List<ImgDetail> | false | Hotel Images |
descInfo | DescInfo | false | Description Information |
ranking | int | false | Ranking |
guestRating | Double | false | Guest Rating |
roomInfoList | List<RoomInfo> | true | Room Information |
ContactInfo
| Field | Type | Mandatory | Description |
|---|---|---|---|
email | String | false | Hotel Email Address |
phoneList | List<ContactPhone> | true | Hotel Phone List |
ContactPhone
| Field | Type | Mandatory | Description |
|---|---|---|---|
type | String | true | Phone Number Type Enum: phone_hotel (Hotel Phone Num)phone_booking(Booking Phone Num) phone_service(Service Phone Num) fax_number (Fax) |
phone | String | true | Phone Number |
AddressInfo
| Field | Type | Mandatory | Description |
|---|---|---|---|
longitude | String | true | Longitude (Google coordinate system)Mandatory |
latitude | String | true | Latitude (Google coordinate system)Mandatory |
postalCode | String | false | Postal Code |
country | String | false | Integrator Hotel Country ID, standard two-letter country code |
province | String | false | Integrator Hotel Province ID |
city | String | false | Integrator Hotel City ID |
area | String | false | Integrator Hotel Area Information |
address | String | true | Integrator Hotel Address |
PolicyInfo
| Field | Type | Mandatory | Description |
|---|---|---|---|
allowChild | boolean | true | Whether children are allowed to check in, default is allowed |
childMinAge | int | true | Minimum age of children |
childMaxAge | int | true | Maximum age of children |
childPolicy | String | true | Child policy (e.g., Guests under 18 are not allowed to check in alone) |
petPolicy | String | false | Pet policy (e.g., Pets are not allowed) |
extraBedPolicy | String | true | Extra bed policy |
checkInPolicy | CheckInPolicy | true | Check-in Policy |
CheckInPolicy
| Field | Type | Mandatory | Description |
|---|---|---|---|
checkInFrom | String | true | Earliest check-in time format 00:00 |
checkInTo | String | true | Latest check-in time format 00:00 |
checkOutTo | String | true | Latest check-out time format 00:00 |
checkInMinAge | String | true | Minimum check-in age |
ImgDetail
| Field | Type | Mandatory | Description |
|---|---|---|---|
url | String | true | Hotel image URL |
prime | boolean | false | Whether it is the primary image, default is non-primary |
size | String | false | Image size, in pixels (e.g., 800px)If image size is not provided, all are treated as low-quality images ( Default=200px) |
groupId | String | true | Image category Klook will convert based on the supplier dictionary supplierKey 1: Hotel images use dataType = 15 2: Room type images use dataType = 2 |
desc | String | false | Image description |
DescInfo
| Field | Type | Mandatory | Description |
|---|---|---|---|
amenityDesc | String | false | Amenity description |
diningDesc | String | false | Dining description |
renovationDesc | String | false | Renovation description |
ratingDesc | String | false | Star rating description |
businessAmenitiesDesc | String | false | Business amenities description |
roomDesc | String | false | Room description |
attractionDesc | String | false | Nearby attractions description |
locationDesc | String | true | Location description |
headlineDesc | String | false | Headline description |
policyDesc | String | true | Accommodation policy description |
mandatoryFeeDesc | String | true | Mandatory fee description |
optionalFeeDesc | String | true | Optional fee description |
checkInDesc | String | false | Check-in description |
specialInstructions | String | false | Any special instructions regarding staying at this accommodation (may be specific to this accommodation) |
checkOutDesc | String | true | Check-out description |
RoomInfo (Room Information)
| Field | Type | Mandatory | Description |
|---|---|---|---|
roomId | String | true | Integrator Room Type ID |
roomName | String | true | Integrator Room Type Name (Affects mapping) |
roomCount | int | false | Number of rooms |
floors | int | false | Floor where the room is located |
roomDetailBedList | List<RoomDetailBed> | true | Room detail bed list When a single roomId corresponds to multiple rooms, List size = number of rooms. The relationship between multiple rooms is AND |
viewIdList | List<String> | false | Integrator Room View Klook will convert based on the supplier dictionary supplierKey (dataType = 6) |
roomAttrList | List<String> | false | Integrator Room Amenities List Klook will convert based on the supplier dictionary supplierKey (dataType = 3) |
smoke | boolean | true | if can smoke true-can smoke false-no smoke |
roomAreaSize | String | true | Room Area Size - square meters (Affects mapping) |
roomPolicyInfo | RoomPolicyInfo | true | Room Check-in Policy |
roomDesc | String | false | Room Type Description |
roomImgList | List<HotelRoomImg> | false | Room Type Images |
hasWindow | boolean | false | Whether it has a window |
RoomPolicyInfo
| Field | Type | Mandatory | Description |
|---|---|---|---|
childPolicy | String | false | Child Policy |
checkInPolicy | CheckInPolicy | true | Room Check-in Policy |
CheckInPolicy (In Room)
| Field | Type | Mandatory | Description |
|---|---|---|---|
maxTotal | int | true | Maximum total number of guests |
maxAdult | int | true | Maximum number of adults |
maxChild | int | true | Maximum number of children |
RoomDetailBed (Room Bed Detail)
| Field | Type | Mandatory | Description |
|---|---|---|---|
roomName | String | false | Room Name |
roomDesc | String | false | Room Description |
bedList | List<List<BedStructure>> | true | Room Bed Type (Affects mapping)1:The inner nodes of the first layer List have an "OR" relationship2:The inner nodes of the second layer List have an "AND" relationship3:Example: (1 King Bed & 2 Single Beds) OR (2 Queen Beds & 3 Single Beds) |
BedStructure (Bed Structure)
| Field | Type | Mandatory | Description |
|---|---|---|---|
bedId | String | true | Integrator Bed Type ID Klook will convert based on the supplier dictionary supplierKey (dataType = 11) |
bedName | String | false | Integrator Bed Type Name |
width | double | false | Bed width, unit in meters (Affects mapping) |
length | double | false | Bed length, unit in meters (Affects mapping) |
quantity | int | true | Bed quantity |
Output Parameter Example
Example
{
"success": true,
"error": {
"code": "",
"message": ""
},
"result": {
"hotelId": " ",
"hotelName": " ",
"categoryId": "0",
"star": "0",
"group": "0",
"brand": "0",
"roomNum": 0,
"floors": 12,
"openDate": " ",
"lastDecorationDate": " ",
"contactInfo": {
"phoneList": [
{
"type": "phone_hotel",
"phone": "123456789"
}
],
"email": " "
},
"addressInfo": {
"longitude": " ",
"latitude": " ",
"postalCode": " ",
"country": " ",
"province": " ",
"city": " ",
"area": " ",
"address": " "
},
"hotelAttrList": [
"11",
"222"
],
"themeList": [
"dsy"
],
"policyInfo": {
"checkInPolicy": {
"checkInFrom": " ",
"checkInTo": " ",
"checkOutTo": " ",
"checkInMinAge": " "
},
"allowChild": true,
"childMinAge": 0,
"childMaxAge": 0,
"childPolicy": " ",
"petPolicy": " ",
"extraBedPolicy": " "
},
"hotelImgList": [
{
"url": " ",
"prime": true,
"size": " ",
"groupId": "111",
"desc": " "
}
],
"descInfo": {
"amenityDesc": " ",
"diningDesc": " ",
"renovationDesc": " ",
"ratingDesc": " ",
"businessAmenitiesDesc": " ",
"roomDesc": " ",
"attractionDesc": " ",
"locationDesc": " ",
"headlineDesc": " ",
"policyDesc": " ",
"mandatoryFeeDesc": " ",
"optionalFeeDesc": " ",
"checkInDesc": " ",
"specialInstructions": " ",
"checkOutDesc": " "
},
"ranking": 0,
"guestRating": 0,
"roomInfoList": [
{
"roomId": " ",
"roomName": " ",
"roomCount": 0,
"floors": 13,
"roomDetailBedList": [
{
"roomName": "King Bed Room",
"roomDesc": "King Bed Room multiple beds",
"bedList": [
[
{
"bedId": "0",
"bedName": "big bed name",
"width": 1.2,
"length": 2.1,
"quantity": 2
}
]
]
},
{
"roomName": "Twin Bed Room",
"roomDesc": "Twin Bed Room multiple beds",
"bedList": [
[
{
"bedId": "0",
"bedName": "double bed name",
"width": 1.2,
"length": 2.1,
"quantity": 3
}
]
]
}
],
"viewIdList": [
"1",
"2"
],
"roomAttrList": [
"12",
"22"
],
"smoke": true,
"roomAreaSize": "25.6",
"roomPolicyInfo": {
"checkInPolicy": {
"maxTotal": 4,
"maxAdult": 4,
"maxChild": 2
},
"childPolicy": " "
},
"roomDesc": "",
"roomImgList": [
{
"url": " ",
"prime": true,
"size": " ",
"groupId": "0",
"desc": " "
}
],
"hasWindow": true
}
]
}
}