Booking List Retrieval

The HotelResRetrieve request message allows you to retrieve a list of bookings that were made within a specific arrival date range or a specific booking date range.

HotelResRetrieve Request

Retrieve Booking List by Date
Retrieve Booking List by ID

<s:Envelope xmlns:s = "http://schemas.xmlsoap.org/soap/envelope/" xmlns:u = "http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
    <s:Header>
        <o:Security s:mustUnderstand = "1" xmlns:o = "http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
            <o:UsernameToken u:Id = "uuid-d740d5c0-ebc5-45c7-bd74-62b20c963d85-7">
                <o:Username>username</o:Username>
                <o:Password>password</o:Password>
            </o:UsernameToken>
        </o:Security>
    </s:Header>
    <s:Body xmlns:xsi = "http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd = "http://www.w3.org/2001/XMLSchema">
        <HotelResRetrieve xmlns = "http://schemas.xmltravelgate.com/hubpush/provider/2012/10">
            <request Version = "0">
                <POS xmlns = "http://www.opentravel.org/OTA/2003/05">
                    <Source>
                        <RequestorID ID = "Seller Code"/>
                        <BookingChannel>
                            <CompanyName Code = "Buyer Code"/>
                        </BookingChannel>
                    </Source>
                </POS>
                <ReadRequests xmlns = "http://www.opentravel.org/OTA/2003/05">
                    <HotelReadRequest HotelCode = "2">
                        <SelectionCriteria Start="2023-11-22" End="2023-11-23" DateType="CreateDate"/>
                    </HotelReadRequest>
                </ReadRequests>
            </request>
        </HotelResRetrieve>
    </s:Body>
</s:Envelope>

<s:Envelope xmlns:s = "http://schemas.xmlsoap.org/soap/envelope/" xmlns:u = "http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
    <s:Header>
        <o:Security s:mustUnderstand = "1" xmlns:o = "http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
            <o:UsernameToken u:Id = "uuid-d740d5c0-ebc5-45c7-bd74-62b20c963d85-7">
                <o:Username>username</o:Username>
                <o:Password>password</o:Password>
            </o:UsernameToken>
        </o:Security>
    </s:Header>
    <s:Body xmlns:xsi = "http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd = "http://www.w3.org/2001/XMLSchema">
        <HotelResRetrieve xmlns = "http://schemas.xmltravelgate.com/hubpush/provider/2012/10">
            <request>
                <POS xmlns = "http://www.opentravel.org/OTA/2003/05">
                    <Source>
                        <RequestorID ID = "Seller Code"/>
                        <BookingChannel>
                            <CompanyName Code = "Buyer Code"/>
                        </BookingChannel>
                    </Source>
                </POS>
                <UniqueID xmlns = "http://www.opentravel.org/OTA/2003/05" ID="test_doc_29" ID_Context="Client" />
            </request>
        </HotelResRetrieve>
    </s:Body>
</s:Envelope>

Request Data Breakdown

Element	Rel	Type	Description
HotelResRetrieve	1
HotelResRetrieve/request	1
ReadRequests/HotelReadRequest	1..n		Node containing the read request data.
@HotelCode	0..1	String	Hotel code.
HotelReadRequest/SelectionCriteria	0..1
@Start	1	DateTime	Start date to search bookings. DateTime Format is yyyy-MM-ddThh:mm:ss Date must be in UTC.
@End	1	DateTime	End date to search bookings. DateTime Format is yyyy-MM-ddThh:mm:ss Date must be in UTC.
@DateType	1	String	(ArrivalDate, CreateDate, DepartureDate, LastUpdateDate).
HotelReadRequest/UniqueID	0..1
@ID	1	String	Booking ID.
@ID_Context	1	String

HotelResRetrieve Response

After each request, Travelgate processes the data and provides a response to the Seller. Upon receiving a HotelResRetrieve request, Travelgate sends a corresponding HotelResRetrieve response. The response options include either success or an error.

Success

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/" xmlns:u="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
   <s:Header>
      <o:Security s:mustUnderstand="1" xmlns:o="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
         <u:Timestamp u:Id="_0">
            <u:Created>2023-11-23T10:47:37.480Z</u:Created>
            <u:Expires>2023-11-23T10:52:37.480Z</u:Expires>
         </u:Timestamp>
      </o:Security>
   </s:Header>
   <s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
      <HotelResRetrieveResponse xmlns="http://schemas.xmltravelgate.com/hubpush/provider/2012/10">
         <HotelResRetrieveResult ResResponseType="Committed">
            <HotelReservations xmlns="http://www.opentravel.org/OTA/2003/05">
               <HotelReservation CreateDateTime="2023-11-22T13:30:07.8054362Z" ResStatus="RQ">
                  <RoomStays>
                     <RoomStay>
                        <RoomTypes>
                           <RoomType RoomTypeCode="STD2" RoomID="47915">
                              <RoomDescription>
                                 <Text>Standard</Text>
                              </RoomDescription>
                           </RoomType>
                        </RoomTypes>
                        <RatePlans>
                           <RatePlan RatePlanCode="BAR" RatePlanType="11" PriceViewableInd="false" QualificationType="25">
                              <RatePlanDescription>
                                 <Text>Test rate</Text>
                              </RatePlanDescription>
                              <Commission Percent="15"/>
                              <Guarantee PaymentCode="DirectPayment">
                                 <GuaranteesAccepted>
                                    <GuaranteeAccepted>
                                       <PaymentCard CardCode="VI">
                                          <IsVCC>false</IsVCC>
                                       </PaymentCard>
                                    </GuaranteeAccepted>
                                 </GuaranteesAccepted>
                              </Guarantee>
                              <AdditionalDetails>
                                 <AdditionalDetail Code="code" Type="39">
                                    <DetailDescription>
                                       <Text>Negotiated</Text>
                                    </DetailDescription>
                                 </AdditionalDetail>
                              </AdditionalDetails>
                              <Fees>
                                 <AmendFees>
                                    <AmendFee Amount="13" CurrencyCode="EUR" ChargeUnit="2"/>
                                 </AmendFees>
                              </Fees>
                           </RatePlan>
                        </RatePlans>
                        <RoomRates>
                           <RoomRate BookingCode="1|30#30|2|2023-12-20|2|5948716|5948717|14|11|0" EffectiveDate="2023-12-20" ExpireDate="2023-12-22" RoomTypeCode="STD2" InvBlockCode="14" NumberOfUnits="999" RatePlanCode="BAR" RoomID="47915">
                              <Rates>
                                 <Rate EffectiveDate="2023-12-20" ExpireDate="2023-12-21">
                                    <Base AmountBeforeTax="100.0" AmountAfterTax="100.0" CurrencyCode="EUR" Type="25"/>
                                    <CancelPolicies>
                                       <CancelPenalty PolicyCode="3ca19e3e-da3b-42fd-90c3-d6d428ab5d89"/>
                                       <CancelPenalty PolicyCode="2c846cc7-648d-4046-8ea6-5acd4f9d7fa3"/>
                                       <CancelPenalty PolicyCode="ed89264a-9a3b-4532-b61f-452f754add29"/>
                                    </CancelPolicies>
                                 </Rate>
                                 <Rate EffectiveDate="2023-12-21" ExpireDate="2023-12-22">
                                    <Base AmountBeforeTax="100.0" AmountAfterTax="100.0" CurrencyCode="EUR" Type="25"/>
                                 </Rate>
                              </Rates>
                              <Total AmountBeforeTax="200.0" AmountAfterTax="200.0" CurrencyCode="EUR">
                                 <Taxes>
                                    <Tax Code="" Amount="80" Type="Exclusive"/>
                                 </Taxes>
                              </Total>
                              <Features>
                                 <Feature>
                                    <Description>
                                       <Text>MYROOM2</Text>
                                    </Description>
                                 </Feature>
                              </Features>
                           </RoomRate>
                        </RoomRates>
                        <CancelPenalties>
                           <CancelPenalty PolicyCode="3ca19e3e-da3b-42fd-90c3-d6d428ab5d89" NonRefundable="false">
                              <Deadline AbsoluteDeadline="2023-11-30" OffsetTimeUnit="Day" OffsetUnitMultiplier="20" OffsetDropTime="BeforeArrival"/>
                              <AmountPercent NmbrOfNights="3" CurrencyCode="EUR"/>
                           </CancelPenalty>
                        </CancelPenalties>
                        <BasicPropertyInfo HotelCode="2" HotelName="Hotel Test Pruebas Travelgate 2"/>
                        <ServiceRPHs>
                           <ServiceRPH RPH="1"/>
                           <ServiceRPH RPH="2"/>
                        </ServiceRPHs>
                     </RoomStay>
                  </RoomStays>
                  <ResGuests>
                     <ResGuest ResGuestRPH="1" AgeQualifyingCode="10">
                        <Profiles>
                           <ProfileInfo>
                              <Profile>
                                 <Customer>
                                    <PersonName>
                                       <NamePrefix>Mr</NamePrefix>
                                       <GivenName>Name</GivenName>
                                       <Surname>Surname</Surname>
                                    </PersonName>
                                 </Customer>
                              </Profile>
                           </ProfileInfo>
                        </Profiles>
                        <GuestCounts>
                           <GuestCount Age="30"/>
                        </GuestCounts>
                     </ResGuest>
                     <ResGuest ResGuestRPH="2" AgeQualifyingCode="10">
                        <Profiles>
                           <ProfileInfo>
                              <Profile>
                                 <Customer>
                                    <PersonName>
                                       <NamePrefix>Mr</NamePrefix>
                                       <GivenName>Name</GivenName>
                                       <Surname>Surname</Surname>
                                    </PersonName>
                                 </Customer>
                              </Profile>
                           </ProfileInfo>
                        </Profiles>
                        <GuestCounts>
                           <GuestCount Age="30"/>
                        </GuestCounts>
                     </ResGuest>
                  </ResGuests>
                  <ResGlobalInfo>
                     <Total AmountBeforeTax="200" AmountAfterTax="200" CurrencyCode="EUR"/>
                     <HotelReservationIDs>
                        <HotelReservationID ResID_Value="test_doc_29" ResID_SourceContext="Client"/>
                        <HotelReservationID ResID_Value="2706797" ResID_SourceContext="Internal"/>
                        <HotelReservationID ResID_Value="" ResID_SourceContext="Provider"/>
                     </HotelReservationIDs>
                     <Profiles>
                        <ProfileInfo>
                           <Profile>
                              <Customer>
                                 <PersonName>
                                    <NamePrefix>Mr</NamePrefix>
                                    <GivenName>Name</GivenName>
                                    <Surname>Surname</Surname>
                                 </PersonName>
                                 <Telephone PhoneTechType="1" PhoneNumber="02087074461"/>
                                 <Email EmailType="1">hotelpush@xmltravelgate.com</Email>
                                 <Address Type="1">
                                    <AddressLine>Nice Address Line</AddressLine>
                                    <CityName>Good City</CityName>
                                    <PostalCode>078745</PostalCode>
                                    <CountryName>ES</CountryName>
                                 </Address>
                              </Customer>
                           </Profile>
                        </ProfileInfo>
                     </Profiles>
                  </ResGlobalInfo>
               </HotelReservation>
            </HotelReservations>
            <Success xmlns="http://www.opentravel.org/OTA/2003/05"/>
         </HotelResRetrieveResult>
      </HotelResRetrieveResponse>
   </s:Body>
</s:Envelope>

Success Response Data Breakdown

Element Rel Type Description

HotelResRetrieveResponse 1 Root Node.

HotelResRetrieveResponse/HotelResRetrieveResult 1 Contains the result of reservation retrieve.

HotelResRetrieveResult/HotelReservations 0..1 Node containing the reservation.

HotelReservations/HotelReservation 1 Node containing information about the reservation.

@CreateDateTime 1 DateTime Date and time when the reservation was made.

@ResStatus 1 String Status of the reservation.

HotelReservation/RoomStays 1 Node containing the RoomStays of the reservation.

RoomStays/RoomStay 1..n Node containing RoomStay information.

RoomStay/RoomTypes 1 Node containing information about rooms.

RoomTypes/RoomType 1 Node containing information about one room.

@RoomTypeCode 1 String Room code.

@RoomID 1 String Id of the room.

RoomType/RoomDescription 1 Node containing the description of the room.

RoomDescription/Text 1 String Description of the room.

RoomStay/RatePlans 1 Node containing information about RatePlans.

RatePlans/RatePlan 1 Node containing information about one RatePlan.

@RatePlanCode 1 RatePlan code.

@RatePlanType

String

Rate Rule Codes

Code	Description
0	No selected
7	Large Family
8	Public Servant
10	Negotiated
11	Package
34	Canary Resident
35	Balearic Resident
36	Honeymoon

@PriceViewableInd Boolean

@QualificationType String

RatePlan/RatePlanDescription 1 Node containing information the RatePlan description one RatePlan.

RatePlanDescription/Text 1 String Description of the RatePlan.

RatePlan/Commission 1 Node containing the commission of the RatePlan.

@Percent 1 Decimal Commission of the RatePlane.

RatePlan/Guarantee 0..1 Node containing the Guarantee provided with the reservation.

@PaymentCode

Payment Type Codes

Code	Description
MerchantPayment	The customer pays the client and the client will pay the provider
DirectPayment	The customer will have to use a credit card as guarantee for the hotel and the payment will be done by the customer at check-in
BookingDatePayment	The client will use a credit card with the exact amount of the option so he can pay the provider/hotel. The provider will charge the payment on the reservation day
ArrivalDatePayment	The client will use a credit card with the exact amount of the option so he can pay the provider/hotel, the provider will charge the payment on the checking day

Guarantee/GuaranteesAccepted 0..1 Node containing the Guarantee provided with the reservation.

GuaranteesAccepted/GuaranteeAccepted 1 Node that contains the booking payment details accepted.

GuaranteeAccepted/PaymentCard 1 Node that contains the credit card accepted. The credit card information can be a URL with the information(in TPA_Extension tag) or the details in the PaymentCard tags and attributes.

@CardCode

String

Credit Card codes

Code	Name
VI	Visa
AX	American Express
BC	BC Card
CA	MasterCard
CB	Carte Blanche
CU	China Union Pay
DS	Discover
DC	Diners Club
T	Carta Si
R	Carte Bleue
N	Dankort
L	Delta
E	Electron
JC	Japan Credit Bureau
TO	Maestro
S	Switch
EC	Electronic Cash
EU	EuroCard
TP	Universal air travel card
OP	optima
ER	Air Canada/RnRoute
XS	access
O	others

PaymentCard/IsVCC 1 Boolean

RatePlan/AdditionalDetails 0..1

AdditionalDetails/AdditionalDetail 0..n

@Code 1 String Client code for whom the rate is offered.

@Type 1 String Contract/negotiated booking information, allowed only for 39.

AdditionalDetail/DetailDescription 1

DetailDescription/Text 1 String If the additional details type is 39, the name of the client for whom the rate is offered will be sent as text.

RoomStay/RoomRates 1 Node containing information about RoomRates.

RoomRates/RoomRate 1 Node containing information about one RoomRate.

@BookingCode 1 Booking Code.

@EffectiveDate 1 Date Effective date when the RoomRate start applying.

@ExpireDate 1 Date Expire date when the RoomRate ends applying. Check out night minus 1.

@RoomTypeCode 1 String Code of the Room.

@InvBlockCode 1 String Inventary block code.

@NumberOfUnits 1 String

@RatePlanCode 1 String Code of the RatePlan.

@RoomID 1 String Room ID.

RoomRate/Rates 1 Node containing information about the rates.

Rates/Rate 1 Node containing information about one rate.

@EffectiveDate 1 Date Effective date when the Rate start applying.

@ExpireDate 1 Date Expire date when the Rate ends applying.

Rate/Base 1 Node containing core information about the rate.

@AmountBeforeTax 0..1 Decimal Amount before tax of the rate.

@AmountAfterTax 1 Decimal Amount after tax of the rate.

@CurrencyCode 1 String Currency code of the rate.

@Type 1 String

Rate/CancelPolicies 1 Node containing information about cancel policies which are applied to the rate.

CancelPolicies/CancelPenalty 0..n Node containing information about one cancel penalty.

@PolicyCode 1 String Policy code of the cancel penalty.

RoomRate/Total 1 Node containing information about the total price of the RoomRate.

@AmountBeforeTax 0..1 Decimal Amount before tax of the RoomRate.

@AmountAfterTax 1 Decimal Amount after tax of the RoomRate.

@CurrencyCode 1 String Currency code of the RoomRate.

@Type 1 String

RoomStay/CancelPenalties 1 Node containing all cancel penalties of the RoomStay.

CancelPenalties/CancelPenalty 0..n Node containing information about one cancel penalty.

@PolicyCode 1 String Policy code of the cancel penalty.

@NonRefundable 1 Boolean Indicates whether the Rate is refundable or not.

CancelPenalty/Deadline 0..n Node containing information about the deadline of the cancel penalty.

@AbsoluteDeadline 1 DateTime Indicates when the absolute deadline.

@OffsetTimeUnit 1 String Time unit of the offset for the absolute deadline.

@OffsetUnitMultiplier 1 Integer Number of time units of offset for the absolute ege deadline.

@OffsetDropTime 1 String Indicates when the deadline is applied.

CancelPenalty/AmountPercent 0..n Amount of the cancel penalty.

@Percent 1 String Percent of the total charged as a cancel penalty amount. Percent or NmbrOfNights must be present.

@NmbrOfNights 1 String Number of nights charged as a cancel penalty amount.

@CurrencyCode 1 String Currency code of the cancel penalty amount.

RoomStay/BasicPropertyInfo 1 Node containing basic information of the property.

@HotelCode 1 Integer Hotel code.

@HotelName 1 String Hotel name.

RoomStay/ServiceRPHs 1 Node containing information of the guests of the room.

ServiceRPHs/ServiceRPH 1..n Node containing information of a guest of the room.

@RPH 1 String Code of a guest of the room. Match with @ResGuestRPH at the ResGuests node.

RoomStay/Comments 0..1 Node containing information of the customer comments.

Comments/Comment 1..n String Customer comment text

Comment/Text 1 Node containing information about one customer comment

HotelReservation/ResGuests 1 Node containing all reservation guests.

ResGuests/ResGuest 1..n Node containing information about one of the guests.

@ResGuestRPH 1 Integer RPH of the guest.

@AgeQualifyingCode 1 Integer Age qualifying code of the guest.

ResGuest/Profiles 1 Node containing information about the profiles of the guest.

Profiles/ProfileInfo 1 Node containing information about the profile of the guest.

ProfileInfo/Customer 1 Node containing customer information of the guest.

Customer/PersonName 1 Node containing the person name of the guest.

PersonName/NamePrefix 1 String Prefix/Traitement name of the guest.

PersonName/GivenName 1 String Given name of the guest.

PersonName/Surname 1 String Surname of the guest.

ResGuest/GuestCounts 1 Node containing quantity informations for the guest.

GuestCounts/GuestCount 1 Node containing quantity information for the guest.

@Age 1 Integer Age of the guest.

HotelReservation/ResGlobalInfo 1 Node containing general information about the reservation.

ResGlobalInfo/Total 1 Node containing the total price.

@AmountBeforeTax 0..1 Decimal Amount before tax of the Reservation.

@AmountAfterTax 1 Decimal Amount after tax of the Reservation.

@CurrencyCode 1 String Currency code of the Reservation.

ResGlobalInfo/HotelReservationIDs 1 Node containing the ids of the reservation.

HotelReservationIDs/HotelReservationID 2 Node containing information of one reservation id.

@ResIDValue 1 String Value of the id.

@ResIDSourceContext 1 String Id context.

ResGlobalInfo/Profiles 1 Node containing information about the profiles of the reservation.

Profiles/ProfileInfo 1 Node containing information about the profile of the reservation.

ProfileInfo/Profile 1 Node containing information about the profile of the reservation.

Profile/Customer 1 Node containing information about the customer of the reservation. The customer of the reservation can be or not a pax of the reservation. If it’s a pax will be present in ResGuests node.

Customer/PersonName 1 Node containing the person name of the customer of the reservation.

PersonName/NamePrefix 1 String Name prefix of the customer.

PersonName/GivenName 1 String Given name of the customer.

PersonName/Surname 1 String Surname of the customer.

Customer/Telephone 1 Node containing information about the telephone of the customer.

@PhoneTechType 1 String Phone technology type.

@PhoneNumber 1 String Phone number.

Customer/Email 1 Node containing information about the email of the customer.

@EmailType 1 String Email of the customer.

Customer/Address 1 Node containing information about the address of the customer.

@Type 1

Address/AddressLine 1 String Address of the customer.

Address/CityName 1 String City name.

Address/PostalCode 1 String Postal code.

Address/CountryName 1 String Country name.

HotelResRetrieveResult/Success 0..1 Should only be present if it was a successful response. The Errors node should not be present if the Success node is present.

Error

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/" xmlns:u="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
   <s:Header>
      <o:Security s:mustUnderstand="1" xmlns:o="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
         <u:Timestamp u:Id="_0">
            <u:Created>2023-11-22T11:11:00.838Z</u:Created>
            <u:Expires>2023-11-22T11:16:00.838Z</u:Expires>
         </u:Timestamp>
      </o:Security>
   </s:Header>
   <s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
      <HotelResRetrieveResponse xmlns="http://schemas.xmltravelgate.com/hubpush/provider/2012/10">
         <HotelResRetrieveResult>
            <Errors xmlns="http://www.opentravel.org/OTA/2003/05">
                <Error ShortText="Invalid hotel id" Code="10"/>
             </Errors>
         </HotelResRetrieveResult>
      </HotelResRetrieveResponse>
   </s:Body>
</s:Envelope>

Error Response Data Breakdown

Element

Rel

Type

Description

HotelResRetrieveResult

HotelResRetrieveResult/Errors

0..1

Errors/Error

@ShortText

String

Error Codes and Description

Error Code	Error Description
-1	Unexpected error
1	Validation error
10	HotelCode not found
11	Invalid dates
14	Invalid derived rate
22	Rooms not found
23	Rates not found
30	Occupancy error
31	RatePlan_Rate Error
38	POS credentials not found
50	Confirmation error
60	Cancellation error

@Code

String

Error Codes and Description

Error Code	Error Description
-1	Unexpected error
1	Validation error
10	HotelCode not found
11	Invalid dates
14	Invalid derived rate
22	Rooms not found
23	Rates not found
30	Occupancy error
31	RatePlan_Rate Error
38	POS credentials not found
50	Confirmation error
60	Cancellation error

HotelResRetrieve Request​

Request Data Breakdown​

HotelResRetrieve Response​

Success​

Success Response Data Breakdown​

Error​

Error Response Data Breakdown​

HotelResRetrieve Request

Request Data Breakdown

HotelResRetrieve Response

Success

Success Response Data Breakdown

Error

Error Response Data Breakdown