This message indicates the result of processing the OTA_HotelReadResRQ message, in both cases of success or error.
XML Description
OTA_HotelReadResRS
| Parameter |
Data Type |
Description |
|---|
| xmlns |
URL |
- |
| EchoToken |
String |
- |
| TimeStamp |
- |
- |
| Version |
- |
- |
| HtConfirmationCode |
Object |
The unique Hotel Trader Confirmation code for the reservation is enclosed within this tag. |
| ClientConfirmationCode |
Object |
The unique client confirmation code for this reservation is enclosed within this tag. |
| OtaConfirmationCode |
Object |
The OTA confirmation code for this reservation is enclosed within this tag. |
| OtaClientName |
Object |
The OTA to which the Client is selling to provided at the time of making the reservation. |
| BookingDate |
Object |
The date on which the reservation was made with Hotel Trader. |
| ConsolidatedComments |
Object |
A single line of comments can be displayed in the comments section of the booking confirmation sent to the end user. |
| ConsolidatedHTMLComments |
Object |
The HTML format of the Consolidated Comments that can be directly displayed without parsing. |
| SpecialRequests |
Object |
Node that contains the special request sent as part of the reservation. |
| PropertyDetails |
Object |
A node that contains the firmographic information about the property. |
| AggregateGrossPrice |
Object |
Aggregate Gross price for the booking. Rounded off to 2 decimal places. |
| AggregateNetPrice |
Object |
Aggregate Net price for the booking. Rounded off to 2 decimal places. |
| AggregateTax |
Object |
Aggregate Tax for the booking. Rounded off to 2 decimal places. |
| AggregatePayAtProperty |
Object |
Aggregate PayAtProperty for the booking. Rounded off to 2 decimal places. |
| Rooms |
Object |
This element contains the Room that is being booked. |
SpecialRequests
| Parameter |
Data Type |
Description |
|---|
| SpecialRequest |
Object |
The special requests made as a part of this reservation are enclosed within this tag. |
PropertyDetails
| Parameter |
Data Type |
Description |
|---|
| PropertyName |
Object |
This tag encloses the name of the hotel at which this reservation was made. |
| PropertyId |
Object |
This tag encloses the property ID of the hotel. |
| City |
Object |
This tag encloses the city of the hotel. |
| HotelImageUrl |
String |
URL for property image if available. |
| Address |
Object |
This node contains the address of the hotel at which this reservation was made. |
| Latitude |
Object |
This tag encloses the latitude of the hotel. |
| Longitude |
Object |
This tag encloses the longitude of the hotel. |
| StarRating |
Object |
This tag encloses the StarRating of the hotel. |
| CheckInTime |
Object |
This tag encloses the CheckInTime of the hotel. |
| CheckOutTime |
Object |
This tag encloses the CheckOutTime of the hotel. |
| CheckInPolicy |
Object |
Defines the check-in policy for the hotel. |
| TimeZone |
Object |
This tag encloses the TimeZone of the hotel. The check-in and check-out times are in this time zone. |
| ShortDescription |
Object |
This tag encloses a short description of the property. |
| LongDescription |
Object |
This tag encloses a long description of the property. |
| MinAdultAgeForCheckIn |
Object |
This tag provides the minimum adult age for check-in. |
| Modifiable |
Object |
Boolean value. |
Rooms
| Parameter |
Data Type |
Description |
|---|
| Room |
Object |
This element contains the details of the room booked as a part of this reservation. In the case of multi-room bookings, each Room node corresponds to each room of the booking. |
Room
| Parameter |
Data Type |
Description |
|---|
| HtRoomConfirmationCode |
Object |
This tag includes the Hotel Trader's room confirmation number. |
| ClientRoomConfirmationCode |
Object |
This tag includes the Client's room confirmation number. |
| CrsConfirmationCode |
Object |
This tag includes the CRS confirmation code for the reservation. |
| CrsCancelConfirmationCode |
Object |
This tag includes the cancellation code, received from the CRS in case of a canceled reservation. |
| PmsConfirmationCode |
Object |
This tag includes the confirmation code received from the PMS for this reservation. |
| CheckInDate |
Object |
This tag includes the check-in date for this room reservation. |
| CheckOutDate |
Object |
This tag includes the check-out date for this room reservation. |
| RateplanTag |
Object |
This tag includes the rateplan associated with this roomtype as part of the reservation. |
| ShortDescription |
Object |
This tag encloses a short description of the room. |
| LongDescription |
Object |
This tag encloses a long description of the room. |
| RateplanCode |
Object |
This tag encloses the rateplan code for this room. |
| RoomName |
Object |
This tag encloses the name of the room. |
| IsRefundable |
Object |
This tag encloses a boolean value denoting whether this is refundable or not. |
| Cancelled |
Object |
This tag encloses a boolean value denoting whether this room has been canceled or not. |
| CancellationDate |
Object |
This tag encloses the date on which the reservation was canceled if it is a canceled reservation. |
| CancellationFee |
Object |
This tag encloses the amount applicable for payment in case of a cancellation. |
| CancellationPolicies |
Object |
This node provides the cancellation policies as applicable to this booking. |
| Rates |
Object |
This node provides a breakdown of the room rates. |
| Occupancy |
Object |
List of occupancies. Each occupancy contains guest details for a room. |
| Guests |
Object |
Guest details for the room. Always 1 entry for each room. |
| RoomSpecialRequests |
Object |
This node includes the extra comments from guests or any special requests to the hotel. |
| MealplanOptions |
Object |
Meal plan options for the booking, if any. |
CancellationPolicies
| Parameter |
Data Type |
Description |
|---|
| CancellationPolicy |
Object |
This node provides the details of the cancellation policy. |
CancellationPolicy
| Parameter |
Data Type |
Description |
|---|
| StartWindowHours |
Object |
- |
| EndWindowHours |
Object |
- |
| StartWindowTime |
Object |
Start time in hours for this window from check-in time. |
| EndWindowTime |
Object |
End time in hours for this window from check-in time. |
| Currency |
Object |
This tag encloses the currency in which the reservation was made. |
| CancellationCharge |
Object |
The amount that will be forfeited if a cancellation is effected in this cancellation window. |
| CancelTime |
Object |
- |
| TimeZone |
Object |
Time-zone identifier of the property. |
Rates
| Parameter |
Data Type |
Description |
|---|
| NetPrice |
Object |
This is the total price for the stay excluding taxes/fees. |
| Tax |
Object |
This is the total tax for the stay excluding taxes/fees which are payable at the property. |
| GrossPrice |
Object |
This is the total price for the stay including taxes/fees. Taxes which are payable upon arrival at the property are not included. |
| CurrencyCode |
Object |
Currency in which the prices are charged. |
| PayAtProperty |
Object |
There will be some fee which is collected on the arrival at the property. This amount is not is not included in the rates. This fee is collected to provide guests with services, amenities, and value-added offerings. |
| DailyPrices |
Object |
This node encloses the element that provides a list of daily prices, excluding taxes/fees. |
| DailyTaxes |
Object |
This node encloses the element that provides a list of daily taxes. |
| TaxInfo |
Object |
This node provides a break-up of the tax information for this booking. |
| Commissionable |
Object |
This boolean node indicates whether these are commissionable rates or not. |
TaxInfo
| Parameter |
Data Type |
Description |
|---|
| PaymentsAtBooking |
Object |
This node contains the break-down of all payments applicable at the time of booking |
| PaymentsAtProperty |
Object |
This node contains the breakdown of all payments that must be made at the property. |
PaymentsAtBooking
| Parameter |
Data Type |
Description |
|---|
| PaymentAtBooking |
Object |
List of payments applicable at the time of booking. |
PaymentAtBooking
| Parameter |
Data Type |
Description |
|---|
| Date |
Object |
Date of booking |
| Name |
Object |
The name of the tax line item is enclosed in this tag. |
| Currency |
Object |
Currency in which the payment was made. |
| Value |
Object |
The amount. |
PaymentsAtProperty
| Parameter |
Data Type |
Description |
|---|
| PaymentAtProperty |
Object |
The list of all payments that must be made by the guest at the property. |
PaymentAtProperty
| Parameter |
Data Type |
Description |
|---|
| Date |
Object |
Date of booking |
| Name |
Object |
The name of the tax line item is enclosed in this tag. |
| Currency |
Object |
Currency in which the payment was made. |
| Value |
Object |
The amount. |
Occupancy
| Parameter |
Data Type |
Description |
|---|
| NoOfAdults |
Object |
Enclosed is the numeric value denoting the number of adults included in this booking. |
| NoOfChildren |
Object |
Encloses the numeric value denoting the number of childeren included in this booking. |
Guests
| Parameter |
Data Type |
Description |
|---|
| Guest |
Object |
Details of the guest. |
Guest
| Parameter |
Data Type |
Description |
|---|
| FirstName |
Object |
First name of the guest |
| LastName |
Object |
Last name of the guest |
| Email |
Object |
Email of the guest |
| Phone |
Object |
The phone or contact number of the guest |
| IsAdult |
Object |
Boolean value, true if guest is adult, false otherwise |
| IsPrimary |
Object |
Boolean value, true if this guest is primary for the Room, false otherwise |
RoomSpecialRequests
| Parameter |
Data Type |
Description |
|---|
| RoomSpecialRequest |
Object |
The special request is enclosed in this tag for the room. |
MealplanOptions
| Parameter |
Data Type |
Description |
|---|
| BreakfastIncluded |
Object |
Boolean, true if breakfast is included, false otherwise. |
| LunchIncluded |
Object |
Boolean, true if lunch is included, false otherwise. |
| DinnerIncluded |
Object |
Boolean, true if dinner is included, false otherwise. |
| AllInclusive |
Object |
Boolean, true if breakfast, lunch, and dinner are included, false otherwise. |
| MealplanDescription |
Object |
Describe the mealplan included as part of the rateplan for this room. |
Sample Success response
<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header />
<SOAP-ENV:Body>
<OTA_HotelReadResRS xmlns:ns2="http://www.opentravel.org/OTA/2003/05" EchoToken="ab3edd47-fa8e-4f45-8a70-10324b560250" PrimaryLangID="en" TimeStamp="2024-05-10T09:56:22.276Z" Version="0">
<HtConfirmationCode>HT-IOXRKL</HtConfirmationCode>
<ClientConfirmationCode>256-10000158</ClientConfirmationCode>
<BookingDate>2024-05-09T07:30:17.000-0700</BookingDate>
<ConsolidatedComments>Hotel Check In Policy: Major credit card required at check-in for deposit and incidentals. Any additional fees such as parking, pet fees, etc. are solely at the discretion of the hotel, are subject to change at any point and should be paid directly by the guest. **OYO Las Vegas Hotel & Casino hotel only accept Debit/Credit card for deposit, incidentals or any additional charges as per policy, this property does not accept cash deposits.** Upon check-in, the Front Desk authorizes a $300 hold on a credit/debit card for incidentals, in addition to room and tax. . Reservation is refundable but nonModifiable. Minimum adult age at check in is 21 years.</ConsolidatedComments>
<ConsolidatedHTMLComments><ul><li>Hotel Check In Policy: Major credit card required at check-in for deposit and incidentals. Any additional fees such as parking, pet fees, etc. are solely at the discretion of the hotel, are subject to change at any point and should be paid directly by the guest. **OYO Las Vegas Hotel & Casino hotel only accept Debit/Credit card for deposit, incidentals or any additional charges as per policy, this property does not accept cash deposits.** Upon check-in, the Front Desk authorizes a $300 hold on a credit/debit card for incidentals, in addition to room and tax. . </li><li>Reservation is refundable but nonModifiable. </li><li>Minimum adult age at check in is 21 years. </li></ul></ConsolidatedHTMLComments>
<PropertyDetails>
<PropertyName>OYO Las Vegas Hotel & Casino</PropertyName>
<PropertyId>236148</PropertyId>
<City>Las Vegas</City>
<Address>
<Address1>115 E Tropicana Ave</Address1>
<Address2 />
<CityName>Las Vegas</CityName>
<StateName>Nevada</StateName>
<ZipCode>89109</ZipCode>
<CountryCode>US</CountryCode>
</Address>
<Latitude>36.0997436</Latitude>
<Longitude>-115.16749299999998</Longitude>
<StarRating>3.5</StarRating>
<CheckInTime>4:00 PM</CheckInTime>
<CheckOutTime>11:00 AM</CheckOutTime>
<CheckInPolicy>Major credit card required at check-in for deposit and incidentals. Any additional fees such as parking, pet fees, etc. are solely at the discretion of the hotel, are subject to change at any point and should be paid directly by the guest. **OYO Las Vegas Hotel & Casino hotel only accept Debit/Credit card for deposit, incidentals or any additional charges as per policy, this property does not accept cash deposits.** Upon check-in, the Front Desk authorizes a $300 hold on a credit/debit card for incidentals, in addition to room and tax.</CheckInPolicy>
<TimeZone>America/Los_Angeles</TimeZone>
<ShortDescription>Experience Vegas with comfort and style at OYO Hotel & Casino Las Vegas. Conveniently located one block from the Las Vegas Strip. Parking fee - Hotel overnight guest parking is $18/night.</ShortDescription>
<LongDescription>Experience Vegas with comfort and style at OYO Hotel and Casino Las Vegas. Conveniently located one block from the Las Vegas Strip.
 
 OYO Las Vegas Hotel and Casino is committed to providing its guests and associates with a smoke-free environment. Smoking tobacco, pipes, vapes, e-cigarettes and marijuana is strictly prohibited within the hotel. By booking through this website, you acknowledge that the hotel has installed smoking detection sensors provided by NoiseAware in its rooms. NoiseAware is a smart device that allows hotel management to respond to smoking events without disrupting your stay. You hereby agree and consent to the use of such sensor in your room and acknowledge and agree that it is 100% privacy compliant and required by the hotel. By acknowledging the foregoing, you agree to waive any future claims related to the presence of the sensor in a room you may book. Tampering with the sensor is strictly prohibited.</LongDescription>
<MinAdultAgeForCheckIn>21</MinAdultAgeForCheckIn>
<Modifiable>false</Modifiable>
</PropertyDetails>
<AggregateGrossPrice>113.40</AggregateGrossPrice>
<AggregateNetPrice>100.02</AggregateNetPrice>
<AggregateTax>13.38</AggregateTax>
<AggregatePayAtProperty>0.00</AggregatePayAtProperty>
<Rooms>
<Room>
<HtRoomConfirmationCode>HT-IOXRKL-1</HtRoomConfirmationCode>
<ClientRoomConfirmationCode>256-10007158-1</ClientRoomConfirmationCode>
<CrsConfirmationCode>LVOYOH116005864</CrsConfirmationCode>
<CrsCancelConfirmationCode>CNCLLVOYOH116005864</CrsCancelConfirmationCode>
<CheckInDate>2024-05-14</CheckInDate>
<CheckOutDate>2024-05-17</CheckOutDate>
<ShortDescription>350-square-foot room with two double beds</ShortDescription>
<LongDescription>Roomy 350 to 370 square foot room with two double beds.
 
 Relax in this spacious room with two double beds. The room has modern d�cor with side seating perfect for work or enjoying a snack. Unwind in front of a flat screen TV as you plan your fun night out in the city that never sleeps. This is the perfect launching point for friends and family to explore Las Vegas.
 Your room is your room. Your Well-being is Our Top Priority. No hotel personnel will enter your room during your stay without your permission. View our Commitment to Cleanliness page for more details.
</LongDescription>
<RateplanCode>HTRP1</RateplanCode>
<RoomName>Standard Two Double</RoomName>
<IsRefundable>true</IsRefundable>
<Cancelled>true</Cancelled>
<CancellationDate>2024-05-09T08:30:08.000-0700</CancellationDate>
<CancellationFee>0.00</CancellationFee>
<CancellationPolicies>
<CancellationPolicy>
<StartWindowHours>0</StartWindowHours>
<EndWindowHours>48</EndWindowHours>
<StartWindowTime>2024-05-12 16:00:00</StartWindowTime>
<EndWindowTime>2024-05-14 16:00:00</EndWindowTime>
<Currency>USD</Currency>
<CancellationCharge>16.20</CancellationCharge>
<CancelTime>2024-05-14 16:0:00</CancelTime>
<TimeZone>America/Los_Angeles</TimeZone>
</CancellationPolicy>
</CancellationPolicies>
<Rates>
<NetPrice>100.02</NetPrice>
<Tax>13.38</Tax>
<GrossPrice>113.40</GrossPrice>
<CurrencyCode>USD</CurrencyCode>
<PayAtProperty>0</PayAtProperty>
<DailyPrices>
<DailyPrice>0</DailyPrice>
<DailyPrice>0</DailyPrice>
<DailyPrice>0</DailyPrice>
</DailyPrices>
<DailyTaxes>
<DailyTax>0</DailyTax>
<DailyTax>0</DailyTax>
<DailyTax>0</DailyTax>
</DailyTaxes>
<TaxInfo>
<PaymentsAtBooking>
<PaymentAtBooking>
<Date>2024-05-14</Date>
<Name>Occupancy Tax</Name>
<Description />
<Currency>USD</Currency>
<Value>0</Value>
</PaymentAtBooking>
<PaymentAtBooking>
<Date>2024-05-15</Date>
<Name>Occupancy Tax</Name>
<Description />
<Currency>USD</Currency>
<Value>0</Value>
</PaymentAtBooking>
<PaymentAtBooking>
<Date>2024-05-16</Date>
<Name>Occupancy Tax</Name>
<Description />
<Currency>USD</Currency>
<Value>0</Value>
</PaymentAtBooking>
</PaymentsAtBooking>
<PaymentsAtProperty>
<PaymentAtProperty>
<Date>2024-05-14</Date>
<Name>Resort Fee</Name>
<Description>
The nightly Resort Fee is $44.95 plus tax per night. (Totals $50.96 per night)$5 in free slot play and $10 in table games match play High-speed Wi-Fi in guest rooms. Hooter's Early Bird 10% off between 2 pm - 5 pm. Bottled water in guest rooms, 2 daily. 24-hour access to the Fitness Center equipped with Peloton bikes. Access to the Pool - Seasonal. Unlimited local and 1-800 calls. Printing boarding passes *OYO Rewards Membership is free. Must be 21 years of age or older. The resort fee is subject to change.
</Description>
<Currency>USD</Currency>
<Value>0</Value>
</PaymentAtProperty>
<PaymentAtProperty>
<Date>2024-05-15</Date>
<Name>Resort Fee</Name>
<Description>The nightly Resort Fee is $44.95 plus tax per night. (Totals $50.96 per night)$5 in free slot play and $10 in table games match play High-speed Wi-Fi in guest rooms. Hooter's Early Bird 10% off between 2 pm - 5 pm. Bottled water in guest rooms, 2 daily. 24-hour access to the Fitness Center equipped with Peloton bikes. Access to the Pool - Seasonal. Unlimited local and 1-800 calls. Printing boarding passes *OYO Rewards Membership is free. Must be 21 years of age or older. The resort fee is subject to change.</Description>
<Currency>USD</Currency>
<Value>0</Value>
</PaymentAtProperty>
<PaymentAtProperty>
<Date>2024-05-16</Date>
<Name>Resort Fee</Name>
<Description>The nightly Resort Fee is $44.95 plus tax per night. (Totals $50.96 per night)$5 in free slot play and $10 in table games match play High-speed Wi-Fi in guest rooms. Hooter's Early Bird 10% off between 2 pm - 5 pm. Bottled water in guest rooms, 2 daily. 24-hour access to the Fitness Center equipped with Peloton bikes. Access to the Pool - Seasonal. Unlimited local and 1-800 calls. Printing boarding passes *OYO Rewards Membership is free. Must be 21 years of age or older. The resort fee is subject to change.</Description>
<Currency>USD</Currency>
<Value>0</Value>
</PaymentAtProperty>
</PaymentsAtProperty>
</TaxInfo>
<Commissionable>false</Commissionable>
</Rates>
<Occupancy>
<NoOfAdults>2</NoOfAdults>
<NoOfChildren>0</NoOfChildren>
</Occupancy>
<Guests>
<Guest>
<FirstName>John</FirstName>
<LastName>Doe</LastName>
<Email>testbeds@hoteltrader.com</Email>
<IsAdult>true</IsAdult>
<IsPrimary>true</IsPrimary>
</Guest>
<Guest>
<FirstName>Jane</FirstName>
<LastName>Doe</LastName>
<Email>testbeds@hoteltrader.com</Email>
<IsAdult>true</IsAdult>
<IsPrimary>false</IsPrimary>
</Guest>
</Guests>
<MealplanOptions>
<BreakfastIncluded>false</BreakfastIncluded>
<LunchIncluded>false</LunchIncluded>
<DinnerIncluded>false</DinnerIncluded>
<AllInclusive>false</AllInclusive>
<MealplanDescription>Room Only</MealplanDescription>
</MealplanOptions>
</Room>
</Rooms>
</OTA_HotelReadResRS>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Sample Error Response
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<SOAP-ENV:Body>
<OTA_HotelReadResRS xmlns:ns2="http://www.opentravel.org/OTA/2003/05" EchoToken="ab3edd47-fa8e-4f45-8a70-10324b560250" TimeStamp="2024-04-19T16:05:19.601+05:30" Version="1.001">
<Errors>
< Error Code="1602" ShortText="Reservation not found" Type="Reservation not found"/>
</Errors>
</OTA_HotelReadResRS>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
For a complete list of error codes and description, refer to the
ARI Error Codes section in
Error Codes page in our Knowledge Base.