How can we help?
Follow
Search Hotels (Detail Level)

Overview

While making a search hotels request via the API, a mandatory field to include is DetailLevel.

The DetailLevel field is used to set the amount of details you will receive from the method HotelSearchRequest.

Possible Detail Levels

DetailLevel field in XML: Default, Low, Minimal, NoPackages, Meta, LowNoTax, MetaNoTax, NoPackagesNoTax, MetaExtended

DetailLevel field in JSON:

  • 0 = Default
  • 1 = Low
  • 2 = Minimal
  • 3 = NoPackages
  • 4 = Meta
  • 5 = LowNoTax
  • 6 = MetaAdvanced
  • 7 = MetaNoTax
  • 8 = NoPackagesNoTax
  • 9 = MetaExtended

Using the first three DetailLevels, Default, Low, or Minimalgets all data in the search results, and by using these options, there is no need to call GetPackages. Doing this is unrecommended as it is very resource consuming and bandwidth-heavy, as all the packages show up in the search results.

Difference between the different detail levels

Click any of the detail levels in order to get the list of the tags that will be returned upon request.

Default (0)

Default - Includes more detailed price breakdown, more package information, and full hotel information. Not Recommended because of the large response size. Will be blocked as from July 30, 2017, unless used in a single hotel ID context.

Breakdown of tags received:

  • Address
  • ChainCode
  • DefaultImage
  • FullSize
  • DisplayName
  • GeoLocation
  • Latitude
  • Longitude
  • ID
  • Packages
  • ContractId
  • HotelId
  • PackagePrice
  • Currency
  • FinalPrice
  • FinalPriceInSupplierCurrency
  • OriginalPrice
  • OriginalPriceInSupplierCurrency
  • SupplierCurrency
  • Refundability
  • Rooms
  • AdultsCount
  • Availability
  • Description
  • KidsAges
  • Price
  • RoomBasis
  • RoomBasisOriginal
  • RoomClass
  • RoomClassOriginal
  • RoomType
  • RoomTypeOriginal
  • SimplePrice
  • SupplierId
  • SupplierName
  • StarRating
Low (1)

Low - Includes less detailed price breakdown on the package, Simple (final) Price including VAT (Tax).
Please notice that by using this detail level, you won't be able to fetch room content.

Breakdown of tags received:

  • Address
  • ChainCode
  • DefaultImage: FullSize
  • DisplayName
  • Latitude
  • Longitude
  • ID
  • CityTax
  • PackageID
  • Refundability
  • Rooms
  • AdultsCount
  • Availability
  • RoomBasis
  • RoomClass
  • RoomType
  • SpecialDeals
  • SRSP
  • SimplePrice
  • Supplier short name
  • StarRating
Minimal (2)

Minimal - Same as Low, excluding the ChainCode and the supplier name of the package.

Breakdown of tags received:

  • Address
  • DefaultImage
  • FullSize
  • DisplayName
  • GeoLocation
  • Latitude
  • Longitude
  • ID
  • Packages
  • Refundability
  • Rooms
  • AdultsCount
  • Availability
  • RoomBasis
  • RoomClass
  • RoomType
  • SimplePrice
  • StarRating
No Packages (3)

NoPackages - Returns the minimum required hotel data.

Doesn't return any room information, only the lowest package price and highest package price per hotel, lowest and highest price including VAT (Tax). 

Breakdown of tags received:

  • Address
  • CityTax
  • DefaultImage: FullSize
  • DisplayName
  • Latitude
  • Longitude
  • HighestPackagePrice
  • ID
  • LowestPackagePrice
  • StarRating
Meta (4)

Meta  - Returns the minimum required hotel data.

Doesn't return any room information, only the lowest package price of each supplier per hotel, lowest price including VAT (Tax). 

Breakdown of tags received:

  • Address
  • DefaultImage: FullSize
  • DisplayName
  • GeoLocation
  • Latitude
  • Longitude
  • ID
  • StarRating
  • SuppliersLowestPackagePrices
  • Supplier short name (Key)
  • Price including Tax (Value)
Low No Tax (5)

LowNoTax - Includes less detailed price breakdown on the package, Simple (final) Price excluding VAT (Tax).
Please notice that by using this detail level, you won't be able to fetch room content.

Breakdown of tags received:

  • Address
  • ChainCode
  • DefaultImage: FullSize
  • DisplayName
  • Latitude
  • Longitude
  • ID
  • CityTax
  • PackageID
  • Refundability
  • Rooms
  • AdultsCount
  • Availability
  • RoomBasis
  • RoomClass
  • RoomType
  • SRSP
  • SimplePrice
  • Supplier short name
  • StarRating
Meta No Tax (7)

MetaNoTax  - Returns the minimum required hotel data.

Doesn't return any room information, only the lowest package price of each supplier per hotel, lowest price excluding VAT (Tax). 

Breakdown of tags received:

  • Address
  • DefaultImage: FullSize
  • DisplayName
  • GeoLocation
  • Latitude
  • Longitude
  • ID
  • StarRating
  • SuppliersLowestPackagePrices
  • Supplier short name (Key)
  • Lowest supplier price (Value)
No Packages No Tax (8)

NoPackagesNoTax - Returns the minimum required hotel data.

Doesn't return any room information, only the lowest package price and highest package price per hotel, lowest and highest price excluding VAT (Tax).

Breakdown of tags received:

  • Address
  • DefaultImage: FullSize
  • CityTax
  • DisplayName
  • Latitude
  • Longitude
  • HighestPackagePrice
  • ID
  • LowestPackagePrice
  • StarRating
MetaExtended (9)

MetaExtended - Returns the minimum required hotel and room data, and cheapest rate per hotel including VAT (Tax).

See attached "MetaExtended" for more info and examples.

Breakdown of tags received:

  • AvailableBoards
  • HasFreeCancellationOption
  • ID
  • Packages
  • ContractId
  • HotelId
  • PackagePrice
  • Currency
  • FinalPrice
  • FinalPriceInSupplierCurrency
  • OriginalPrice
  • OriginalPriceInSupplierCurrency
  • SupplierCurrency
  • Refundability
  • Rooms
  • AdultsCount
  • Availability
  • Description
  • KidsAges
  • Price
  • RoomBasis
  • RoomBasisOriginal
  • RoomClass
  • RoomClassOriginal
  • RoomType
  • RoomTypeOriginal
  • SimplePrice
  • SupplierId
  • SupplierName
  • PaymentType
  • PropertyType
  • RoomsKeywords

 

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments

[
Powered by Zendesk