Please note that Hotel Super Shopper no longer available for new customers. Information provided in the Universal API Help is currently for review purposes only.
You are here
HotelReqRsp.xsd
Hotel Super Shopper
The alpha release of Hotel Super Shopper offers streamlined Hotel Shopping functionality through Travelport Universal API. For Universal API client applications, travel providers now have the option to streamline the Hotel Shopping process by combining a property search with requests for detailed room and rate information in a single transaction.
Implementation by Provider
|
Provider |
Implementation |
|---|---|
| Galileo (1G) | Hotel Super Shopper is supported for Galileo. Please contact your Travelport representative for more information about accessing Hotel Super Shopper as an alpha customer. |
| Apollo (1V) | Hotel Super Shopper is supported for Apollo. Please contact your Travelport representative for more information about accessing Hotel Super Shopper as an alpha customer. |
| Worldspan (1P) | Hotel Super Shopper is not currently supported for Worldspan. |
Samples
See Hotel Super Shopper: Alpha Samples.
Schema
Two services support Hotel Super Shopper:
Request
- Enter the minimum required data in HotelSuperShopperReq.
- VendorLocation, which requests a specific hotel property using a unique property code (VendorLocationID). The VendorLocation @VendorCode and @VendorLocationID correspond to the codes used by the specified provider.
Note: Other HotelSearchLocation modifiers are not currently supported for Hotel Super Shopper.
- Check-in date (HotelStay @CheckinDate)
- Check-out date (HotelStay @CheckoutDate).
- Optional. Add optional hotel search modifiers to the Hotel Super Shopper request.
- @NumberOfAdults
The number of adult travelers in the booking. If no number is input, the number of travelers default to one Adult.- @NumberOfRooms
Requests hotel availability based on the number of rooms required for the itinerary. If no number is input, the number of rooms defaults to "1".- @MaxWait
The maximum wait time, in milliseconds, that Universal API waits for the response from a hotel supplier. Allows the client application to set the maximum wait time for a search. All rates returned for the requested hotel during the specified search duration are returned in the response.'
@NumOfRatePlans
Specifies the number of rate plans (if available) to be returned for the requested property. If empty, the response defaults to all available rate plans.@PreferredCurrency
If a three-character ISO/IATA currency code value is included in the request, the response returns conversion rates between the preferred currency and the hotel supplier's currency. A CurrencyRateConversion element in the response provides details about the conversion rates for the requested currency.
Response
Hotel Super Shopper returns room and rate data for a specific property in HotelSuperShopperRsp.
- Number of Rates (/HotelSuperShopperResults/HotelProperty @NumOfRatePlans)
The actual number of rate plan types (RatePlanType) returned in the response for that particular property. - Property Rates, Rules, and Details
These HotelSuperShopperResults element provide the details for a Hotel Rate and Rule Search response. Within HotelSuperShopperResults:
- HotelProperty identifies the available property, its address, and contact information.
- HotelDetailItem returns other supplier-generated information in regard to the hotel property.
- HotelRateDetail returns all rate plan types or booking codes associated with the property offered rates, as well as the rate plan description.
- Currency Rate Information
Currency rate information for the preferred currency can be applied to the rate conversion calculation.
Conversion rates can be used as a guideline to assist clients with Hotel Shopping and comparing multiple international locations and rate offers. Travelers and agents are able to shop using a familiar currency. And if multiple currencies are returned from hotel suppliers, the currency for all properties is normalized.
Notes:
While conversion rate information is supplied to assist with the shopping process, the booking still occurs in the currency used by the supplier.
HotelSuperShopper requests using v45 or newer do not return a currency conversion in the response at HotelSuperShopperRsp/CurrencyRateConversion. Please refer to the Currency Conversion topic for information on how to process the conversion.
If HotelSearchModifiers @PreferredCurrency contains a currency code value in the request, the response returns a CurrencyRateConversion child element of HotelSuperShopperRsp. Attributes of CurrencyRateConversion provide information about the preferred currency rates:
- @RateConversion is the conversion multiplier between the hotel's source currency and the requested (preferred) currency.
- @SourceCurrencyCode is the supplier's currency code, which is typically hotel property's local currency.
- @RequestedCurrencyCode is the preferred currency sent in the request in @PreferredCurrency.
- @DecimalPlace is the number of decimals applied to the preferred currency in @RequestedCurrencyCode.
Client applications can then apply their own calculation to the (local) source currency amount provided the hotel, and multiply by the conversion rate to obtain an approximate requested currency amount. If there is more than one source currency from the suppliers, multiple instances of CurrencyRateConversion are returned.
The following rules apply for the use of CurrencyRateConversion:
- When the requested value in @PreferredCurrency is the same as the currency provided by the hotel, CurrencyRateConversion is not returned.
- If the same currency conversion applies to multiple properties, Universal API returns only one instance of the rate conversion data.
- Currency conversion rates are based on daily updates. Each bank and system has different currency conversion rates that can change every minute. As a result, conversion rates provided by Travelport may not be the same as rates provided by another system. Also, the conversion rate at the time of settlement may not be same as the conversion rate that was returned during the initial Hotel Super Shopper request.
In HotelSuperShopperReq, HotelSearchModifiers PreferredCurrency="CHF".
In HotelSuperShopperRsp, rate multipliers are applied between the preferred (requested) currency of Swiss Francs (CHF) and the hotel property's source (local) currency. Because @VendorLocation allows global hotel properties to be requested in the search, this example shows conversion rates for three currencies in the same response.
<hotel:CurrencyRateConversion RateConversion="0.01" SourceCurrencyCode="INR" RequestedCurrencyCode="CHF" DecimalPlaces="2"/>
<hotel:CurrencyRateConversion RateConversion="0.98" SourceCurrencyCode="USD" RequestedCurrencyCode="CHF" DecimalPlaces="2"/>
<hotel:CurrencyRateConversion RateConversion="0.0015" SourceCurrencyCode="CLP" RequestedCurrencyCode="CHF" DecimalPlaces="2"/>
Important! Travelport provides conversion rates as a customer convenience. While Travelport makes every effort to keep conversion rates as accurate as possible, conversion rate multipliers are approximate. These rates are not guaranteed to be accurate, current, or sourced from an international bank.
Travelport is released from liability for miscalculations, rate conversion multiplier errors, or omissions. By consuming this currency conversion function, clients accept full responsibility for conversion rates and hotel pricing quotes for an approximate requested currency amount.
Travelport does not recommend that clients apply the hotel rate currency conversions from the Hotel Super Shopper response to other applications or to other Universal API workflows.
- Additional Properties
Requests for additional properties are not currently supported in Hotel Super Shopper. The NextResultReference token is not currently functional in HotelSuperShopperReq and HotelSuperShopperRsp.
- Additional Rate Plans
By default, a maximum of 99 rates plans are returned for each hotel property. If additional rate plans are available for a property, a More Rate indicator is returned (HotelProperty @MoreRates=”true”). An associated More Rates token (HotelProperty @MoreRateToken) can be used in a subsequent Hotel Rate and Rule Search request for a specified property (HotelDetailsReq/NextResultReference).
- QuickResponse
QuickResponse is not currently supported for Hotel Super Shopper, and is reserved for a future release.
Error and Warning Responses
Transaction-level error responses are returned in HotelSuperShopperRsp @ResponseMessage. Existing Hotel Search and Hotel Rate and Rule Search warning and error responses are also returned for Hotel Super Shopper as well.
If an invalid currency code is requested in HotelSearchModifiers @PreferredCurrency, a currency conversion rate is not returned. A warning message is returned: Preferred currency has been ignored, please enter a valid ISO currency code.
Next Steps
Follow-on requests for Hotel Super Shopper follow the standard Hotel transaction flow:
-
A subsequent Hotel Super Shopper request can be used to request for additional rates, if available, for one or more properties.
Using the existing response value from Property @MoreRatesToken, the subsequent HotelSuperShopper request uses the token in VendorLocation @MoreRatesToken. @ProviderCode, @VendorCode, and @VendorLocationID values for the property are also required.
Multiple instances of VendorLocation can be included in the follow-on Hotel Super Shopper search request to return additional rates for multiple properties in a single response.
Note: For best practice, keep the number of rates (@NumOfRates) in the initial Hotel Super Shopper request to 20 rates or less, and using the More Rates token to get more rates if needed.
- HotelRulesReq can be used to return additional rate rule details for the selected Rate Plan Type both before booking and after booking. Hotel Super Shopper (HotelSuperShopperRsp) and Hotel Rate and Rule Search responses (HotelDetailsRsp) may return abridged rule and policy information. So even though HotelRulesReq/Rsp is programmatically optional, it is strongly recommended to ensure that the traveler views all available rate information, such as cancellation, guarantee, and detail rate descriptions.
- HotelCreateReservationReq is used to book the hotel Rate Plan Type selected from the Hotel Super Shopper response.
- HotelMediaLinksReq can be used to request links for property images or media files.
