Retrieve hotels content by IDs
https://api.worldota.net/api/content/v1/hotel_content_by_ids/
The call allow to obtain a required hotel content by id. Use the call in cases:
- Instead of hotel static data
- You want to check the content before making a booking with a possible update.
- Use this call after the Retrieve hotel IDs by filter call.
Request example
curl --user '<KEY_ID>:<API_KEY>' 'https://api.worldota.net/api/content/v1/hotel_content_by_ids/' \
--header 'Content-Type: application/json' \
--data '{
"hids": [9852019],
"language": "en"
}'
curl --user '<KEY_ID>:<API_KEY>' 'https://api.worldota.net/api/content/v1/hotel_content_by_ids/' \
--header 'Content-Type: application/json' \
--data '{
"ids": ["hotel_1"],
"language": "en"
}'
Request body
The unique hotel IDs in the new numeric format.
- Each ID is an integer no longer than 10 digits.
- We are gradually migrating all clients to use this format.
- Use the values from the call Retrieve hotel IDs by filter.
The language.
- Use the
value
field from the call Retrieve filter values.
Response
The unique hotel ID in the legacy string format.
- Either this field or the
hid
field is required.
The unique hotel ID in the new numeric format.
- Each ID is an integer no longer than 10 digits.
- We are gradually migrating all clients to use this format.
The list of the URLs for the hotel images.
Each URL has the {size}
placeholder. Meaning, the size of the image you can get.
- The possible size meanings:
crop
— the image is fit by the width and is cut equally from the bottom and top till the middle part of the height.fit-h
— the image is fit into the rectangle by the height.fit
— the image is fit into the rectangle by the size in question.
- The possible values:
100x100
— crop.1024x768
— fit.120x120
— crop.240x240
— crop.x220
— fit-h.x500
— fit-h.
Information about the hotel images divided into categories.
The hotel image category.
- The possible values:
unspecified
— unspecified.balcony
— balconies.bathroom
— bathrooms.beach
— beaches.business
— business zone.entertainment
— entertainment zones.exterior
— hotel exterior.guest_rooms
— guest rooms.hotel_front
— hotel front.hotel_rooms
— hotel rooms.lobby
— lobby.meal
— meals.outside
— hotel outside view.pool
— pools.spa
— SPA zones.sports
— sport zones.children
— children zones.miscellaneous
— other.
The URL for the hotel image.
Each URL has the {size}
placeholder. Meaning, the size of the image you can get.
- The possible size meanings:
crop
— the image is fit by the width and is cut equally from the bottom and top till the middle part of the height.fit-h
— the image is fit into the rectangle by the height.fit
— the image is fit into the rectangle by the size in question.
- The possible values:
100x100
— crop.1024x768
— fit.120x120
— crop.240x240
— crop.x220
— fit-h.x500
— fit-h.
The hotel type.
The possible values:
Unspecified
,Resort
.Sanatorium
.Guesthouse
.Mini-hotel
.Castle
.Hotel
.Boutique_and_Design
.Apartment
.Cottages_and_Houses
.Farm
.Villas_and_Bungalows
.Camping
.Hostel
.BNB
.Glamping
.Apart-hotel
.
The additional accommodation conditions. Is the same as the section “Hotel policies” from hotel pages on the core website.
In the field, you can find taxes and fees not included in the booking price.
The additional services, fees, and taxes information.
The additional service type.
The possible values:
unspecified
.television
.towels
.conditioning
.housekeeping
.heating
.refrigerator
.utility
.safe
.microwave
.luggage_storage
.tour_guide
.bicycle_rental
.baby_highchair
.bed_linen
.towels_only
.luggage_storage_apartment
.luggage_storage_office
.
The check-in and check-out policies’ information.
The check-in or check-out type.
The possible values:
unspecified
.early_checkin
.late_checkout
.holiday_checkin
.holiday_checkout
.
The check-in and check-out inclusion.
The possible values:
unspecified
.included
.not_included
.
The children extra beds’ policy information.
The extra bed for a child availability.
The possible values:
unspecified
.available
.unavailable
.
The children meals’ policy information.
The children meal inclusion.
The possible values:
unspecified
.included
.not_included
.
The children meal type.
The possible values:
unspecified
.all-inclusive
.breakfast
.breakfast-buffet
.continental-breakfast
.dinner
.full-board
.half-board
.lunch
.nomeal
.some-meal
.english-breakfast
.american-breakfast
.asian-breakfast
.chinese-breakfast
.israeli-breakfast
.japanese-breakfast
.scandinavian-breakfast
.scottish-breakfast
.breakfast-for-1
.breakfast-for-2
.super-all-inclusive
.soft-all-inclusive
.ultra-all-inclusive
.half-board-lunch
.half-board-dinner
.
The cots’ policy information.
The deposit information.
The deposit availability.
The possible values:
unspecified
.available
.unavailable
.
The deposit amount unit.
The possible values:
unspecified
.per_guest_per_night
.per_guest_per_stay
.per_room_per_night
.per_room_per_stay
.per_hour
.per_week
.
The adult extra beds’ policy information.
The extra bed inclusion.
The possible values:
unspecified
.included
.not_included
.
The internet policy information.
The internet inclusion.
The possible values:
unspecified
.included
.not_included
.
The internet price unit.
The possible values:
unspecified
.per_guest_per_night
.per_guest_per_stay
.per_room_per_night
.per_room_per_stay
.per_hour
.per_week
.
The adult meals’ policy information.
The meal type.
The possible values:
unspecified
.all-inclusive
.breakfast
.breakfast-buffet
.continental-breakfast
.dinner
.full-board
.half-board
.lunch
.nomeal
.some-meal
.english-breakfast
.american-breakfast
.asian-breakfast
.chinese-breakfast
.israeli-breakfast
.japanese-breakfast
.scandinavian-breakfast
.scottish-breakfast
.breakfast-for-1
.breakfast-for-2
.super-all-inclusive
.soft-all-inclusive
.ultra-all-inclusive
.half-board-lunch
.half-board-dinner
.
The no-show policy information.
The no-show availability.
The possible values:
unspecified
.available
.unavailable
.
The applicable period for no-show.
The possible values:
unspecified
.before_midday
.after_midday
.
The parking policy information.
The parking inclusion.
The possible values:
unspecified
.included
.not_included
.
The parking price unit.
The possible values:
unspecified
.per_car_per_night
.per_car_per_stay
.per_guest_per_night
.per_guest_per_stay
.per_room_per_night
.per_room_per_stay
.per_hour
.per_week
.
The pets’ accommodation policy information.
The pet accommodation inclusion.
The possible values:
unspecified
.included
.not_included
.
The pet weight type.
The possible values:
unspecified
— no information on the pet weight.lt_5kg
— the pet weight is less than 5 kg.gt_5kg
— the pet weight is greater than 5 kg.
The shuttles’ policy information.
The shuttle destination type.
The possible values:
unspecified
.airport
.train
.ship
.airport_train
.
The shuttle inclusion.
The possible values:
unspecified
.included
.not_included
.
The additional hotel information. Is the same as the section “Extra info” from hotel pages on the core website.
In the field, you can find taxes and fees not included in the booking price.
The data from the field must be shown to the end user.
The additional accommodation conditions. Is the same as the section “Important - Please Note” from hotel pages on the core website.
In the field, you can find taxes and fees not included in the booking price.
The data from the field is obligatory for showing to the end user.
The region where the hotel is located.
The type of the region where the hotel is located.
- The possible values:
Airport
.Bus Station
.City
.Continent
.Country
.Multi-City (Vicinity)
.Multi-Railway Station
.Multi-Region (within a country)
.Neighborhood
.Point of Interest
.Province (State)
.Railway Station
.Street
.Subway (Entrace)
.
The list of the hotel room groups.
The list of the URLs for the room images.
Each URL has the {size}
placeholder. Meaning, the size of the image you can get.
- The possible size meanings:
crop
— the image is fit by the width and is cut equally from the bottom and top till the middle part of the height.fit-h
— the image is fit into the rectangle by the height.fit
— the image is fit into the rectangle by the size in question.
- The possible values:
100x100
— crop.1024x768
— fit.120x120
— crop.240x240
— crop.x220
— fit-h.x500
— fit-h.
Information about the room images divided into categories.
The room image category.
- The possible values:
unspecified
— unspecified.balcony
— balconies.bathroom
— bathrooms.beach
— beaches.business
— business zone.entertainment
— entertainment zones.exterior
— hotel exterior.guest_rooms
— guest rooms.hotel_front
— hotel front.hotel_rooms
— hotel rooms.lobby
— lobby.meal
— meals.outside
— hotel outside view.pool
— pools.spa
— SPA zones.sports
— sport zones.children
— children zones.miscellaneous
— other.
The URL for the room image.
Each URL has the {size}
placeholder. Meaning, the size of the image you can get.
- The possible size meanings:
crop
— the image is fit by the width and is cut equally from the bottom and top till the middle part of the height.fit-h
— the image is fit into the rectangle by the height.fit
— the image is fit into the rectangle by the size in question.
- The possible values:
100x100
— crop.1024x768
— fit.120x120
— crop.240x240
— crop.x220
— fit-h.x500
— fit-h.
The room amenity list.
To get all available room amenities and their definitions, use the room_amenities
field from the Retrieve hotel static data call.
The room ID.
The room class information.
The possible values:
0
— run of house.1
— dorm.2
— capsule.3
— room.4
— junior suite.5
— suite.6
— apartment.7
— studio.8
— villa.9
— cottage.17
— bungalow.18
— chalet.19
— camping.20
— tent.
The room quality information.
The possible values:
0
— undefined.1
— economy.2
— standard.3
— comfort.4
— business.5
— superior.6
— deluxe.7
— premier.8
— executive.9
— presidential.17
— premium.18
— classic.19
— ambassador.20
— grand.21
— luxury.22
— platinum.23
— prestige.24
— privilege.25
— royal.
The room gender restrictions.
The possible values:
0
— undefined.1
— male.2
— female.3
— mixed.
The room bathroom information.
The possible values:
0
— undefined.1
— a shared bathroom.2
— a private bathroom3
— an external private bathroom.
The room bedding information.
The possible values:
0
— undefined.1
— a bunk bed.2
— a single bed.3
— a double bed.4
— a twin bed.7
— multiple beds.
Whether it is a family room or not.
The possible values:
0
— not a family room.1
— a family room.
The maximum number of main bed places without additional charges and excluding extra beds, cots, etc.
The possible values:
0
— undefined.1
— single.2
— double.3
— triple.4
— quadruple.5
— quintuple.6
— sextuple.
Whether it is a club room or not.
The possible values:
0
— not a club room.1
— a club room.
The bedroom number.
The possible values:
0
— undefined.1
— 1 bedroom.2
— 2 bedrooms.3
— 3 bedrooms.4
— 4 bedrooms.5
— 5 bedrooms.6
— 6 bedrooms.
Whether there is a balcony or not.
The possible values:
0
— no balcony.1
— a balcony.
The room view information.
The possible values:
0
— undefined.1
— bay view.2
— bosphorus view.3
— burj-khalifa view.4
— canal view.5
— city view.6
— courtyard view.7
— dubai-marina view.8
— garden view.9
— golf view.17
— harbour view.18
— inland view.19
— kremlin view.20
— lake view.21
— land view.22
— mountain view.23
— ocean view.24
— panoramic view.25
— park view.26
— partial-ocean view.27
— partial-sea view.28
— partial view.29
— pool view.30
— river view.31
— sea view.32
— sheikh-zayed view.33
— street view.34
— sunrise view.35
— sunset view.36
— water view.37
— with view.38
— beachfront.39
— ocean front.40
— sea front.
The hotel rating on a scale from 1
to 5
. Has the 0
value for no available rating.
- The minimum value is
0
. - The maximum value is
5
.
The list of amenities for the hotel selection based on a cumulative set of features from:
- All the hotels’ rates.
- And common hotels’ features.
To get all available room amenities and their definitions, use the serp_filters
field from the Retrieve hotel static data call.
Information about the hotel star certificate.
Applicable only for hotels in some specific countries.
Has the null
value if there is no information about the star certificate.
Information about how to pick up the hotel room keys.
The picking-up type.
The possible values:
unspecified
— no instructions.phone
— get the keys with a call. To get the instructions, call the phone number in thephone
field of this object.address
— get the keys on the address specified in theapartment_office_address
field of this object.smartlock
— get the keys in a smart lock. Can be opened with an app or code.keypad
— get the keys in a lock with a keypad.lockbox
— get the keys in a lock box.reception
— get the keys at the 24-hour reception.
The phone number for contacting purposes. The phone number must be valid.
- The minimum length is
5
characters. - The maximum length is
35
characters.
The hotel information.
The socket type.
The socket types.
To get all available socket types and their definitions, use the socket_types
field from the Retrieve hotel static data call.
The card types accepted at the hotel when pay there.
The possible values:
unspecified
— unspecified.american_express
— American Express.cash
— cash.china_unionpay
— China UnionPay.diners_club
— Diners Club International.euro_mastercard
— Euro/Mastercard.jcb
— JCB.maestro
— Maestro.mastercard
— Mastercard.switch_maestro
— Switch (Maestro).visa
— Visa.visa_debit
— Visa Debit.vise_delta
— Visa Delta.visa_electron
— Visa Electron.pro100
— Pro100.
Response example
{
"data": [
{
"address": "Katiet Bosua,South Sipora,Mentawai, Katiet",
"amenity_groups": [
{
"amenities": [
"Smoke-free property",
"Terrace"
],
"non_free_amenities": null,
"group_name": "General"
},
{
"amenities": [
"Free parking"
],
"non_free_amenities": null,
"group_name": "Parking"
},
{
"amenities": [
"Swimming pool"
],
"non_free_amenities": null,
"group_name": "Pool and beach"
}
],
"check_in_time": "12:00:00",
"check_out_time": "12:00:00",
"description_struct": [
{
"paragraphs": [
"Want to save money while travelling? It’s easy: hotel «Lances Right Villas Katiet» is located in Katiet. This hotel is located minutes away from the city center."
],
"title": "Location"
},
{
"paragraphs": [
"If you travel by car, you can park in a parking zone for free. Here, you can treat yourself with water procedures as there will be a pool."
],
"title": "At the hotel"
}
],
"hotel_chain": "No chain",
"id": 9852019,
"images_ext": [
{
"url": "https://cdn.worldota.net/t/{size}/content/7d/2d/7d2d97422f04ed0eecc63741b3d0ac9deec85904.jpeg",
"category_slug": "beach"
},
{
"url": "https://cdn.worldota.net/t/{size}/content/2f/6d/2f6d71c795e4e4c5d9afa357a58fefd7b6c6450c.jpeg",
"category_slug": "beach"
},
{
"url": "https://cdn.worldota.net/t/{size}/content/55/bb/55bb4eadf245d40f0302ceff22ae9bf17ee8ed56.jpeg",
"category_slug": "outside"
}
],
"kind": "Hotel",
"latitude": -2.37579,
"longitude": 99.84819,
"name": "Lances Right Villas Katiet",
"metapolicy_struct": {
"add_fee": [],
"check_in_check_out": [],
"children": [],
"children_meal": [],
"cot": [],
"deposit": [],
"extra_bed": [],
"internet": [],
"meal": [],
"no_show": {
"availability": "unspecified",
"day_period": "unspecified",
"time": ""
},
"parking": [],
"pets": [],
"shuttle": [],
"visa": {
"visa_support": "unspecified"
}
},
"metapolicy_extra_info": "To prevent the spread of the Mpox virus, the Indonesian Ministry of Health has resumed health screening for international travelers (both Indonesian and foreign nationals) entering Indonesia from August 27, 2024. This includes completing an electronic self-declaration form called SATUSEHAT Health Pass, which must be completed on a dedicated web platform.\n<ul> <li>There is no hot water on site. </li> </ul>",
"phone": "62-08126626702",
"policy_struct": [
{
"paragraphs": [
"Information about the type of meals included in the price is indicated in the rate details.",
"Meals may be limited during Ramadan."
],
"title": "Meals"
},
{
"paragraphs": [
"Couples checking into the same room must present a valid marriage certificate upon check-in. Otherwise, the property may reject the booking or request that a second room be booked."
],
"title": "Special living conditions"
},
{
"paragraphs": [
"To prevent the spread of the Mpox virus, the Indonesian Ministry of Health has resumed health screening for international travelers (both Indonesian and foreign nationals) entering Indonesia from August 27, 2024. This includes completing an electronic self-declaration form called SATUSEHAT Health Pass, which must be completed on a dedicated web platform.",
"<ul> <li>There is no hot water on site. </li> </ul>"
],
"title": "Extra info"
}
],
"postal_code": "25972",
"region": {
"country_code": "ID",
"iata": "",
"id": 965851524,
"name": "Katiet",
"type": "City"
},
"room_groups": [
{
"name": "Deluxe room ",
"images": null,
"images_ext": [],
"name_struct": {
"bathroom": "",
"bedding_type": "",
"main_name": "Deluxe room"
},
"room_amenities": [
"private-bathroom"
],
"room_group_id": 28,
"rg_ext": {
"balcony": 0,
"bathroom": 2,
"bedding": 0,
"bedrooms": 0,
"capacity": 0,
"club": 0,
"family": 0,
"floor": 0,
"quality": 6,
"class": 3,
"sex": 0,
"view": 0
}
},
{
"name": "Deluxe Double room full double bed",
"images": null,
"images_ext": [],
"name_struct": {
"bathroom": "",
"bedding_type": "full double bed",
"main_name": "Deluxe Double room"
},
"room_amenities": [
"private-bathroom"
],
"room_group_id": 130,
"rg_ext": {
"balcony": 0,
"bathroom": 2,
"bedding": 3,
"bedrooms": 0,
"capacity": 2,
"club": 0,
"family": 0,
"floor": 0,
"quality": 6,
"class": 3,
"sex": 0,
"view": 0
}
},
{
"name": "Deluxe Double room twin beds",
"images": null,
"images_ext": [],
"name_struct": {
"bathroom": "",
"bedding_type": "twin beds",
"main_name": "Deluxe Double room"
},
"room_amenities": [
"private-bathroom"
],
"room_group_id": 131,
"rg_ext": {
"balcony": 0,
"bathroom": 2,
"bedding": 4,
"bedrooms": 0,
"capacity": 2,
"club": 0,
"family": 0,
"floor": 0,
"quality": 6,
"class": 3,
"sex": 0,
"view": 0
}
},
{
"name": "Deluxe Suite ",
"images": null,
"images_ext": [],
"name_struct": {
"bathroom": "",
"bedding_type": "",
"main_name": "Deluxe Suite"
},
"room_amenities": [
"mirror",
"private-bathroom",
"safe",
"telephone",
"toiletries",
"towels"
],
"room_group_id": 65,
"rg_ext": {
"balcony": 0,
"bathroom": 2,
"bedding": 0,
"bedrooms": 0,
"capacity": 0,
"club": 0,
"family": 0,
"floor": 0,
"quality": 6,
"class": 5,
"sex": 0,
"view": 0
}
},
{
"name": "2 Bedrooms Deluxe Suite beachfront ",
"images": null,
"images_ext": [],
"name_struct": {
"bathroom": "",
"bedding_type": "",
"main_name": "2 Bedrooms Deluxe Suite beachfront"
},
"room_amenities": [
"mirror",
"private-bathroom",
"safe",
"telephone",
"toiletries",
"towels"
],
"room_group_id": 18395766,
"rg_ext": {
"balcony": 0,
"bathroom": 2,
"bedding": 0,
"bedrooms": 2,
"capacity": 0,
"club": 0,
"family": 0,
"floor": 0,
"quality": 6,
"class": 5,
"sex": 0,
"view": 38
}
},
{
"name": "2 Bedrooms Deluxe Double Suite beachfront full double bed",
"images": null,
"images_ext": [],
"name_struct": {
"bathroom": "",
"bedding_type": "full double bed",
"main_name": "2 Bedrooms Deluxe Double Suite beachfront"
},
"room_amenities": [
"mirror",
"private-bathroom",
"safe",
"telephone",
"toiletries",
"towels"
],
"room_group_id": 20591222,
"rg_ext": {
"balcony": 0,
"bathroom": 2,
"bedding": 3,
"bedrooms": 2,
"capacity": 2,
"club": 0,
"family": 0,
"floor": 0,
"quality": 6,
"class": 5,
"sex": 0,
"view": 38
}
}
],
"serp_filters": [
"has_parking",
"has_pool"
],
"star_certificate": {
"valid_to": "",
"certificate_id": ""
},
"facts": {
"electricity": {
"frequency": [
50
],
"voltage": [
230
],
"sockets": [
"c",
"f"
]
},
"kind": "",
"star_rating": 0,
"type": "",
"floors_number": 0,
"rooms_number": 0,
"year_built": 0,
"year_renovated": 0
}
}
],
"debug": {
"request": {
"ids": [
"hotel_1"
],
"hids": [
9852019
],
"language": "en"
},
"key_id": 1234,
"validation_error": null
},
"status": "ok",
"error": null
}
Errors
The error
field has the value specified in the headers below.
invalid_params
One or more input parameters are incorrect. For more details, see the response field debug validation_error.
no_content
An internal search error. Has 500
status code.