Skip to main content

Enhanced Hotel Book

2.1.1
Hotel
Reservation
SOAP API
Travel Agency

Enhanced Hotel Book (EnhancedHotelBookRQ) is an orchestrated API that allows booking hotel content (GDS or aggregator) in a single call.

Not Signed In.

Looks like you may not have access to all of the resources and documentation for this page.
Please log-in or contact your support desk team if you believe you should have access.

Target Audience
Travel Agency
API Version
2.1.1
Authentication
Session Token
Service Action Code
EnhancedHotelBookRQ

What is it?

With the release of Content Services for Lodging (CSL), Sabre has expanded its traditional GDS hotel offering with content from external aggregators. The Enhanced Hotel Book API (EnhancedHotelBookRQ) facilitates the booking of both traditional GDS hotel content as well as lodging aggregator content.

Why use it?

Features in the Enhanced Hotel Book API include:

  • Ability to book an Aggregator hotel as a CSL segment.
  • Ability to book a Sabre GDS hotel as a CSL segment or as a legacy segment.
  • Ability to specify a “Hotel Booking Key” that uniquely identifies the hotel property, room type, room rate, number of guests, etc.
  • Ability to identify failures during the orchestrated process, and properly notify the user.

How it works

The API performs several steps when booking a hotel room:

  • It will decode and retrieve shopped rate details based on the data provided by the "Hotel Booking Key".
  • Depending on the data of the booking key and user input, the API will follow one of the following three strategies to book the desired hotel rate:
    • Aggregator hotel via CSL
    • GDS hotel via CSL
    • GDS hotel as a legacy segment
  • If the booking is successful, the API will validate the newly added segment statuses as returned by the hotel vendor (HK/SS/NN/PN/UC/NO):
    • HK/SS/NN/PN are considered successful
    • UC/NO are considered unsuccessful and the API will return an error
  • Finally, it will return the current state of the session in the response payload (an internal call to TravelItineraryReadRQ).

How to use

For detailed instructions on using this API, refer to the Enhanced Hotel Book user guides under the Resources tab.

Sample Request
<SamplePayloads>
    <SampleRequests>
        <!--Book a Aggregator Hotel segment-->
        <EnhancedHotelBookRQ version="2.1.0">
            <BookingInfo RequestorID="SG000000">
                <BookingKey>fef21245-d571-4fb8-8cbb-38143e44f29e</BookingKey>
            </BookingInfo>
            <Rooms>
                <Room RoomIndex="1" NonSmoking="true">
                    <Guests>
                        <Guest FirstName="TEST" LastName="API" Email="Witold.Petriczek@sabre.com" Type="10" Index="1" LeadGuest="true">
                            <Contact Phone="817-555-1212"/>
                        </Guest>
                    </Guests>
                </Room>
            </Rooms>
            <PaymentInformation Type="GUARANTEE">
                <FormOfPayment>
                    <PaymentCard>
                        <PaymentType>CC</PaymentType>
                        <CardCode>VI</CardCode>
                        <CardNumber>4000000000006</CardNumber>
                        <ExpiryMonth>7</ExpiryMonth>
                        <ExpiryYear>2021</ExpiryYear>
                        <FullCardHolderName>
                            <FirstName>TEST</FirstName>
                            <LastName>API</LastName>
                            <Email>Witold@sabre.com</Email>
                        </FullCardHolderName>
                        <CSC>123</CSC>
                        <Address>
                            <AddressLine>Wadowicka 6</AddressLine>
                            <CityName>Krakow</CityName>
                            <StateProvince code="KR"/>
                            <StateProvinceCodes>
                                <Code>KR</Code>
                            </StateProvinceCodes>
                            <PostCode>30-415</PostCode>
                            <CountryCodes>
                                <Code>PL</Code>
                            </CountryCodes>
                        </Address>
                        <Phone>
                            <PhoneNumber>817-555-1212</PhoneNumber>
                        </Phone>
                    </PaymentCard>
                </FormOfPayment>
            </PaymentInformation>
            <POS>
                <Source AgencyName="SABRE" ISOCountryCode="US" PseudoCityCode="TM61">
                    <RequestorID Type="5" Id="000000" IdContext="IATA"/>
                    <AgencyAddress>
                        <AddressLine1>3150 SABRE DRIVE</AddressLine1>
                        <CityName/>
                        <CountryName Code="US"/>
                    </AgencyAddress>
                </Source>
            </POS>
        </EnhancedHotelBookRQ>
        <!--Book a GDS Hotel segment-->
        <EnhancedHotelBookRQ version="2.1.0">
            <BookingInfo>
                <BookingKey>9cfcff9b-44c5-4032-a08e-adde71914b81</BookingKey>
            </BookingInfo>
            <Rooms>
                <Room RoomIndex="2147483647">
                    <Guests>
                        <Guest Type="10" LastName="SURNAME"/>
                    </Guests>
                </Room>
            </Rooms>
            <PaymentInformation Type="GUARANTEE">
                <FormOfPayment>
                    <PaymentCard>
                        <PaymentType>CC</PaymentType>
                        <CardCode>VI</CardCode>
                        <CardNumber>4000000000006</CardNumber>
                        <ExpiryMonth>7</ExpiryMonth>
                        <ExpiryYear>2021</ExpiryYear>
                        <FullCardHolderName>
                            <FirstName>
MANDATORY FIELD EVEN THOUGH NOT ALWAYS USED BY GDS HOTELS
</FirstName>
                            <LastName>SURNAME</LastName>
                        </FullCardHolderName>
                    </PaymentCard>
                </FormOfPayment>
            </PaymentInformation>
        </EnhancedHotelBookRQ>
    </SampleRequests>
</SamplePayloads>
Sample Response
<SamplePayloads>
    <SampleResponses>
        <!--Book a Aggregator Hotel segment-->
        <EnhancedHotelBookRS version="2.1.0">
            <ApplicationResults status="Complete">
                <Success timeStamp="2020-07-15T11:10:18.361-05:00"/>
            </ApplicationResults>
            <TravelItineraryRead>
                <TravelItinerary>
                </TravelItinerary>
            </TravelItineraryRead>
        </EnhancedHotelBookRS>
        <!--Book a GDS Hotel segment-->
        <EnhancedHotelBookRS version="2.1.0">
            <ApplicationResults status="Complete">
                <Success timeStamp="2020-07-15T10:45:25.375-05:00"/>
            </ApplicationResults>
            <TravelItineraryRead>
                <TravelItinerary>
                    <CustomerInfo>
                        <Address>
                            <AddressLine Id="7" type="O">SABRE TRAVEL</AddressLine>
                            <AddressLine Id="8" type="O">3150 SABRE DRIVE</AddressLine>
                            <AddressLine Id="9" type="O">SOUTHLAKE, TX US</AddressLine>
                            <AddressLine Id="10" type="O">76092</AddressLine>
                        </Address>
                        <ContactNumbers>
                            <ContactNumber LocationCode="BWI" Phone="817-555-1212-H-1.1" RPH="001" Id="6"/>
                        </ContactNumbers>
                        <PersonName WithInfant="false" NameNumber="01.01" NameReference="ABC123" PassengerType="ADT" RPH="1" elementId="pnr-3.1">
                            <GivenName>TEST</GivenName>
                            <Surname>API</Surname>
                        </PersonName>
                    </CustomerInfo>
                    <ItineraryInfo>
                        <ReservationItems>
                            <Item RPH="1">
                                <Hotel DayOfWeekInd="7" NumberInParty="01" NumberOfUnits="1" SegmentNumber="0001" Status="HK" Type="HHL" IsPast="false" Id="41">
                                    <BasicPropertyInfo ChainCode="HI" HotelCityCode="DFW" HotelCode="15870" HotelName="HOLIDAY INN EXP STES AIRPORT N">
                                        <Address>
                                            <AddressLine>4550 W JOHN CARPENTER FREEWAY</AddressLine>
                                            <AddressLine>IRVING TX 75063</AddressLine>
                                            <CountryCode>US</CountryCode>
                                        </Address>
                                        <CancelPenalty PolicyCode="01D"/>
                                        <CancelPenalty PolicyCode="CANCEL 1 DAYS PRIOR TO ARRIVAL"/>
                                        <ConfirmationNumber>49179530-</ConfirmationNumber>
                                        <DirectConnect>DCHI</DirectConnect>
                                        <ContactNumbers>
                                            <ContactNumber Fax="1-972-929-0774" Phone="1-972-929-4499"/>
                                        </ContactNumbers>
                                    </BasicPropertyInfo>
                                    <Guarantee>VI4XXXXXXXX0006EXP 07 21-SURNAME</Guarantee>
                                    <RoomRates>
                                        <Commission NonCommission="false">COMMISSIONABLE</Commission>
                                        <Rate Amount="274.00" CurrencyCode="USD" DCS_AuxRateCode="PARK STAY AND GO STAY WITH" RoomTypeCode="XFN53IG">
                                            <HotelTotalPricing>
                                                <TotalTax Amount="134.56">
                                                    <Tax Id="TX1">134.56 TAX</Tax>
                                                </TotalTax>
                                                <ApproximateTotal AmountAndCurrency="975.56 USD"/>
                                                <RateChange Effective="00144.00USD 13OCT-001NT"/>
                                                <RateChange Effective="00184.00USD 14OCT-001NT"/>
                                                <RateChange Effective="00274.00USD 15OCT-001NT"/>
                                                <RateChange Effective="00239.00USD 16OCT-001NT"/>
                                                <Disclaimer Id="DS1">INCLUDES TAX</Disclaimer>
                                            </HotelTotalPricing>
                                        </Rate>
                                    </RoomRates>
                                    <Text>AA</Text>
                                    <TimeSpan Duration="004" End="10-17" Start="10-13"/>
                                </Hotel>
                            </Item>
                        </ReservationItems>
                        <Ticketing RPH="01" TicketTimeLimit="TAW/"/>
                    </ItineraryInfo>
                    <ItineraryRef AirExtras="false" ID="STVKOZ" InhibitCode="U" PartitionID="AA" PrimeHostID="1S">
                        <Source AAA_PseudoCityCode="TM61" CreateDateTime="2019-07-15T10:45" CreationAgent="ASP" HomePseudoCityCode="TM61" PseudoCityCode="TM61" ReceivedFrom="SP TEST" LastUpdateDateTime="2019-07-15T10:45" SequenceNumber="1"/>
                    </ItineraryRef>
                    <SpecialServiceInfo RPH="001" Type="AFX" Id="52">
                        <Service SSR_Code="OSI">
                            <Text>
AA HHL HI TOTAL: 975.56 USD ALL KNOWN FEES INCLUDED
</Text>
                        </Service>
                    </SpecialServiceInfo>
                    <SpecialServiceInfo RPH="002" Type="AFX" Id="53">
                        <Service SSR_Code="OSI">
                            <Text>
AA HHL HI CXL AFTER 1800 12OCT FORFEIT FIRST NITE STAY
</Text>
                        </Service>
                    </SpecialServiceInfo>
                    <SpecialServiceInfo RPH="001" Type="GFX" Id="42">
                        <Service SSR_Code="OSI">
                            <Airline Code="HI"/>
                            <Text>HHL 15870 XFN53IG D PARK STAY AND GO STAY WITH</Text>
                        </Service>
                    </SpecialServiceInfo>
                    <SpecialServiceInfo RPH="002" Type="GFX" Id="43">
                        <Service SSR_Code="OSI">
                            <Airline Code="HI"/>
                            <Text>
HHL 15870 XFN53IG C CANCEL 1 DAYS PRIOR TO ARRIVAL
</Text>
                        </Service>
                    </SpecialServiceInfo>
                    <SpecialServiceInfo RPH="003" Type="GFX" Id="44">
                        <Service SSR_Code="OSI">
                            <Airline Code="HI"/>
                            <Text>
HHL 15870 XFN53IG D 1 BEDROOM SUITE 1 KING NONSMO
</Text>
                        </Service>
                    </SpecialServiceInfo>
                    <SpecialServiceInfo RPH="004" Type="GFX" Id="45">
                        <Service SSR_Code="OSI">
                            <Airline Code="HI"/>
                            <Text>
HHL 15870 XFN53IG D SUITE INCLUDES TWO 32 INCH HDT
</Text>
                        </Service>
                    </SpecialServiceInfo>
                    <SpecialServiceInfo RPH="005" Type="GFX" Id="46">
                        <Service SSR_Code="OSI">
                            <Airline Code="HI"/>
                            <Text>HHL 15870 XFN53IG TTX 134.56 TTL TAX</Text>
                        </Service>
                    </SpecialServiceInfo>
                    <SpecialServiceInfo RPH="006" Type="GFX" Id="47">
                        <Service SSR_Code="OSI">
                            <Airline Code="HI"/>
                            <Text>HHL 15870 XFN53IG TX 134.56 TAX</Text>
                        </Service>
                    </SpecialServiceInfo>
                    <SpecialServiceInfo RPH="007" Type="GFX" Id="48">
                        <Service SSR_Code="OSI">
                            <Airline Code="HI"/>
                            <Text>
HHL 15870 XFN53IG TP 975.56 USD APPROX. TTL PRICE
</Text>
                        </Service>
                    </SpecialServiceInfo>
                    <SpecialServiceInfo RPH="008" Type="GFX" Id="49">
                        <Service SSR_Code="OSI">
                            <Airline Code="HI"/>
                            <Text>HHL 15870 XFN53IG TD INCLUDES TAX</Text>
                        </Service>
                    </SpecialServiceInfo>
                    <OpenReservationElements>
                        <OpenReservationElement id="3" elementId="pnr-or-3"/>
                        <OpenReservationElement id="52" type="SRVC" elementId="pnr-52">
                            <ServiceRequest airlineCode="AA" serviceType="OSI" ssrType="AFX">
                                <FreeText>HHL HI TOTAL: 975.56 USD ALL KNOWN FEES INCLUDED</FreeText>
                                <FullText>
AA HHL HI TOTAL: 975.56 USD ALL KNOWN FEES INCLUDED
</FullText>
                            </ServiceRequest>
                        </OpenReservationElement>
                        <OpenReservationElement id="53" type="SRVC" elementId="pnr-53">
                            <ServiceRequest airlineCode="AA" serviceType="OSI" ssrType="AFX">
                                <FreeText>
HHL HI CXL AFTER 1800 12OCT FORFEIT FIRST NITE STAY
</FreeText>
                                <FullText>
AA HHL HI CXL AFTER 1800 12OCT FORFEIT FIRST NITE STAY
</FullText>
                            </ServiceRequest>
                        </OpenReservationElement>
                        <OpenReservationElement id="42" type="SRVC" elementId="pnr-42">
                            <ServiceRequest airlineCode="HI" serviceType="OSI" ssrType="GFX">
                                <FreeText>HHL 15870 XFN53IG D PARK STAY AND GO STAY WITH</FreeText>
                                <FullText>
HI HHL 15870 XFN53IG D PARK STAY AND GO STAY WITH
</FullText>
                            </ServiceRequest>
                        </OpenReservationElement>
                        <OpenReservationElement id="43" type="SRVC" elementId="pnr-43">
                            <ServiceRequest airlineCode="HI" serviceType="OSI" ssrType="GFX">
                                <FreeText>
HHL 15870 XFN53IG C CANCEL 1 DAYS PRIOR TO ARRIVAL
</FreeText>
                                <FullText>
HI HHL 15870 XFN53IG C CANCEL 1 DAYS PRIOR TO ARRIVAL
</FullText>
                            </ServiceRequest>
                        </OpenReservationElement>
                        <OpenReservationElement id="44" type="SRVC" elementId="pnr-44">
                            <ServiceRequest airlineCode="HI" serviceType="OSI" ssrType="GFX">
                                <FreeText>
HHL 15870 XFN53IG D 1 BEDROOM SUITE 1 KING NONSMO
</FreeText>
                                <FullText>
HI HHL 15870 XFN53IG D 1 BEDROOM SUITE 1 KING NONSMO
</FullText>
                            </ServiceRequest>
                        </OpenReservationElement>
                        <OpenReservationElement id="45" type="SRVC" elementId="pnr-45">
                            <ServiceRequest airlineCode="HI" serviceType="OSI" ssrType="GFX">
                                <FreeText>
HHL 15870 XFN53IG D SUITE INCLUDES TWO 32 INCH HDT
</FreeText>
                                <FullText>
HI HHL 15870 XFN53IG D SUITE INCLUDES TWO 32 INCH HDT
</FullText>
                            </ServiceRequest>
                        </OpenReservationElement>
                        <OpenReservationElement id="46" type="SRVC" elementId="pnr-46">
                            <ServiceRequest airlineCode="HI" serviceType="OSI" ssrType="GFX">
                                <FreeText>HHL 15870 XFN53IG TTX 134.56 TTL TAX</FreeText>
                                <FullText>HI HHL 15870 XFN53IG TTX 134.56 TTL TAX</FullText>
                            </ServiceRequest>
                        </OpenReservationElement>
                        <OpenReservationElement id="47" type="SRVC" elementId="pnr-47">
                            <ServiceRequest airlineCode="HI" serviceType="OSI" ssrType="GFX">
                                <FreeText>HHL 15870 XFN53IG TX 134.56 TAX</FreeText>
                                <FullText>HI HHL 15870 XFN53IG TX 134.56 TAX</FullText>
                            </ServiceRequest>
                        </OpenReservationElement>
                        <OpenReservationElement id="48" type="SRVC" elementId="pnr-48">
                            <ServiceRequest airlineCode="HI" serviceType="OSI" ssrType="GFX">
                                <FreeText>
HHL 15870 XFN53IG TP 975.56 USD APPROX. TTL PRICE
</FreeText>
                                <FullText>
HI HHL 15870 XFN53IG TP 975.56 USD APPROX. TTL PRICE
</FullText>
                            </ServiceRequest>
                        </OpenReservationElement>
                        <OpenReservationElement id="49" type="SRVC" elementId="pnr-49">
                            <ServiceRequest airlineCode="HI" serviceType="OSI" ssrType="GFX">
                                <FreeText>HHL 15870 XFN53IG TD INCLUDES TAX</FreeText>
                                <FullText>HI HHL 15870 XFN53IG TD INCLUDES TAX</FullText>
                            </ServiceRequest>
                        </OpenReservationElement>
                    </OpenReservationElements>
                    <AssociationMatrices>
                        <AssociationMatrix>
                            <Name>PssIDType</Name>
                            <Parent ref="pnr-41"/>
                            <Child ref="pnr-or-3"/>
                        </AssociationMatrix>
                    </AssociationMatrices>
                </TravelItinerary>
            </TravelItineraryRead>
        </EnhancedHotelBookRS>
    </SampleResponses>
</SamplePayloads>
Help Documentation Book
Weight
0