Enhanced Shopping (EST) – Detailed Rate Information

Overview

The Enhanced Shopping Transaction (EST) API provides detailed room and rate information for multiple properties, supporting up to 200 properties in a single transaction. The returned data includes:

Room and rate descriptions
Pricing information
Policies and Restrictions

In addition to these core features, the EST API supports advanced functionalities such as:

Negotiated rate processing
User-specified timeouts
Multipart responses
Support for multiple languages

While these advanced features enhance the flexibility and functionality of the API, they are not mandatory for a basic implementation. Details about each feature are outlined in the sections below:

Simple Example

The following is a simple request for 1 adult and 2 children staying between 1-4 September. The example just contains two properties, although up to 200 are supported.

Note: The VersionCompliance (=Enhanced_V1) attribute must always be sent to indicate that this is the ‘enhanced shopping’ request

<HotelML xmlns="http://www.xpegs.com/v2001Q3/HotelML">
<Head>
<Process DataPath="/HotelML/Form/MultiAvailability" Function="TI_MultiAvailabilityV1_1" Token="1273480445698"/>
<Route Destination="00" Source="01" RequestedAccuracy="CacheOrSource"/>
</Head>
<Form>
<MultiAvailability>
<Property xml:lang="en" Code="UI;12345"/>
<Property xml:lang="en" Code="UI;61829"/>
<RateCriteria VersionCompliance="Enhanced_V1" NumberOfRooms="1">
<GuestCount Type="Adult" Count="1"/>
<GuestCount Type="Child" Count="2"/>
<DateRange InDate="2011-09-01" OutDate="2011-09-04"/>
</RateCriteria>
</MultiAvailability>
</Form>
</HotelML>

The response message shown below includes the available rooms and rates for the two requested properties. As the amount of information returned will vary by property, the first property (UI;12345) is an example of fairly comprehensive information, while the second property (UI;61829) is less detailed.

<HotelML xmlns="http://www.xpegs.com/v2001Q3/HotelML">
<Head>
<Route Destination="01" Source="00">
<Operation Action="Create" App="TIDispatcher" AppVer="1.12.40.2.8.1.20.4.2.7.12.1.12.2.2.1.8.1.2.6" DataPath="/HotelML" StartTime="2011-06-
07T13:28:36.475+00:00" Success="true" TotalProcessTime="5854"/>
</Route>
</Head>
<Property xml:lang="en" Code="UI;12345" AvailabilityStatus="Open" DataAge="2011-06-
07T13:28:42.325+00:00" DataOrigin="Source">
<Rate>
<RatePlan Code="013A" CommissionableStatus="Commissionable" Description="BEST FLEXIBLE RATE " InDate="2011-09-01" OutDate="2011-09-04" RequestedRatePlanCode="RAC" Status="Open" TaxInformation="INCLUDED" CredentialsRequired="true">
<Amenity xml:lang="en" Code="BRKFST" Room="true"/>
<RoomType BookableRate="165.00" TaxQualifier="Unknown" Code="1DN" NativeCurrency="GBP" RateChange="true" RateFrequency="Daily" RoomDescription="1 DOUBLE BED
ENSUITE NONSMOKING " TotalRateInclusive="570.00" TotalRateInclusiveCharges="600.00"
TotalTaxes="100.00" TotalSurcharges="30.00" NumberOfPayingGuestsPerRoom="1" NumberOfChildren="2" NumberOfBeds="1" BedType="Double" RoomCategory="Superior" RateCategoryMatchType="Alternative" RoomCountMatchType="Available" AdultCountMatchType="Allowed" ChildCountMatchType="Allowed" BedMatchType="Requested" CribMatchType="Available">
<CommissionPolicy Description="COMMISSIONABLE RATE" Percentage="7.00"/>
<GuaranteePolicy LateArrivalTime="16:00:00.000" Required="true">
<GuaranteeMethod Code="5"/>
</GuaranteePolicy>
<CancelPolicy Date="2010-06-30" Time="16:00:00.000" PenaltyPercentage="50.00" PercentageQualifier="FullStay"/>
<Amenity Code="INTCMP" Description="COMPLIMENTARY INTERNET ACCESS"
ExtraCharge="false"/>
<RateChange Date="2010-07-01" Charge="165.00" Currency="GBP"/>
<RateChange Date="2010-07-03" Charge="120.00" Currency="GBP"/>
<ExtraPerson Type="Child" Charge="10.00"/>
<ExtraBed Type="Crib" Charge="5.00"/>
</RoomType>
</RatePlan>
<RatePlan Code="T78B" CommissionableStatus="Commissionable" Description="ADVANCE PURCHASE NO REFUNDS " InDate="2011-09-01" OutDate="2011-09-04" RequestedRatePlanCode="PRO" Status="Open" TaxInformation="INCLUDED" NonRefundableStay="true">
<Amenity xml:lang="en" Code="BRKFST" Room="true"/>
<RoomType BookableRate="149.00" Code="1DN" NativeCurrency="GBP" RateChange="true" RateFrequency="Daily" RoomDescription="1 DOUBLE BED ENSUITE NONSMOKING " TotalRateInclusive="515.00">
<CommissionPolicy Description="Commissionable rate" Amount="105.75"/>
<DepositPolicy Required="true" Amount="596.00" IntervalUnits="Days" TimeInterval="7" IntervalOffsetType="BeforeArrival">
<GuaranteeMethod Code="5"/>
<GuaranteeMethod Code="19"/>
</DepositPolicy>
<CancelPolicy Time="16:00:00.000"/>
</RoomType>
</RatePlan>
</Rate>
</Property>
<Property xml:lang="en" AvailabilityStatus="Open" DataAge="2011-06-07T13:28:42.325+00:00"
DataOrigin="Source" Code="UI;61829">
<Rate>
<RatePlan Code="A66" CommissionableStatus="NonCommissionable" Description="Fall Back
Brazil" InDate="2011-09-01" Indicator="BusinessStandard" MarketingText1="ACCESS TO OVER 3000
UTELL HOTELS WORLDWIDE." OutDate="2011-09-04">
<BookingRequirement MinimumStayRequired="true"/>
<RoomType BookableRate="215.20" Code="C2D" NativeCurrency="USD" RateChange="true" RateFrequency="Daily" RoomDescription="Cozy Double Double - A Comfortable Room" TotalRate="685.60" TotalRateInclusive="797.23">
<GuaranteePolicy Required="true"/>
<CancelPolicy IntervalUnits="Days" TimeInterval="1"/>
<Amenity xml:lang="en" Code="NSMK" Confirmable="true" Room="true"/>
</RoomType>
<RoomType BookableRate="215.20" Code="B1K" NativeCurrency="USD" RateChange="true"
RateFrequency="Daily" RoomDescription="King Superior - An Inviting Room" TotalRate="685.60" TotalRateInclusive="797.23">
<GuaranteePolicy Required="true"/>
<CancelPolicy IntervalUnits="Days" TimeInterval="1"/>
<Amenity xml:lang="en" Code="NSMK" Confirmable="true" Room="true"/>
</RoomType>
<RoomType BookableRate="231.20" Code="B2D" NativeCurrency="USD" RateChange="true"
RateFrequency="Daily" RoomDescription="Superior Double Double - An Inviting Room" TotalRate="733.60" TotalRateInclusive="852.31">
<GuaranteePolicy Required="true"/>
<CancelPolicy IntervalUnits="Days" TimeInterval="1"/>
<Amenity xml:lang="en" Code="NSMK" Confirmable="true" Room="true"/>
</RoomType>
<RoomType BookableRate="231.20" Code="A1K" NativeCurrency="USD" RateChange="true" RateFrequency="Daily" RoomDescription="King Deluxe -A Luxurious Room" TotalRate="733.60" TotalRateInclusive="852.31"><GuaranteePolicy Required="true"/>
<CancelPolicy IntervalUnits="Days" TimeInterval="1"/>
<Amenity xml:lang="en" Code="NSMK" Confirmable="true" Room="true"/>
</RoomType>
<RoomType BookableRate="247.20" Code="A2D" NativeCurrency="USD" RateChange="true" RateFrequency="Daily" RoomDescription="Deluxe Double Double - A Luxurious Room" TotalRate="781.60" TotalRateInclusive="907.39">
<GuaranteePolicy Required="true"/>
<CancelPolicy IntervalUnits="Days" TimeInterval="1"/>
<Amenity xml:lang="en" Code="NSMK" Confirmable="true" Room="true"/>
</RoomType>
</RatePlan>
<RatePlan Code="LV0" CommissionableStatus="Commissionable" Description="Best Available
Rate" InDate="2011-09-01" Indicator="BusinessStandard" MarketingText1="ACCESS TO OVER 3000
UTELL HOTELS WORLDWIDE." OutDate="2011-09-04">
<BookingRequirement MinimumStayRequired="true"/>
<RoomType BookableRate="269.00" Code="C2D" NativeCurrency="USD" RateChange="true" RateFrequency="Daily" RoomDescription="Cozy Double Double - A Comfortable Room" TotalRate="857.00" TotalRateInclusive="993.91">
<GuaranteePolicy Required="true"/>
<CancelPolicy IntervalUnits="Days" TimeInterval="1"/>
<Amenity xml:lang="en" Code="NSMK" Confirmable="true" Room="true"/>
</RoomType>
<RoomType BookableRate="289.00" Code="B2D" NativeCurrency="USD" RateChange="true" RateFrequency="Daily" RoomDescription="Superior Double Double - An Inviting Room" TotalRate="917.00" TotalRateInclusive="1062.76">
<GuaranteePolicy Required="true"/>
<CancelPolicy IntervalUnits="Days" TimeInterval="1"/>
<Amenity xml:lang="en" Code="NSMK" Confirmable="true" Room="true"/>
</RoomType>
<RoomType BookableRate="289.00" Code="A1K" NativeCurrency="USD" RateChange="true"
RateFrequency="Daily" RoomDescription="King Deluxe -A Luxurious Room" TotalRate="917.00" TotalRateInclusive="1062.76">
<GuaranteePolicy Required="true"/>
<CancelPolicy IntervalUnits="Days" TimeInterval="1"/>
<Amenity xml:lang="en" Code="NSMK" Confirmable="true" Room="true"/>
</RoomType>
<RoomType BookableRate="309.00" Code="A2D" NativeCurrency="USD" RateChange="true"
RateFrequency="Daily" RoomDescription="Deluxe Double Double - A Luxurious Room" TotalRate="977.00" TotalRateInclusive="1131.61">
<GuaranteePolicy Required="true"/>
<CancelPolicy IntervalUnits="Days" TimeInterval="1"/>
<Amenity xml:lang="en" Code="NSMK" Confirmable="true" Room="true"/>
</RoomType>
</RatePlan>
<RatePlan Code="PR0" CommissionableStatus="Commissionable" Description="Deluxe Free Breakfast and WiFi" InDate="2011-09-01" Indicator="BusinessStandard" MarketingText1="ACCESS TO OVER 3000 UTELL HOTELS WORLDWIDE." OutDate="2011-09-04">
<BookingRequirement MinimumStayRequired="true"/>
<RoomType BookableRate="289.00" Code="A1K" NativeCurrency="USD" RateChange="true" RateFrequency="Daily" RoomDescription="King Deluxe -A Luxurious Room" TotalRate="917.00" TotalRateInclusive="1062.76">
<GuaranteePolicy Required="true"/>
<CancelPolicy IntervalUnits="Days" TimeInterval="1"/>
<Amenity xml:lang="en" Code="NSMK" Confirmable="true" Room="true"/>
</RoomType>
<RoomType BookableRate="309.00" Code="A2D" NativeCurrency="USD" RateChange="true" RateFrequency="Daily" RoomDescription="Deluxe Double Double - A Luxurious Room" TotalRate="977.00" TotalRateInclusive="1131.61">
<GuaranteePolicy Required="true"/>
<CancelPolicy IntervalUnits="Days" TimeInterval="1"/>
<Amenity xml:lang="en" Code="NSMK" Confirmable="true" Room="true"/>
</RoomType>
</RatePlan>
</Rate>
</Property>
</HotelML>

PreviousTransaction Header Formats NextRequesting Specific Rates

Last updated 1 year ago

hashtagOverview

hashtagSimple Example

Overview

Simple Example