Reservation List

Reservation List allows to obtain a list of bookings that were made within a specific arrival date range or a specific booking date range. The returned fields for each booking in the list include: Locators, Hotel, TransactionStatus, Holder, Price etc.

ReservationList Request

<soapenv:Envelope xmlns:soapenv = "http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns = "http://schemas.xmltravelgate.com/hub/2012/06" xmlns:wsse = "http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
   <soapenv:Header>
      <wsse:Security>
         <wsse:UsernameToken>
            <wsse:Username>username</wsse:Username>
            <wsse:Password>password</wsse:Password>
         </wsse:UsernameToken>
      </wsse:Security>
   </soapenv:Header>
   <soapenv:Body>
      <ns:ReservationList>
         <ns:reservationListRQ>
            <ns:timeoutMilliseconds>20000</ns:timeoutMilliseconds>
            <ns:version>1</ns:version>
            <ns:providerRQ>
               <ns:code>suppliercode</ns:code>
               <ns:id>1</ns:id>
               <ns:rqXML>
                  <ReservationListRQ>
                      <timeoutMilliseconds>19700</timeoutMilliseconds>
                     <source>
                        <languageCode>en</languageCode>
                     </source>
                     <filterAuditData>
                        <registerTransactions>true</registerTransactions>
                     </filterAuditData>
                     <Configuration>
                        <User>user</User>
                        <Password>password</Password>
                        <UrlAvail>www.supplier.com/avail</UrlAvail>
                        <UrlReservation>www.supplier.com/reservation</UrlReservation>
                        <UrlValuation>www.supplier.com/valuation</UrlValuation>
                        <UrlGeneric>www.supplier.com/generic</UrlGeneric>
                        <Parameters>
                           <Parameter key = "UrlListHotels" value = "http://www.supplier.com/ListHotels"></Parameter>
                           <Parameter key = "Access" value = "2"></Parameter>
                        </Parameters>
                     </Configuration>
                     <DateType>A</DateType>
                     <Start>28/11/2014</Start>
                     <End>28/11/2014</End>
                  </ReservationListRQ>
               </ns:rqXML>
            </ns:providerRQ>
         </ns:reservationListRQ>
      </ns:ReservationList>
   </soapenv:Body>
</soapenv:Envelope>

Request Data Breakdown

Element	Rel	Type	Description
ReservationListRQ	1		Root node.
ReservationListRQ/DateType	1	String	Type search (A = arrival date, B = booking creation).
ReservationListRQ/Start	1	String	Start date.
ReservationListRQ/End	1	String	End date.

ReservationList Response

After each request, you will process the data and provide a response. Upon receiving a ReservationList request, you will send a corresponding ReservatonList response.

The response options include either success or an error. In the event of success, you will send a booking list with all the details.

Success

<ReservationListRS>
   <Reservations>
      <Reservation>
         <auditData>
            <timeStamp>2014-01-21T15:12:12.0558866+00:00</timeStamp>
            <processTimeMilliseconds>0</processTimeMilliseconds>
         </auditData>
         <operationImplemented>true</operationImplemented>
         <Locators>
            <Client>2196</Client>
            <Provider>1AAAA966</Provider>
            <Property>HCN8273</Property>
         </Locators>
         <OptionType>soloHotel</OptionType>
         <IsOptionTypeSpecified>false</IsOptionTypeSpecified>
         <Hotel>
            <Name>LAS VEGAS (BENIDORM)</Name>
            <Code>58475</Code>
            <CreationDate>30/09/2013</CreationDate>
            <StartDate>25/01/2014</StartDate>
            <EndDate>16/02/2014</EndDate>
            <Holder name = "name" surname = "surname"/>
            <Price currency = "EUR" amount = "658.94" binding = "false" commission = "-1" minimumSellingPrice="-1"/>
            <Rooms>
               <Room id = "27441" roomCandidateRefId = "1" description = "Doble Standard"/>
            </Rooms>
            <Fees>
                <Fee includedPriceOption = "true" description = "TaxAndServiceFee" mandatory = "true" refundable = "false">
                    <Price currency = "EUR" amount = "8.11" binding = "false" commission = "-1" minimumSellingPrice="-1"/>
                    <Code>SPE</Code>
                </Fee>
            </Fees>
            <CancelPenalties nonRefundable = "false">
               <CancelPenalty>
                  <HoursBefore>72</HoursBefore>
                  <Deadline>2014-01-01T05:00:00Z</Deadline>
                  <CalculatedDeadline>false</CalculatedDeadline>
                  <Penalty type = "Importe" paymentType = "pagoMinorista" currency = "EUR">29.95</Penalty>
               </CancelPenalty>
            </CancelPenalties>
         </Hotel>
         <TransactionStatus>
            <ComunicationStatus>OK</ComunicationStatus>
            <RSStatus>EXISTE</RSStatus>
            <ResStatus>OK</ResStatus>
         </TransactionStatus>
      </Reservation>
      <Reservation>
         <auditData>
            <timeStamp>2014-01-21T15:12:12.6657414+00:00</timeStamp>
            <processTimeMilliseconds>0</processTimeMilliseconds>
         </auditData>
         <operationImplemented>true</operationImplemented>
         <Locators>
            <Client>2578478</Client>
            <Provider>10TTT31</Provider>
         </Locators>
         <OptionType>soloHotel</OptionType>
         <IsOptionTypeSpecified>false</IsOptionTypeSpecified>
         <Hotel>
            <Name>LEO</Name>
            <Code>10</Code>
            <CreationDate>17/01/2014</CreationDate>
            <StartDate>28/01/2014</StartDate>
            <EndDate>29/01/2014</EndDate>
            <Holder name = "name" surname = "surname"/>
            <Price currency = "EUR" amount = "36.20" binding = "false" commission = "-1" minimumSellingPrice="-1"/>
            <Rooms>
               <Room id = "4582" roomCandidateRefId = "1" description = "Doble Standard.."/>
            </Rooms>
            <Fees>
                <Fee includedPriceOption = "true" description = "TaxAndServiceFee" mandatory = "true" refundable = "false">
                    <Price currency = "EUR" amount = "8.11" binding = "false" commission = "-1" minimumSellingPrice="-1"/>
                    <Code>SPE</Code>
                </Fee>
            </Fees>
            <CancelPenalties nonRefundable = "false">
               <CancelPenalty>
                  <HoursBefore>120</HoursBefore>
                  <Deadline>2014-01-01T05:00:00Z</Deadline>
                  <CalculatedDeadline>false</CalculatedDeadline>
                  <Penalty type = "Importe" paymentType = "pagoMinorista" currency = "EUR">72.40</Penalty>
               </CancelPenalty>
            </CancelPenalties>
         </Hotel>
         <TransactionStatus>
            <ComunicationStatus>OK</ComunicationStatus>
            <RSStatus>EXISTE</RSStatus>
            <ResStatus>OK</ResStatus>
         </TransactionStatus>
      </Reservation>
   </Reservations>
</ReservationListRS>

Success Response Data Breakdown

Element	Rel	Type	Description
ReservationListRS	1		Root node.
ReservationListRS/Reservations	0..1		Reservations.
Reservations/Reservation	1
Reservation/Locators	1		Information about the locators.
Locators/Client	0..1	String	Client locator.
Locators/Provider	0..1	String	Supplier locator.
Locators/Property	0..1	String	Property locator(see MetaData method in order to verify if the supplier implements it).
ReservationReadRS/OptionType	0..1	Enum	Defines the different types of hotel packages. OptionType Code Description 0 Hotel 1 HotelSkiPass 2 HotelSkiPassLessons 3 HotelSkiPassLessonsMeals 4 HotelSkiPassEquipmentLessons 5 HotelSkiPassEquipmentLessonsMeals 6 HotelTicket 7 HotelTicketTransfers 8 Gala 9 HotelSkiPassEquipment 10 HotelSkiPassMeals 11 HotelSkiPassEquipmentMeals 12 HotelActivity
ReservationReadRS/IsOptionTypeSpecified	0..1	Boolean	Indicates whether the OptionType field was specified or has the default value.
ReservationReadRS/Hotel	0..1		Hotel reservation.
Hotel/Code	0..1	String	Hotel Code.
Hotel/Name	0..1	String	Hotel Name.
Hotel/City	0..1	String	Hotel city.
Hotel/CreationDate	0..1	String	Date of booking.
Hotel/StartDate	0..1	String	Check-in date.
Hotel/EndDate	0..1	String	Check out date.
Hotel/MealPlanCode	0..1	String	Booking Mealplan code.
Hotel/Holder	0..1		Reservation Holder .
@name	1	String	Holder name.
@surname	1	String	Holder surname.
Hotel/Price	1		Price of the reservation.
@currency	1	String	Currency code (Our system uses a standard ISO - 3 for all suppliers).
@amount	1	Decimal	Total amount for the booking.
@binding	1	Boolean	If binding is set as true, then the client can’t sell the product for a lower price that the one set by the supplier. If it set as as false, the client can sell the product for a lower price.
@commission	1	Decimal	Commission Scenarios Commission Description 0 The price returned is net. -1 The supplier has not supplied the sale price nor the commission. This information is in the commercial contract with the supplier. Greater than 0 X = % of the commission applied to the amount.
@minimumSellingPrice	1	Decimal	Indicates the minimum selling price it can be sold (determined by the Seller). If is specified (different than "-1"), that field takes preference to amount. Minimum Selling Price Scenarios Minimum Selling Price Description 0 No minimum selling price is provided. -1 We have no information about MSP from the Seller. Greater than 0 The lowest possible amount that can be sold commercially.
Hotel/Rooms	0..1		List of rooms reserved
Rooms/Room	1..n		Details of room reserved.
@id	0..1	String	Identifier of the room.
@roomCandidateRefId	0..1	Integer	Identifier of room candidate.
@code	0..1	String	Room code.
@description	0..1	String	Room description.
Hotel/RoomCandidates	0..1		Rooms requested at the time of booking.
RoomCandidates/RoomCandidate	1..n		Room required.
@id	0..1	Integer	Id of the requested room (starting at 1).
RoomCandidate/Paxes	1..n		Pax required.
Paxes/Pax	1..n		Pax required.
@age	0..1	Integer	Passenger age on the day of check-in.
@id	0..1	Integer	Id of the requested room (starting at 1).
Hotel/Fees/Fee	0..n
@includedPriceOption	1	Boolean	Indicates if the fee is included or not in the final price. How to interpret includePriceOption Scenarios Payment Type includedPriceOption MerchantPay, CardBookingPay, CardCheckInPay If True the amount of the fee is already included in the price and is paid at the time of booking. If False, said fee have to be paid in the hotel. LaterPay In both cases if True or False, the amount of the fee has to be paid in the hotel, as the type of payment is LaterPay. The difference is that if includedPriceOption = False the client would have to sum the amount on their end. This is done if the supplier does not include it. This way, the client can show the fee on their web separated from the option price, and it’s now the client’s own decision how they should treat it.
@description	1	String	Remarks regarding fee.
@mandatory	1	Boolean	If the fee is obligatory, depending on the includedPriceOption to know if it is paid at the time of booking or at the hotel. In case it is false, it could be a fee such as "cleaning" that the consumer could hire if he wanted.
@refundable	1	Boolean	This field will serve to know if the rate to be paid is returned, for example when it is a deposit type that is returned once the stay ends.
Fee/Price	1
@currency	1	String	Currency code (Our system uses a standard ISO - 3 for all suppliers).
@amount	1	Decimal	Fee Amount.
@binding	1	Boolean	If binding is set as true, then the client can’t sell the product for a lower price that the one set by the supplier. If it set as as false, the client can sell the product for a lower price.
@commission	1	Decimal	Commission Scenarios Commission Description 0 The price returned is net. -1 The supplier has not supplied the sale price nor the commission. This information is in the commercial contract with the supplier. Greater than 0 X = % of the commission applied to the amount.
@minimumSellingPrice	1	Decimal	Indicates the minimum selling price it can be sold (determined by the Seller). If is specified (different than "-1"), that field takes preference to amount. Minimum Selling Price Scenarios Minimum Selling Price Description 0 No minimum selling price is provided. -1 We have no information about MSP from the Seller. Greater than 0 The lowest possible amount that can be sold commercially.
Fee/Code	1	String	Specifies the fee code in case it has one.
Hotel/CancelPenalties	0..1		Information of cancellation policies.
@nonRefundable	1	Boolean	Indicate if this option is nonRefundable (true or false).
CancelPenalties/CancelPenalty	0..n		Listing of cancellation penalties.
CancelPenalty/HoursBefore	1	String	Number of hours prior to arrival day in which this Cancellation policy applies.
CancelPenalty/Deadline	1	String	Date on UTC Standard TimeZone in which this Cancellation policy applies (ISO 8601 e.g: 2016-07-01T05:00:00Z)
CancelPenalty/CalculatedDeadline	1	Boolean	Indicate if the Deadline is returned by the supplier or it's been calculated by Travelgate.If true, the deadline has been converted to UTC-0 by Travelgate. If False, the supplier returns the deadline on UTC-0, so no calculation is needed.
CancelPenalty/Penalty	1		Contains the value to be applied in net price.
@type	1	String	Types of penalties Penalty Description Noches Indicates the number of nights to be penalized. Porcentaje Indicates the percentage to pay based on the option price. Importe Indicates the exact amount payable.
@paymentType	1	String	Indicates payment type.
@currency	1	String	Currency code (Our system uses a standard ISO - 3 for all suppliers).
Hotel/Remarks	0..1	String	Remarks.
ReservationReadRS/TransactionStatus	1		Status.
TransactionStatus/ComunicationStatus	1	String	Status communication (OFFLINE, OK and KO).
TransactionStatus/RSStatus	1	String	Response Status Status Description DESCONOCIDO Unknown EXISTE Exists EXISTECANCELADA exists but it's cancelled NO_EXISTE Does not exist
TransactionStatus/ResStatus	1	String	Reservation Status Status Code Description OK The reservation was completed with no problems. RQ The reservation was completed but the product is still not available, so the reservation goes into a waiting list (Request). CN The reservation was completed but due to a supplier error or a timeout the system will immediately cancel the reservation to prevent further possible errors. UN During the reservation process, an issue led to an unknown reservation status. The Buyer is responsible for verifying with the Seller that the booking has been confirmed.

Error

<ReservationListRS>
   <operationImplemented>true</operationImplemented>
   <applicationError>
      <code/>
      <type>105</type>
      <description>Communication Error.</description>
      <httpStatusCode>0</httpStatusCode>
   </applicationError>
</ReservationListRS>

Error types that you will need to include in the response in the event of an error

Error Type	Error Description	Comments
101	System Exception.	Exception not controlled or not classified as general exception.
102	Provider Error.	You return a particular code/description for an error, which is then transmitted to the Buyer in our response.
103	Too many requests to the supplier.	Your Buyer has surpassed the agreed-upon request limit with you.
104	Connection Timeout With Provider.	Your response time has exceeded the timeout set in the Buyer's request.
105	Communication Error.	The connection with your system has been refused.
105	Payload too high.	The size of your response surpasses the size limitation established on our side for optimal performance (20000 options or 15MB).
204	No results found.	You don't return any results for the specific availability criteria set in the Buyer's request (e.g. hotel, dates, market, etc.).
205	Room Candidate Not Supported.	The number of room candidates in Buyer's request exceeds the maximum set by you.
206	Dates Not Supported.	Buyer availability request does not align with your date specifications.
207	Request XML not accepted by Supplier.	Buyer availability request does not align with your specifications.
301	Option Not Found In Valuation.	You fail to return the option previously chosen by the Buyer in Search response (the option is no longer available). This error can be encountered in Quote response and Book response (whenever the integration requires an additional Quote to the Seller).
302	Hotel not found.	Our system is unable to locate the hotel the Buyer requested in your Hotels (DescriptiveInfo) method.
303	Booking not confirmed.	You haven't been able to confirm a booking for some reason (is not very common and might be returned in reservation response).