Look up rate
https://api.worldota.net/api/b2b/v3/search/lookuprate/The call gets the only one rate you specified of a hotel in the Hotelpage format.
Request example
curl --location 'https://api.worldota.net/api/b2b/v3/search/lookuprate/' \
--header 'Content-Type: application/json' \
--data '{
"book_hash": "p-916eb51f-7e3c-4f7d-adde-cd2f551f173f",
"language": "en"
}'Request body
The unique rate ID used to identify the selected rate.
- Use this value in the
book_hashfield of the Order Booking Form call. - The value lifetime is 6 hours after you have got the rate from the search results.
The hotel data language.
- The default value is the contract language.
- The possible values:
ar—Arabic.bg–Bulgarian.cs–Czech.de–German.el–Greek.en–English.es–Spanish.fr–French.he–Hebrew.hu–Hungarian.it–Italian.ja–Japanese.kk–Kazakh.ko–Korean.nl–Dutch.pl–Polish.pt–Portuguese.pt_PT–Portuguese (Portugal).ro–Romanian.ru–Russian.sq–Albanian.sr–Serbian.th–Thai.tr–Turkish.uk–Ukrainian.vi–Vietnamese.zh_CN–Simplified Chinese.
Response
Information about the request parameters from the Hotelpage call.
The guests’ citizenship in the ISO 3166-1 alpha-2 format.
Use this field if there are doubts regarding the country or the hotel policy towards citizens.
The list of guests in the rooms.
In case of a multiroom search, for each room equal pax numbers are highly recommended for usage. If different pax numbers are required, we recommend that you make a separate request for each room.
- One list item represents one room.
- The maximum number of rooms per request is
9.
The number of adult guests in one room.
- The minimum value is
1. - The maximum value is
6.
Information about the found hotel and its rates.
The most preferred hotel ID.
- Either this field or the
idfield is required. - The maximum length is
7characters.
List of available rates at the hotel.
The room amenities list.
To get all available room amenities and their definitions, use the room_amenities field from the Hotel Static Data call.
The unique rate ID used to identify the selected rate.
- Use this value in the
book_hashfield of the Order Booking Form call. - The value lifetime is 6 hours after you have got the rate from the search results.
The deposit information of the order. Has a value if the rate payment_types.type field has the hotel value.
The match_hash field of the rate from the call made by the SERP mechanism.
Use this field if you are:
- Showing rates to the users from the call made by the SERP mechanism.
- Making a booking from these rates.
- Using this call response as actual data on the rate.
- Using this call response to actualize the exact rate from the calls made by the SERP mechanism.
Usage of this field can help the ETG collect analytics for SERP-HP matching.
The meal type in the rate.
To get all available meal types and their definitions, use the meals field from the Hotel Static Data call.
Has the nomeal value if no meal type is provided.
The rate meals information.
The meal type in the rate.
To get all available meal types and their definitions, use the meals field from the Hotel Static Data call.
Has the nomeal value if no meal type is provided.
The no-show penalty information.
The accepted payment options with the specified amount to be charged.
For a booking, this amount in the requested currency should be paid.
Array with accepted payment option for the requested rate.
Rate’s cancellation rules with commission information.
The date and time when the free cancellation policy expires.
Has the null value, if there is no free cancellation.
The timezone is in UTC±0.
Cancellation policies’ breakdown by time periods.
The date and time when this cancellation policy expires.
Has the null value, if it is in the time from the start_at field value till check-in.
If the start_at and end_at fields have the null value, this particular cancellation policy:
- Has no time restrictions.
- Is in effect all the time.
The timezone is in UTC±0.
Information about taxes in the rate.
List of taxes, information about which is available for these rates.
The ETG tax ID.
To get all available tax IDs and their definitions, use the taxes filed from the Hotel Static Data call.
The payment type.
- The possible values:
now. Use it to allow the user to pay for the booking via the ETG payment system:- Request the Order Booking Form call and get the card details.
- Request the Credit Card Data Tokenization call with the card details.
hotel. Use it to allow the user to pay for the booking upon check-in at the hotel. The user won’t be charged now.
The hotel room type.
Use this field to get extra data on the room from the hotel static data. For example, room images, descriptions.
The room bathroom information.
The possible values:
0—undefined.1—a shared bathroom.2—a private bathroom.3—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.
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.
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—sextuplet.
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.
Whether it is a club room or not.
The possible values:
0—not a club room.1—a club room.
Whether it is a family room or not.
The possible values:
0—not a family room.1—a family room.
The room floor Information.
The possible values:
0—undefined.1—a penthouse floor.2—a duplex floor.3—a basement floor.4—an attic floor.
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 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.
Structured room name in the selected language.
The hotel and service provider legal information.
Has the value different from null for only countries where it is mandatory to have this information.
Has the null value for the calls made by the SERP mechanism.
The hotel legal information.
The Taxpayer Personal Identification Number (INN) of the hotel.
- The length is
10characters.
The State Registration Number for Companies (OGRN) of the hotel.
- The length is
13characters.
The service provider legal information.
The Taxpayer Personal Identification Number (INN) of the service provider.
- The length is
10characters.
Response example
{
"data": {
"hotels": [
{
"id": "the_boston_park_plaza_hotel",
"rates": [
{
"book_hash": "p-916eb51f-7e3c-4f7d-adde-cd2f551f173f",
"match_hash": "m-99dcfac7-dab2-5697-a259-d26039a8b36a",
"daily_prices": [
"278.00",
"278.00"
],
"meal": "nomeal",
"meal_data": {
"value": "nomeal",
"has_breakfast": false,
"no_child_meal": true
},
"payment_options": {
"payment_types": [
{
"amount": "55933.00",
"show_amount": "556.00",
"currency_code": "EUR",
"show_currency_code": "EUR",
"by": null,
"is_need_credit_card_data": false,
"is_need_cvc": false,
"type": "deposit",
"vat_data": {
"included": false,
"applied": false,
"amount": "0.00",
"currency_code": "USD",
"value": "0.00"
},
"tax_data": {
"taxes": [
{
"name": "occupancy_tax",
"included_by_supplier": true,
"amount": "72.52",
"currency_code": "EUR"
},
{
"name": "resort_fee",
"included_by_supplier": false,
"amount": "80.00",
"currency_code": "USD"
}
]
},
"perks": {},
"commission_info": {
"show": {
"amount_gross": "556.00",
"amount_net": "556.00",
"amount_commission": "0.00"
},
"charge": {
"amount_gross": "55933.00",
"amount_net": "55933.00",
"amount_commission": "0.00"
}
},
"cancellation_penalties": {
"policies": [
{
"start_at": null,
"end_at": null,
"amount_charge": "55933.00",
"amount_show": "556.00",
"commission_info": {
"show": {
"amount_gross": "556.00",
"amount_net": "556.00",
"amount_commission": "0.00"
},
"charge": {
"amount_gross": "55933.00",
"amount_net": "55933.00",
"amount_commission": "0.00"
}
}
}
],
"free_cancellation_before": null
},
"recommended_price": null
}
]
},
"bar_rate_price_data": null,
"rg_ext": {
"class": 3,
"quality": 1,
"sex": 0,
"bathroom": 2,
"bedding": 3,
"family": 0,
"capacity": 2,
"club": 0,
"bedrooms": 0,
"balcony": 0,
"view": 0,
"floor": 0
},
"legal_info": {
"hotel": {
"name": "",
"address": "",
"taxpayer_number": "0000000000",
"state_registration_number": "0000000000000",
"work_time": "from 9-18 local time"
},
"provider": {
"name": "",
"address": "",
"taxpayer_number": "0000000000",
"state_registration_number": "0000000000000"
}
},
"room_name": "Wicked Small Double room (full double bed) (small)",
"room_name_info": null,
"serp_filters": [
"has_bathroom"
],
"sell_price_limits": null,
"allotment": 1,
"amenities_data": [
"small",
"non-smoking"
],
"any_residency": false,
"deposit": null,
"no_show": null,
"room_data_trans": {
"main_room_type": "Wicked Small Double room",
"main_name": "Wicked Small Double room",
"bathroom": null,
"bedding_type": "full double bed",
"misc_room_type": "small"
}
}
],
"bar_price_data": null
}
],
"original_request_params": {
"checkin": "2024-10-02",
"checkout": "2024-10-04",
"guests": [
{
"adults": 2,
"children": []
}
],
"residency": "ge"
}
},
"debug": {
"request": {
"book_hash": "p-805eb51f-7e3c-4f7d-adde-cd2f551f173f",
"language": "en"
},
"key_id": 1234,
"validation_error": null
},
"status": "ok",
"error": null
}