Look up rate
POST https://api.worldota.net/api/b2b/v3/search/lookuprate/ HTTP/1.1
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
Unique identifier of the rate. This value is passed to booking API method to identify a selected rate.
book_hash
key’s value can be transferred via the Order Booking Form method within 6 hours after the corresponding rate was returned in the search results. Exceeding this limit will return an error with error.slug
containing a “rate_not_found
” value.
The 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.
Guest’s (or multiple guests’) citizenship.
This is recommended for usage if there are doubts regarding a country’s/hotel’s policy towards citizens of a specific country.
Value’s standard = ISO 3166-1 alpha-2
, the value shall be transferred in lower case, number of the value’s symbols = 2
.
(could be required for some partners)
The list of guests in the rooms.
The maximum number of rooms per request, which is 9 (one object corresponds to one room).
In case of multiroom search, for each room equal pax numbers are highly recommended for usuge. If different pax numbers are required, we recommend that you make a separate request for each room.
Information about the found hotel and its rates.
The unique hotel identifier.
- Either this field or the
hid
field is required.
- Either this field or the
hid
field is required.
The most preferred hotel ID.
- Either this field or the
id
field is required. - The maximum length is
7
characters.
- Either this field or the
id
field is required. - The maximum length is
7
characters.
List of available rates at the hotel.
List of amenities in the room.
There is a request which returns all available room amenities and definitions (room_amenities key):
Unique identifier of the rate. This value is passed to booking API method to identify a selected rate.
book_hash
key’s value can be transferred via the Order Booking Form method within 6 hours after the corresponding rate was returned in the search results. Exceeding this limit will return an error with error.slug
containing a “rate_not_found
” value.
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.
Meal type in the rate.
There is a request which returns all available meals and definitions (meals
key):
https://api.worldota.net/api/b2b/v3/hotel/static/
If there is no meal type provided by the rate’s source, nomeal
value is displayed.
No-show penalty information.
Accepted payment options, with specified amount to be charged, transferred as an object with key-value pairs payment_options.payment_types
.
Please note that for a reservation, namely the specified sum (with the given currency) shall be paid.
Array with accepted payment option for the requested rate.
currency_code
).
Rate’s cancellation rules with commission information.
Date when free cancellation policy expires (may return null - no free cancellation).
Timezone is UTC+0.
Cancellation policies’ breakdown by time periods.
Date when this particular cancellation policy expires (null means all the time from start_at
till check in).
Timezone is UTC+0.
If start_at == end_at == null
then this particular cancellation policy has no time restrictions / is in effect all the time.
Information about taxes in the rate.
List of taxes, information about which is available for these rates.
Tax identifier at Emerging Travel Group.
There is a request which returns all available taxes and definitions (taxes
key):
Type of hotel room.
rg_ext
can be used to obtain extra information about the room from the hotel’s static information (room images, description etc.).
Structured room name in the selected language.
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",
"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
},
"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": 1304,
"validation_error": null
},
"status": "ok",
"error": null
}