Retrieve a list of hotels by location or a list of specific hotelIds.

This method can be used to return hotels with available rooms for a provided date range, or to return a list of all active properties within the specified location without any availability information.

This method supports multiple filters and methods of specifying the desired location to allow a variety of front-end search options, such as searching by airport code or a visualization on a map.

Request Formats
XML/REST URL: GET http://api.ean.com/ean-services/rs/hotel/v3/list?
XML Parent Element: <HotelListRequest>

Unique Protocol Requirements
REST
Request Parameters
Every search for available hotels requires a minimum of a date range, room count and adult guest count, and a location or hotelId list.

To obtain a "dateless list," or a list of all active properties in a location without specific availability information, simply omit the arrivalDate, departureDate, and RoomGroup parameters from your request.

Base Parameters
Name Value Required Description
apiExperience string yes

Use this attribute to identify the origin of your request. Choose an applicable value from the set provided below for each request you send.

Values:
PARTNER_CALL_CENTER - request from an agent in your call center
PARTNER_WEBSITE - request from a customer-facing website
PARTNER_MOBILE_WEB - request from a mobile-formatted website
PARTNER_MOBILE_APP - request from a mobile app
PARTNER_BOT_CACHE - request from a cache bot
PARTNER_BOT_REPORTING - request from a reporting bot
PARTNER_AFFILIATE - request from an API/platform that serves your own affiliate base

arrivalDate string yes for availability

Check-in date, in MM/DD/YYYY format.

Include today's date to request same-day availability. Bookings may be made up to 11:59PM local hotel time (9:59PM for PST and Pacific islands).

departureDate string yes for availability Check-out date, in MM/DD/YYYY format.

Availability can be searched up to 500 days in advance of this date.

Total length of stay cannot be greater than 28 nights.
numberOfResults int no Maximum number of hotels to return per response (before needing to page for additional results). Acceptable value range is 1 to 200. Default: 20

Does not limit results for a dateless list request.
RoomGroup object yes for availability Container for the Room arrays that define guest and room count. For REST, please see the section below.
RoomGroup.Room array yes for availability The number of Room nodes defines the number of rooms requested. Each node has its own adult/child guest count.

Properties allow up to 8 rooms per booking.
Room.numberOfAdults int yes for availability Adult guest count for the room.

Properties typically accommodate no more than 4 guests before incurring extra person fees.

Do not offer more than 8 guests per room, as results will not return above this guest count for most markets.
Room.numberOfChildren int yes if > 0 Child guest count for the room. Required for all properties. Used in combination with childAges to determine availability and rates.
Room.childAges comma-separated
list or array of int
yes if child count > 0 Send the individual ages of the children in the room as a comma-separated list for XML and REST and as an array of individual values for childAges for SOAP.

Always require this info from customers when child guests are specified. Unexpected extra person charges may result if children's ages are not provided prior to booking.
includeDetails boolean no

Returns per-room cancellation policies, bed types, and smoking preferences, when available.

includeHotelFeeBreakdown boolean no Returns the element HotelFeeBreakdown, which contains a more detailed response structure for the HotelFees array that includes how often each fee applies and how it is applied.
Room format for REST
The REST format compacts the values from the previous elements into a comma-delimited list. To declare a room and its occupants, use the following format:

&room[room number, starting with 1]=
[number of adults],
[comma-delimited list of children's ages]


For example, to declare that a room has one adult and two children ages 5 and 12, you would send &room1=1,5,12 . There is no separate declaration for the number of children - each age value is assumed to belong to a child.


Primary Search Methods
There are four primary methods available to limit the selection of hotels returned in the request, presented below in no particular order.
Three limit the selection by a defined location, and one allows an explicit set of hotels to be returned via a list of specific hotelIds.
Use only one of these methods at a time.


Method 1: City/state/country search
Name Value Required for search method Description
city string yes
City to search within. Use only full city names.
stateProvinceCode string yes for US,
CA, AU
Two character code for the state/province containing the specified city. For Australia, you must use the special codes provided below.

References:
US State Codes
Canadian Province/Territory Codes
Australian Province/Territory Codes
  • Australian Capital - AC
  • New South Wales - NW
  • Northern Territory - NO
  • Queensland - QL
  • South Australia - SA
  • Tasmania - TS
  • Victoria - VC
  • Western Australia - WT
countryCode string yes
Two character ISO-3166 code for the country containing the specified city. Use only country codes designated as "officially assigned" in the ISO-3166 decoding table.


Method 2: Use a free text destination string
Name Value Required for search method Description
destinationString string yes A string containing at least a city name. You can also send city and state, city and country, city/state/country, etc.

This parameter is the best option for taking direct customer input.

Ambiguous entries will return an error containing a list of likely intended locations.


Method 3: Use a list of hotelIds
Name Value Required for search method Description
hotelIdList comma-separated
list of long
yes Check for availability against a fixed set of hotels. Send desired hotelId values as a comma-delimited list

If no sort order is specified, hotels are sorted by EAN's default optimized algorithm. Use the sort option NO_SORT to retain the order of your list.

Any invalid hotelId values will be returned under the response header Invalid-Hotel-Ids as a comma-delimited list:
Vary: Accept-Encoding 
Content-Length: 1562
Avail-Source: 1
Invalid-Hotel-Ids: 1234,6645353
Transaction-Id: d85a243e-b61d-11e5-a89b-0b34b1565000
When using long lists, be aware that response times may increase noticably vs. smaller lists across multiple requests. Use POST instead of GET when sending long lists via REST. The absolute limit is 2500 hotel IDs per request.


Method 4: Search within a geographical area
Note: you can also use this method for searching for airports in conjunction with the airport coordinates file
Name Value Required for search method Description
latitude string yes Latitude coordinate for the search's origin point, in DD.MMmmm format.
longitude string yes Longitude coordinate for the search's origin point, in DDD.MMmmm format.
searchRadius int no Defines radius of a circular search area, with the provided latitude and longitude values defining the center.
Minimum of 1 MI or 2 KM, maximum of 50 MI or 80 KM. Values exceeding the maximum will automatically be reduced before results are returned.
Defaults to 20 MI.
searchRadiusUnit string no Sets the unit of distance for the search radius. Send
MI or KM. Defaults to MI if empty or not included.
sort string no You must send a value of PROXIMITY if you want the results to be sorted by distance from the origin point. Otherwise the default sort order is applied to any hotels that fall within the search radius.

See the full definition of this element in the next section for all available values.

Does not apply to results for a dateless list request.
Additional Search Methods
Offer these search methods as secondary options to allow customers to search via a nearby address or specific hotel.


Name Value Requires other parameters Description
address string yes Search nearby a local street address. The response will contain each property's proximity to the given address.

Even if a specific hotel's address is entered, its place in the default sort order will not be overridden if it is not already at the top.

Requires city and countryCode parameters to be defined.
postalCode string yes Optionally include an address' postal code.

Requires city and countryCode parameters to be defined.
propertyName string yes Name to search for availability. Value can be an exact name or part of a name, e.g. "Holiday" or "Best."

The response will contain any properties whose names contain the value included in this parameter.

If a specific property name is sent, an empty response may return if there is no availability for the given dates of stay.

Requires city and countryCode parameters to be defined.

Filtering Methods
These methods filter results via price, star ratings, and other typical shopping criteria. These can be offered prior to the initial search alongside a primary method, or used to dynamically update an existing search results page. They can also be used internally to limit results available to customers, e.g. restrict properties to a certain star level and above.

Name Value Required Description
includeSurrounding boolean no When sent as false, this parameter will exclude hotels outside of the area defined in your search parameters.
Use if you want to prevent hotels from other nearby cities or outlying areas from appearing in your results.
propertyCategory int or comma-delimited list of int no

Filters results by property category. Send either a single value or a list of values to return a combination of property categories.

Note:
these values do not correspond with categorizations in our static database files nor any other Expedia-supplied data.

Values:
1: hotel
2: suite
3: resort
4: vacation rental/condo
5: bed & breakfast
6: all-inclusive

maxStarRating float no Filters results by a maximum star rating.
Valid values are 1.0 - 5.0 in increments of 0.5.
minStarRating float no Filters results by a minimum star rating.
Valid values are 1.0 - 5.0 in increments of 0.5.
minRate float no Filters results by properties with rates equal to or greater than the provided value.
Searches against the averageRate response value (average of the individual nightly rates during the dates of stay). Valid for availability searches only.
maxRate float no Filters results by properties with rates equal to or less than the provided value.
Searches against the averageRate response value (average of the individual nightly rates during the dates of stay). Valid for availability searches only.
numberOfBedRooms int no This parameter is valid for condos/vacation rentals only. Specifies the number of bedrooms requested - 4 maximum.
maxRatePlanCount int no Defines the number of room types to return with each property.

Setting a higher value will attempt to return the corresponding number of room types at each property in the response, depending on individual property availabilities.

Defaults to 1, where the only the first room type at each property is returned. Under Expedia user testing, this value has been proven to provide the best conversion rates and is recommended to be left as-is, saving additional rooms for display during the room selection stage.

Sorting Options
We recommend sending initial searches without a specified sort order, as the default sort order is calculated to place the most preferred and best-converting properties at the top. Instead, allow customers to choose a different sort order after the initial list is returned.
Name Value Required Description
sort string no Sorting preference for properties returned.

Values:
DEFAULT

Sort optimised for profitability.

BUDGET

Sorts by profitability, giving preference to hotels at the budget end of each market. It places budget hotels with the most profitable look-to-book ratio at the top.

CHAMPION

Sorts by profitability, giving preference to hotels in the middle of each market. It places mid-range hotels with the most profitable look-to-book ratio at the top.

PREMIUM

Sorts by profitability, giving preference to hotels at the top end of each market. It places high-end hotels with the most profitable look-to-book ratio at the top.

PROMO Places properties with a promo rate or value add above properties not running promotions.
PRICE_AVERAGE Sorts properties by average nightly rate from low to high. The ordering is not perfect due to business/marketing office algorithms applied to property lists accessed by the API. Accurate price sorting is best achieved within your own code after results are received.
PRICE_REVERSE Sorts properties by nightly rate from high to low. Expect imperfect sort as detailed above.
QUALITY Sorts by property star rating from high to low.
QUALITY_REVERSE Sorts by property star rating from low to high.
PROXIMITY Sorts based on proximity to the origin point defined via latitude & longitude parameters.
TRIP_ADVISOR If you have an approved TripAdvisor integration, this value will sort results from high to low guest ratings.
NO_SORT Used only in conjunction with hotelIdList. Returns hotels in the exact order listed in the request.
HIGH_MARGIN

Based on the CHAMPION sort, HIGH_MARGIN sort goes a step further, giving preference to properties with the biggest margin percentage, ensuring properties with high conversion and big margins appear near the top. HIGH_MARGIN sort considers additional costs at a property level placing preference on margin percentage for the partner.

Additional Data Request

Use this parameter to limit the response to specific types of dynamic data. Typically used in conjunction with our hotel database files as sources of static information normally supplied by the API. Integrations that use this parameter in conjunction with offline databases will enjoy significantly faster response times than those that rely soley on API responses.

Name Value Required Description
options string or comma-separated
list of string
no Defines the type of limited data to return. Send a single value or a combination in a comma-separated list.

Values:
DEFAULT Returns all three data types below. Response will be the same as if options were omitted entirely.
HOTEL_SUMMARY

Returns dynamic hotel information with a small amount of identifying static information (hotel name and address, location description, hotelId, etc).
Does not contain dynamic rate information. The slimmest possible availability response.

ROOM_RATE_DETAILS Returns dynamic room rate information and a bare minimum of static information via hotelId and roomDescription.
Paging for More Hotels

If the initial response returns moreResultsAvailable as true, the next page of results can be requested via the below process.

To page for more results, only supplierType, cacheLocation and cacheKey may be sent in the subsequent availability request. All other non-common parameters must be omitted.

You must include the value supplierType=E in your request. If you do not include this value, moreResultsAvailable may erroneously return true when the list has already been exhausted.

Lastly, if an error stating "cacheLocation cannot be found" returns, the cache has expired and the original search must be requested again. Cached responses have a typical life of 15-30 minutes.

Refer to Paging for More Results for examples.


Name Type Required for method Description
supplierType string yes Must send with value E to allow paging system to accurately indicate additional results.
cacheKey string yes The key for the specific cached response requested. Use the value returned in the previous hotel list response.
cacheLocation string yes Defines the EAN server location of the requested cache. Use the value returned in the previous hotel list response.
Hotel List Response
Returns hotels in the specified location with rooms available for the provided guest count and dates of stay.

If a "dateless list" was requested via the omission of arrivalDate, departureDate and RoomGroup, the response contains all active hotels within the specified location without any specific availability information.

Response Content
Parent Element: HotelListResponse


Name Value Description
moreResultsAvailable boolean Indicates if there are more property results available to page.

If true, more results can be obtained via the paging process.
numberOfRoomsRequested int Confirms the number of rooms originally requested (number of Room nodes)
cacheKey string The key to the cache of the current response returned. Use this value in your next paging request.
cacheLocation string Defines the EAN server location of the cache for the current response returned. Use this value in your next paging request.
HotelList container for HotelSummary array

Container for individual properties, provided as an array of HotelSummary.

Attributes:
size string Indicates the number of individual properties provided in the response. Maximum of 200.
activePropertyCount string Indicates the total number of active (not necessarily available) properties in the specified location.

When a large number of total properties returns and additional results are paged, the activePropertyCount value will be reduced by each successive response until the total count is less than the per-response maximum of 200.

For example, if the initial response indicates size=200 and activePropertyCount=1454, paging for more results will return size=200 and activePropertyCount=1254, then size=200 and activePropertyCount=1054, etc., until size < 200.

HotelList.HotelSummary object Array of individual hotels. Info for each hotel result is contained in its own HotelSummary node.
Contains attribute order, which indicates the original numerical order of each hotel to help restore from dynamic re-sorting (sequence starts from 0, not 1).
HotelSummary.hotelId long ID for the property. This same ID will be used in any subsequent room or reservation requests.
HotelSummary.name string Name of the hotel
HotelSummary.address1 string Hotel street address
HotelSummary.address2 string Optional additional address information
HotelSummary.city string Hotel city
HotelSummary.stateProvinceCode string Two character code for the state/province containing the specified city. Returns only for US, CA, and AU country codes.

References:
US State Codes
Canadian Province/Territory Codes
Australian Province/Territory Codes
HotelSummary.countryCode string Two character ISO-3166 code for the country the hotel is located in
HotelSummary.postalCode string Postal code for the hotel
HotelSummary.airportCode string Airport code associated with the hotel
HotelSummary.supplierType string Supplier of the hotel. This same supplier will be used to process any reservations placed.

Values:
E: Expedia Collect
HotelSummary.propertyCategory string The category of the property returned.

Values:
1: hotel
2: suite
3: resort
4: vacation rental/condo
5: bed & breakfast
6: all-inclusive
HotelSummary.hotelRating float Star rating (0-5) of the hotel. A value of 0.0 or a blank value indicate none is available.
HotelSummary.hotelRatingDisplay string Returns Star or Alternate to indicate the source and required display type for the hotelRating value.

Currently, only points of sale in Australia must follow the provided display indicators. Additional jurisdictions will be added in the future.

Star indicates the rating is provided by the hotel's local star rating authority. Use stars to display hotelRating.

Alternate indicates hotelRating is an Expedia-assigned value; an official rating was not available. Use an alternate display, e.g. circles or squares, to indicate it is not an official rating from a local authority.

Returns for minorRev=30 and above only.
HotelSummary.shortDescription string Short description text entered by the property. Truncated if entry exceeds 200 characters.
For better performance, add an ellipsis (…) to the end of this value and set it to link to the property's room availability page.
HotelSummary.locationDescription string General location as entered by the property, e.g. "Near Pike Place Market"
HotelSummary.lowRate string Do not use this field. This value is no longer maintained.
HotelSummary.highRate string Do not use this field. This value is no longer maintained.
HotelSummary.rateCurrencyCode string Currency code of the high or low rates returned.
HotelSummary.latitude float Latitude coordinate for the hotel.
HotelSummary.longitude float Longitude coordinate for the hotel.
HotelSummary.proximityDistance float The distance of the hotel from the originally specified origin coordinates, if that search method was used.
HotelSummary.proximityUnit string Unit for the distance provided by proximityDistance. MI or KM.
HotelSummary.hotelInDestination boolean Indicates whether the property is within the originally specified city or in an expanded area, i.e. a major suburb or other nearby city.

Hotels outside of the destination are grouped by distance from the original area, e.g. under 10 miles away, under 20 miles away, etc.
HotelSummary.thumbNailUrl string URL path of a thumbnail image of the property, if provided.

Full URLs are not returned. Append this value with http://media.expedia.com. HTTPS with SSL is supported.
string Deprecated. Do not use any values returned.
HotelSummary.RoomRateDetailsList container for RoomRate
Details
array
Container only, no attributes. Holds all room-specific element data.
RoomRateDetailsList.RoomRateDetails array Contains the details for the first room returned by the hotel. Additional nodes for each additional room returned if maxRatePlanCount value was sent >1
RoomRateDetails.roomTypeCode string Room type code for the room.
RoomRateDetails.rateCode string Code to the displayed rate.
RoomRateDetails.maxRoomOccupancy int Maximum number of guests the room can accommodate, including guests who may incur extra person fees.
RoomRateDetails.quotedRoomOccupancy int Maximum number of guests the room can accommodate without incurring extra person fees.
RoomRateDetails.minGuestAge int Minimum guest age allowed in the room
RoomRateDetails.roomDescription string Description of the room associated with the roomTypeCode returned
RoomRateDetails.promoId string ID for the promo offer returned, if any. Under REST, this value returns as an integer.
RoomRateDetails.promoDescription string Description for the promo returned, if any. Max of 255 chars will return.
RoomRateDetails.promoDetailText string Extra details for the promo returned, if any.
RoomRateDetails.currentAllotment int The number of bookable rooms remaining at the property. Use this value to create rules for urgency messaging to alert users to low availability on busy travel dates or at popular properties.

If the value returns as 0, it does not indicate a lack of rooms at the property. The rules needed to calculate the value were simply not met - this value does not indicate absolute availability.
RoomRateDetails.propertyAvailable boolean For internal inventory reference only.
|Only available inventories will return on standard requests.
RoomRateDetails.propertyRestricted boolean For internal inventory reference only. Refer to cancellation policy for any specific restrictions.
RoomRateDetails.expediaPropertyId string Expedia's ID for the hotel. Use this value to map to a hotelId when cross-referencing to Expedia.
RoomRateDetails.BedTypes array The bed type choices for the individual room. May return a single bed type or a choice to include at booking time. Review details for bed types

Returns only if includeDetails=true was sent in the request.
RoomRateDetails.smokingPreferences comma-separated list of string Available smoking preferences for the room, if any.

Values:
NS: non-smoking
S: smoking
E: either

Returns only if includeDetails=true was sent in the request.
RoomRateDetails.ValueAdds container for ValueAdd Contains an array of ValueAdd elements, if available, for the provided room and rate. Has a size attribute to indicate the number of value adds returned.
ValueAdds.ValueAdd array

Contains a description element for a free service offered with the provided room and rate, such as free breakfast or wireless internet.

For minorRev=28 and 29, the numerical id attribute will not return – only description is provided.

For minorRev=30, the numerical id attribute returns with a different set of values from those returned for 26 and below. Both sets of values are available on our value adds reference page.

RoomRateDetails.RateInfos container for RateInfo Contains an array of RateInfo elements that provide detailed rate information for individual rooms.

If you are using an older integration running on minorRev=6 or earlier, RateInfo will return without the RateInfos container.

RateInfos.RateInfo object Contains all rate information for a single room within several different objects and individual values.

Attributes:
priceBreakdownboolean Indicates if a full price breakdown including taxes and total price to be charged is included.
promo boolean Indicates if the rate returned is a promotional rate.
rateChange boolean Indicates if the rate is different for at least one of the nights during the stay.
RateInfo.promoId string ID for the promo offer returned, if any.
RateInfo.promoDescription string Description for the promo returned, if any. Max of 255 chars will return.
RateInfo.promoDetailText string Extra details for the promo returned, if any.
RateInfo.currentAllotment int The number of bookable rooms remaining at the property. Use this value to create rules for urgency messaging to alert users to low availability on busy travel dates or at popular properties.

If the value returns as 0, it does not indicate a lack of rooms at the property. The rules needed to calculate the value were simply not met - this value does not indicate absolute availability.
RateInfo.cancellationPolicy string Hotel's cancellation policy for this room. Must display on individual room pages as well as any booking and booking confirmation pages.
Returns only if includeDetails=true was sent in the request.
RateInfo.CancelPolicyInfoList container for Cancel
PolicyInfo
Details specifics of the cancellation policy, typically the times determining the penalty period and the penalties incurred for cancellation.
Returns only if includeDetails=true was sent in the request.
RateInfo.rateType string Indicates if the rate returned is prepaid via EAN or post-paid at the hotel. Either returns with a value of MerchantStandard for prepaid availability, or does not return at all for post-paid.
RateInfo.nonRefundable boolean Indicates explicitly if the reservation can be refunded or not after booking. Should also be indicated within the cancellation policy returned. This value always takes precedence over any differing policy data.
Returns only with availability.
RateInfo.promoType string Indicates whether any promos returned are mobile-specific or standard promotions. Returns Mobile for mobile promotions and Standard for all others.
In order to return mobile promotions, you must identify your mobile site or app via the proper customerUserAgent string.
RateInfo.ChargeableRateInfo object This object's attributes contain the absolute total to be charged for the reservation as well as rate averages and totals. Nodes within the object provide details on individual nightly rates and surcharges.

Attributes:
total string The total of all nightly rates, taxes, and surcharges to be charged for the reservation. This is the total value that must be displayed to the customer and included in the booking request.
surchargeTotal string Total of TaxAndServiceFee and ExtraPersonFee from the Surcharges array.
nightlyRateTotal string Total of all values in the nightlyRatesPerRoom array contained within this object.
maxNightlyRate string Highest nightly rate of all rates returned
currencyCode string Currency code for the rates returned
commissionableUsdTotal string Amount used to calculate partner commissions, in USD. Total of nightly rates less surchages.
averageRate string Average of all nightly rates with any promo values applied, without surcharges.
averageBaseRate string Average of all nightly rates without any promo values applied, without surcharges.Will return the same as previous value if no promos present.
ChargeableRateInfo.
nightlyRatesPerRoom
array Container for NightlyRate array. Has size attribute to indicate number of nodes in the array, which will correspond to the number of nights in the request. Rates return in sequential order across the duration of the stay.
nightlyRatesPerRoom.
NightlyRate
n/a

Provides the rate for a single night within the span of the requested stay.

Indicates the presence of a promo rate, the base rate, and the rate after the promo is applied (if applicable). Contains attributes only.

For multi-room requests, this value is the average of the per-night cost across all rooms. EAN recommends using the new per-room ChargeableNightlyRates array for multi-room price display.

For multi-room requests under minorRev=28 and below, this element provides rates for the first room only, instead of an average rate.

Attributes:

promo boolean Indicates if a promo rate is applied for this night's rate.
rate string The nightly rate after the promo, if any, is applied.
baseRate string The nightly rate before the promo, if any, is applied.
ChargeableRateInfo.Surcharges array Container for Surcharge array. This array itemizes the individual surcharges that make up the value returned for surchargeTotal. Has size attribute to indicate number of nodes in the array.
Surcharges.Surcharge n/a Details a single surcharge's amount and type. Contains attributes only.

Attributes:
amount float Amount of the specific surcharge
type string Name of the surcharge.
Possible values:
  • TaxAndServiceFee
  • ExtraPersonFee
  • Tax
  • ServiceFee
  • SalesTax
  • HotelOccupancyTax

Only TaxAndServiceFee and ExtraPersonFee contribute toward surchargeTotal. All other values are individual components of the TaxAndServiceFee value.


Note: the SalesTax and HotelOccupancyTax surcharge types must be displayed by state law in New York. Ensure you expect and capture these values to display as "Hotel Occupancy and Sales Tax" in the final price breakdown.
RateInfo.rateType string Indicates if the rate returned is prepaid via EAN or post-paid at the hotel. Either returns with a value of MerchantStandard for prepaid availability, or does not return at all for post-paid.
RateInfo.HotelFees array

This element breaks out certain taxes and fees collected by the hotel that are otherwise not specifically detailed in the Surcharges array.

All values within this element are charged by the hotel upon check in or checkout. They are not part of any charges collected at booking time.

When populated, use this element to meet the rate/tax/fee display format required by major search engines and aggregators.

Contains size attribute to indicate the number of charges contained.

Please note the child element HotelFeeBreakdown must be specifically requested

HotelFees.HotelFee none Contains attributes for the description, amount, and currency of a single fee. Details any VAT, state/city tax, resort fees, or any other fees collected that cannot be reasonably avoided.
Charges return in the bookable currency indicated by the currencyCode attribute of ChargeableRateInfo.

Attributes:
description string The type of charge. Possible values:
  • MandatoryFee
  • MandatoryTax
  • ResortFee
amount string Total value for the charge.
HotelFee.HotelFeeBreakdown none Returns if includeHotelFeeBreakdown was sent in the request. Details how the fee provided in HotelFee is applied and how often it applies.

Note: All HotelFee amount values are totals. Do not be multiply them by any frequency provided here.

You may divide by the amount as indicated by frequency to obtain nightly/daily/weekly charges if desired.

Attributes:
unit string How the fee is distributed. Possible values:
  • Per Person
  • Per Room
  • Per accommodation
  • Per house
  • Per apartment
  • Per adult
frequency string Frequency of the fee. Possible values:
  • Per Night
  • Per Day
  • Per Stay
  • Per week
ConvertedRateInfo object Rate information converted to the customer's requested currency. Returned only if the requested currency is non-billable by the hotel or within the customer's market region. Contains the same attributes as ChargeableRateInfo.
RoomGroup object Confirms the contents of the same RoomGroup object sent in the request as they apply to the rates provided.

For minorRev=29 and higher, contains per-room nightly rate details.
RoomGroup.Room array Confirms the room's values for numberOfAdults, numberOfChildren, and childAges as provided in the original request.
Room.rateKey string Key to the rate and parameters determining the rate.

Every time search parameters are changed (guest count change, different dates of stay, adding children, etc) a new request must be sent to obtain a new value for this parameter.
Room.ChargeableNightlyRates array Container for NightlyRate array for the room. Rates returned are specific to the individual room and return in sequential order across the duration of the stay.

For an average per-night cost across multiple rooms, use the values provided by nightlyRatesPerRoom.

Returns for minorRev=29 and higher.
ChargeableNightlyRates.
NightlyRate
object Provides the rate for a single night within the span of the requested stay. When returned within this location, rates are always specific to the containing Room.

Indicates the presence of a promo rate, the base rate, and the rate after the promo is applied (if applicable). Contains attributes only.

Returns for minorRev=29 and higher.

Attributes:
promo boolean Indicates if a promo rate is applied for this night's rate.
rate string The nightly rate after the promo, if any, is applied.
baseRate string The nightly rate before the promo, if any, is applied.
ChargeableNightlyRates.
ConvertedNightlyRates
object Rate information converted to the customer's requested currency. Returned only if the requested currency is non-billable by the hotel or within the customer's market region. Contains the same attributes as ChargeableNightyRates. Returns for minorRev=29 and higher.
CachedSupplierResponse


The CachedSupplierResponse element is returned when a cached hotel list response is provided.

Attributes for the CachedSupplierResponse element:
Name Value Description
cachedSupplierResponse object Contains information about cached data, internal use. Returned only with cached responses.
cacheEntryHitNum int Internal
cacheEntryMissNum int Internal
cacheEntryExpiredNum int Internal
cacheRetrievalTime long Cache retrieval time.
supplierRequestNum int Number of results requested from the supplier
supplierResponseNum int Number of results returned from the supplier
supplierResponseTime long How fast the supplier returned the results
candidatePrepTime long Time to determine or prepare the request list of properties.
tpidUsed int Internal identifier based on currency and locale.
matchedCurrency boolean Returns either matched or converted (extrapolated) data from the cache .
matchedLocale boolean Returns either matched or translated data from the cache.
extrapolatedCurrency boolean Returns either matched or converted (extrapolated) data from the cache. (The results are cached in English and USD from the supplier, but converted to the requested currency and language at the time of request)
extrapolatedLocale boolean Returns either matched or translated data from the cache.