ETG API V3
B2B API
Hotel search
Look up rate

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.

ℹ️
To discuss a change to the permission of your API key, contact the API Support.

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

book_hash String required

The unique rate ID used to identify the selected rate.

ℹ️
  • Use this value in the book_hash field of the Order Booking Form call.
  • The value lifetime is 6 hours after you have got the rate from the search results.
language String optional

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

original_request_params [Object]

Information about the request parameters from the Hotelpage call.

checkin String
Check-in date, no later than 730 days from the day on which the request is made.
checkout String
Check-out date, no later than 30 days from checkin date.
residency String

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.

guests [Object]

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.
adults Int

The number of adult guests in one room.

ℹ️
  • The minimum value is 1.
  • The maximum value is 6.
children [Int]

The list of the children ages who will stay in the room.

ℹ️
  • The maximum age per child is 17 years.
  • The maximum number of children in the room is 4.
hotels [Object]

Information about the found hotel and its rates.

id String

The unique hotel ID.

ℹ️
  • Either this field or the hid field is required.
hid Int

The most preferred hotel ID.

ℹ️
  • Either this field or the id field is required.
  • The maximum length is 7 characters.
rates [Object]

List of available rates at the hotel.

allotment Int
Allotment.
amenities_data [String]

The room amenities list.

To get all available room amenities and their definitions, use the room_amenities field from the Hotel Static Data call.

any_residency Boolean
Whether or not the rate is allowed to be booked by the guest with any kind of residency. Should be used by the partners that do not collect the real guest’s residency.
book_hash String

The unique rate ID used to identify the selected rate.

ℹ️
  • Use this value in the book_hash field of the Order Booking Form call.
  • The value lifetime is 6 hours after you have got the rate from the search results.
daily_prices [Float]
Daily rate prices breakdown in the search currency.
deposit Object

The deposit information of the order. Has a value if the rate payment_types.type field has the hotel value.

amount Float
The deposit amount.
currency_code String
The deposit amount currency code. Is the same as the charged (hotel) currency code.
is_refundable Boolean
Whether the deposit is refundable or not.
match_hash String

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 String

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.

meal_data Object

The rate meals information.

value String

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.

has_breakfast Boolean
Whether breakfast is included to the rate or not.
no_child_meal Boolean
Whether the children meal is absent in the rate or not.
no_show Object

The no-show penalty information.

amount Float
The no-show penalty amount.
currency_code String
The no-show penalty amount currency code. Is the same as the charged (hotel) currency code.
from_time String
The time in the hotel timezone from which amount would be charged for the no-show penalty in the HH:MM:SS format.
payment_options Object

The accepted payment options with the specified amount to be charged.

For a booking, this amount in the requested currency should be paid.

payment_types String

Array with accepted payment option for the requested rate.

amount Float
Amount to be charged for the booking (in the contract’s currency - currency_code).
by String
Payment instrument.
cancellation_penalties String

Rate’s cancellation rules with commission information.

free_cancellation_before String

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.

policies String

Cancellation policies’ breakdown by time periods.

amount_charge Float
Cancellation penalty amount (in the charge/contract currency).
amount_show Float
Cancellation penalty amount (in the search currency).
commission_info [Object]

Commission information.

charge [Object]

Commission information (in the charge/contract currency).

amount_commission Float
Commission.
amount_gross Float
Gross price.
amount_net Float
Net price.
show [Object]

Commission information (in the search currency).

amount_commission Float
Commission.
amount_gross Float
Gross price.
amount_net Float
Net price.
end_at String

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.

start_at String

The date and time when this cancellation policy takes effect.

Has the null value, if it is in effect till the end_at field value.

The timezone is in UTC±0.

commission_info [Object]

Commission information.

charge [Object]

Commission information (in the charge/contract currency).

amount_commission Float
Commission.
amount_gross Float
Gross price.
amount_net Float
Net price.
show [Object]

Commission information (in the search currency).

amount_commission Float
Commission.
amount_gross Float
Gross price.
amount_net Float
Net price.
currency_code String
Amount’s currency. Is the same as the charged (contract’s) currency.
is_need_credit_card_data Boolean
Whether or not credit card information is needed.
is_need_cvc Boolean
Whether or not a CVC code is needed.
perks String

Additional service information: early check-in / late check-out.

early_checkin [Object]
charge_price Float
Additional service amount (in the charge/contract currency).
commission_info [Object]

Commission information.

charge [Object]

Commission information (in the charge/contract currency).

amount_commission Float
Commission.
amount_gross Float
Gross price.
amount_net Float
Net price.
show [Object]

Commission information (in the search currency).

amount_commission Float
Commission.
amount_gross Float
Gross price.
amount_net Float
Net price.
is_requested Boolean
Is requested.
show_price Float
Additional service amount (in the search currency).
time String
Additional service time.
late_checkout [Object]
charge_price Float
Additional service amount (in the charge/contract currency).
commission_info [Object]

Commission information.

charge [Object]

Commission information (in the charge/contract currency).

amount_commission Float
Commission.
amount_gross Float
Gross price.
amount_net Float
Net price.
show [Object]

Commission information (in the search currency).

amount_commission Float
Commission.
amount_gross Float
Gross price.
amount_net Float
Net price.
recommended_price String

The price below which the rate cannot be sold on b2c website. This price will be transferred only if you have signed an additional agreement with ETG, for details, you can contact your account manager. If the agreement is not signed, a null will be transferred.

amount Float
Amount of the deposit (in the hotel’s currency - currency_code).
currency_code String
Amount’s currency. Is the same as the charged (hotel’s) currency.
show_amount Float
Rate price in the requested (show_currency_code) currency (not necessarily the sum in the charged/payment currency).
show_currency_code String
Requested currency (not necessarily the charged/payment currency).
show_amount Float
Rate price in the requested (show_currency_code) currency (not necessarily the sum in the charged/payment currency).
show_currency_code String
Requested currency (not necessarily the charged/payment currency).
tax_data Object

Information about taxes in the rate.

taxes Object

List of taxes, information about which is available for these rates.

amount Float
Amount of the tax.
currency_code String
Currency in which the amount is specified.
included_by_supplier Boolean
Shows if the tax is included in the rate by the supplier; if the tax is not included, it is supposed to be paid at the hotel (in the specified currency).
name String

The ETG tax ID.

To get all available tax IDs and their definitions, use the taxes filed from the Hotel Static Data call.

type String

The payment type.

ℹ️
  • The possible values:

    • now. Use it to allow the user to pay for the booking via the ETG payment system:

      1. Request the Order Booking Form call and get the card details.
      2. 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.

    • deposit. Use it to allow you to charge the user bank card for the booking by yourself:

      1. You need to keep your ETG deposit sufficient. To increase funds, contact your account manager.
      2. The user makes a booking.
      3. You charge the user bank card.
      4. The ETG writes funds from your deposit by themselves during the reporting period.

      Every payment goes under a credit limit for the deposit.

vat_data Object

Information about VAT in the rate.

amount Float
Amount.
applied Boolean
Applied.
currency_code String
Currency code.
included Boolean
Whether or not VAT is included.
value Float
⚠️
DEPRECATED

The VAT amount in the currency of this object currency_code field value.

rg_ext Object

The hotel room type.

Use this field to get extra data on the room from the hotel static data. For example, room images, descriptions.

balcony Int

Whether there is a balcony or not.

ℹ️

The possible values:

  • 0—no balcony.
  • 1—a balcony.
bathroom Int

The room bathroom information.

ℹ️

The possible values:

  • 0—undefined.
  • 1—a shared bathroom.
  • 2—a private bathroom.
  • 3—an external private bathroom.
bedding Int

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.
bedrooms Int

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.
capacity Int

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.
class Int

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.
club Int

Whether it is a club room or not.

ℹ️

The possible values:

  • 0—not a club room.
  • 1—a club room.
family Int

Whether it is a family room or not.

ℹ️

The possible values:

  • 0—not a family room.
  • 1—a family room.
floor Int

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.
quality Int

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.
sex Int

The room gender restrictions.

ℹ️

The possible values:

  • 0—undefined.
  • 1—male.
  • 2—female.
  • 3—mixed.
view Int

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.
room_data_trans Object

Structured room name in the selected language.

bathroom String

The room bathroom information.

Has the null value, if it is a private bathroom.

bedding_type String
Room’s bedding information.
main_name String
Room name.
main_room_type String
Room name.
misc_room_type String
Additional room information.
legal_info Object

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.

hotel Object

The hotel legal information.

name String
The hotel legal name.
address String
The hotel legal address.
taxpayer_number String

The Taxpayer Personal Identification Number (INN) of the hotel.

ℹ️
  • The length is 10 characters.
state_registration_number String

The State Registration Number for Companies (OGRN) of the hotel.

ℹ️
  • The length is 13 characters.
work_time String
The hotel legal address working hours.
provider Object

The service provider legal information.

name String
The service provider legal name.
address String
The service provider legal address.
taxpayer_number String

The Taxpayer Personal Identification Number (INN) of the service provider.

ℹ️
  • The length is 10 characters.
state_registration_number String

The State Registration Number for Companies (OGRN) of the service provider.

ℹ️
  • The length is 13 characters.
room_name String
Room name in the selected language.
room_name_info Object
The optional object that may help resolve certain matching problems. To get access to the object, contact your account manager.
sell_price_limits Object

Information on the restrictions on the final selling price for the client.

If not null, the final selling price should be:

  • Within the min_price and max_price field values.
  • In the search currency.
max_price Float
Maximum final selling price for the client (in the search currency).
min_price Float
Minimum final selling price for the client (in the search currency).
serp_filters [String]
⚠️
DEPRECATED

The list of amenities at the hotel.

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
}
Prebook by SERP