Skip to main content
Deprecated API

The Legacy Pull Buyers API, our initial Buyers API launched in 2012, is now deprecated and should not be further developed. Instead, we introduced the Hotel-X Buyers API in 2017, which serves as the sole API for new Buyers looking to integrate and participate in our Marketplace.

Reservation List

Reservation List allows you 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.

caution

The amount of information returned might vary between Sellers.

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 = "22334"></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

info

Check the values you need to add in the header and common elements.

ElementRelTypeDescription
ReservationListRQ1Root node.
ReservationListRQ/DateType1StringType search (A = arrival date, B = booking creation).
ReservationListRQ/Start1StringStart date.
ReservationListRQ/End1StringEnd date.

ReservationList Response

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

The response options include either success or an error. In the event of success, you will receive 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>
<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>
<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>
<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>
<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

ElementRelTypeDescription
ReservationListRS1Root node.
ReservationListRS/Reservations0..1Reservations.
Reservations/Reservation1
Reservation/Locators1Information about the locators.
Locators/Client0..1StringClient locator.
Locators/Provider0..1StringSupplier locator.
Locators/Property0..1StringProperty locator(see MetaData method in order to verify if the supplier implements it).
ReservationReadRS/Hotel0..1Hotel reservation.
Hotel/Code0..1StringHotel Code.
Hotel/Name0..1StringHotel Name.
Hotel/City0..1StringHotel city.
Hotel/CreationDate0..1StringDate of booking.
Hotel/StartDate0..1StringCheck-in date.
Hotel/EndDate0..1StringCheck out date.
Hotel/MealPlanCode0..1StringBooking Mealplan code.
Hotel/Holder0..1Reservation Holder .
@name1StringHolder name.
@surname1StringHolder surname.
Hotel/Price1Price of the reservation.
@currency1StringCurrency code (Our system uses a standard ISO - 3 for all suppliers).
@amount1DecimalTotal amount for the booking.
@binding1BooleanIf 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.
@commission1Decimal
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.
@minimumSellingPrice1DecimalIndicates 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/Rooms0..1List of rooms reserved
Rooms/Room1..nDetails of room reserved.
@id0..1StringIdentifier of the room.
@roomCandidateRefId0..1IntegerIdentifier of room candidate.
@code0..1StringRoom code.
@description0..1StringRoom description.
Hotel/RoomCandidates0..1Rooms requested at the time of booking.
RoomCandidates/RoomCandidate1..nRoom required.
@id0..1IntegerId of the requested room (starting at 1).
RoomCandidate/Paxes1..nPax required.
Paxes/Pax1..nPax required.
@age0..1IntegerPassenger age on the day of check-in.
@id0..1IntegerId of the requested room (starting at 1).
Hotel/CancelPenalties0..1Information of cancellation policies.
@nonRefundable1BooleanIndicate if this option is nonRefundable (true or false).
CancelPenalties/CancelPenalty0..nListing of cancellation penalties.
CancelPenalty/HoursBefore1StringNumber of hours prior to arrival day in which this Cancellation policy applies.
CancelPenalty/Deadline1StringDate on UTC Standard TimeZone in which this Cancellation policy applies (ISO 8601 e.g: 2016-07-01T05:00:00Z)
CancelPenalty/CalculatedDeadline1BooleanIndicate 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/Penalty1Contains the value to be applied in net price.
@type1String
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.
@paymentType1StringIndicates payment type.
@currency1StringCurrency code (Our system uses a standard ISO - 3 for all suppliers).
Hotel/Remarks0..1StringRemarks.
ReservationReadRS/TransactionStatus1Status.
TransactionStatus/ComunicationStatus1StringStatus communication (OFFLINE, OK and KO).
TransactionStatus/RSStatus1String
Response Status
Status Description
DESCONOCIDO Unknown
EXISTE Exists
EXISTECANCELADA exists but it's cancelled
NO_EXISTE Does not exist
TransactionStatus/ResStatus1String
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 The reservation was completed but due to a supplier error or a timeout, the reservation status is unknown. It is the client’s responsibility to check if the booking is OK.

Error

<ReservationListRS>
<operationImplemented>true</operationImplemented>
<applicationError>
<code/>
<type>105</type>
<description>Communication Error.</description>
<httpStatusCode>0</httpStatusCode>
</applicationError>
</ReservationListRS>
Error types that will be included in the response in the event of an error
Error TypeError DescriptionComments
101System Exception.Exception not controlled or not classified as general exception.
102Provider Error.Seller returns a particular code/description for an error, which is then transmitted to you in our response.
103Too many requests to the supplier.Your account has surpassed the agreed-upon request limit with the Seller.
104Connection Timeout With Provider.The Seller's response time has exceeded the timeout set in the Buyer's request.
105Communication Error.The connection to the Seller has been refused (we haven't been able to connect to their system).
105Payload too high.The size of the response by the Seller surpasses the size limitation established on our side for optimal performance (20000 options or 15MB).
204No results found.Seller does not return any results for the specific availability criteria set in the Buyer's request (e.g. hotel, dates, market, etc.).
205Room Candidate Not Supported.The number of room candidates in your request exceeds the maximum set by the Seller.
206Dates Not Supported.Your availability request does not align with the Seller's date specifications.
207Request XML not accepted by Supplier.Your availability request does not align with the Seller's specifications.
301Option Not Found In Valuation.Seller fails 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).
302Hotel not found.Our system is unable to locate the hotel you requested in your Hotels (DescriptiveInfo) method
303Booking not confirmed.Seller hasn't been able to confirm a booking for some reason (is not very common and might be returned in reservation response).