Introduction
This document contains the specifications for the XML Services of ObeHotel system. These services allow us to offer to our "business to business/B2B" partners, a complete process for making hotel reservations via an XML system.
We have developed the most frequently used services, and we must point out that our partners do not have to develop all the available functions. We recommend that only the necessary functions required for your particular application are used. For the purpose of this document, the functions have been joined together in the following groups according to their type.
- Availability Requests: This group covers the requests which allow you to obtain all the information regarding availability in the hotels. The availability is provided according to the dates of the hotel stay, the number of guests, number of nights, and destination.
- Reservation Requests: This is a group of requests which allows our B2B partner to carry out the whole process for booking a room in a hotel. Also included within this group, are cancellation functions and status of the reservation.
- Information Requests: The aim of these requests is to acquire various types of information about the hotel. In this group, there are requests which are necessary in order to acquire the location of the hotel, or its facilities, or also to see the different photos available for the hotel.
Please find below a diagram showing a possible combination of XML requests, all of which have the final objective of completing a reservation in a hotel.
As can be seen in the diagram above, between the B2B Partner and the server there is a flow of data. This process of interaction consists of the B2B partner making a call (request) to the server of the XML services of ObeHotel system. At the precise moment that the server receives the call, it consults the type of request to be dealt with. Following on from this, and according to the type of request, the server obtains the corresponding data from our database and generates a reply (response). This reply is returned in XML to the B2B Partner. Finally, the B2B Partner analyses the XML reply and obtains the data they require.
In order to generate and process XML, the support of a dynamic programming language is necessary.
Acces specifications
The services for B2B Partners are housed in one of the servers belonging to ObeHotel system. In order to be able to access the XML interface, an identifier is needed (Agency-IdUser) .The identifier is provided to the B2B Partner by our commercial department and is only for a designated user and is non transferable.
There are various ways of making calls (requests) to the server ObeHotel has opted for the GET variable. Access to the services is made through a HTTP request to a server. This request must contain the XML coding directly in a variable called xml.
For the first part of the integration, the requests should be made in the development server. In this server it is possible to make all kinds of requests and reservations. None of these reservations will be real. The URL for the XML services via the development server is:
Development Server = http://x.x.x.x/mpobe? (this url will be provided by your technical contact)
Once the B2B Partner has completed the integration and all is working correctly, Efimatica S.L will activate the account in the production server. As soon as the account has been activated, all requests made by the B2B Partner will be in a real environment and in real time. The URL for productions services is:
Production Server = http://x.x.x.x/mpobe? (this url will be provided by your technical contact)_introduction.md
XML Requests: Hotel
Get hotel information
Request
<?xml version="1.0" encoding="UTF-8" ?>
<OTA_HotelInfoRQ PrimaryLangID="es">
<Agency UserId="xxxxx"/>
<Hotel Code="12"/>
</OTA_HotelInfoRQ>
Response
<?xml version="1.0" encoding="UTF-8"?>
<OTA_HotelInfoRS TimeStamp="2015-03-02T12:28:12" Target="Development">
<Hotel Code="6" Name="MedPlaya Hotel Calypso" Category="3" />
<Location Address="Pompeu Fabra, 54-62" City="Salou" PostalCode="43840" Province="Tarragona" Country="Spain" />
<Contact Phone="+34 977 384 900" Fax="+34 977 383 513" Email="calypso@medplaya.com" EmailBooking="booking.calypso@medplaya.com" />
<GPS Longitude="1.154460310936" Latitude="41.071644417044" />
<Website>
<![CDATA[http://www.medplaya.com]]>
</Website>
<Logo>
<![CDATA[/files/hotel/calypso/3d/calypso-3d_mini_152x96.jpg]]>
</Logo>
<Description>
<![CDATA[<p>The Hotel Calypso, located in Salou, is just 10 minutes from the beach, 3km from the Port Aventura theme park, and 12km from the Reus Airport. There are 532 double rooms, all with full bathrooms, balconies, air conditioning and telephones. The restaurant is buffet-style and in the summer you can enjoy the open air restaurant.</p><p><strong>All In</strong> The All Inclusive, from Medplaya Hotels offers family fun whilst at the same time making your holiday money go further. <br /><br />The Hotel Calypso has two swimming pools, hydro-massage and many other facilities and services to help you enjoy your stay. A particular highlight is the different daytime and night-time entertainment programs as well as the shows and thematic dinners. <br /><br />The Hotel Calypso is located in Salou, one of the main tourist centres of the Costa Dorada. This coast enjoys an exceptional climate with beautiful fine-sand beaches and coves. It offers a variety of ways to enjoy the sea with all kinds of water sports. Salou is also an excellent point from which to set off and explore many of the marvellous spots on the coast and throughout the province of Tarragona.</p>]]>
</Description>
<CancelPenalty>
<Refundable>
<Description>
<![CDATA[<p><strong>NOTE</strong>: The ages of the children are between 3 and 12.</p><p>Cancellations confirmed up to 48 hours prior to arrival date will incur <span style=color: #008000;><strong>no cancellation fees</strong></span>. <br /><br />In case of cancellation within 48 hours of the arrival date, a cancellation fee - equal to one night accommodation, will be charged.</p><p>If you do not arrive at the hotel on the reserved arrival date, your reservation will be automatically cancelled.<br /><br /><strong>Tourist tax information</strong></p><p>These prices do not include the tourist or similar tax on hotel stays.<br /> <br />We would like to inform you that in the Community of Catalonia there is a tax on stays at tourist establishments. The basic aspects of this tax are as follows: <br />a) The tax does not apply to 16 year olds and minors.<br />b) The amount of the Tax is € 0.50 per person per day with a maximum of 7 nights. In the case of 4 **** hotels the amount is €1.<br /> <br />The amount of the tax or corresponding fee must be paid, providing the corresponding legal requirements have been met, on the customer’s day of arrival, in the hotel reception. For this reason the customer must be informed of this obligation before entering into the travel contract.</p>]]>
</Description>
<Conditions>
<Penalty Item="1" Percent="50" Nights="none" DaysToCheckin="2" CancellationFees="188.00"/>
</Conditions>
</Refundable>
<NonRefundable>
<Description>
<![CDATA[<p><strong><strong>Advance payment:</strong> </strong>The full amount or the percentage indicated in the room conditions will be charged upon making the reservation.<br /><br /><strong>Cancellations Non-Refundable: </strong> if you cancel or modify your reservation, the hotel will charge you either the full amount of your stay or will bill the amount deposited with your credit card as a guarantee of you reservation. If you fail to arrive at the hotel on the check in date, you will be charged for the full stay.<br /><br /><strong>Amigo Card Holders:</strong> Amigo points cannot be redeemed for non refundable bookings</p><p><em><strong>NOTE</strong>: The ages of the children are between 2 and 12.</em></p><p><em> </em></p><p><strong>Tourist tax informaction</strong></p><p>These prices do not include the tourist or similar tax on hotel stays.<br /> <br />We would like to inform you that in the Community of Catalonia there is a tax on stays at tourist establishments. The basic aspects of this tax are as follows: <br />a) The tax does not apply to 16 year olds and minors.<br />b) The amount of the Tax is € 0.50 per person per day with a maximum of 7 nights. In the case of 4 **** hotels the amount is €1.<br /> <br />The amount of the tax or corresponding fee must be paid, providing the corresponding legal requirements have been met, on the customer’s day of arrival, in the hotel reception. For this reason the customer must be informed of this obligation before entering into the travel contract.</p>]]>
</Description>
<Conditions>
<Penalty Item="1" Percent="100" Nights="none" DaysToCheckin="550"/>
</Conditions>
</NonRefundable>
</CancelPenalty>
<BookingConditions>
<![CDATA[<p>1.- The price includes all taxes except the tourist tax which is mentioned in the previous section.<br /><br />2.- When you check in at the hotel, reception will check your booking details and the room fees will then be payable if you have not previously made payment for the whole of your reservation.<br /><br />3.- The prices are applied taking into account the dates of the stay, the number of nights, the room type, the type of occupant, board type and where applicable supplements or services selected at the time of making the reservation.<br />Prices do not include optional services which have not been included in the reservation (such as car parking, minibar amongst others).<br /><br />Extensions to the length of stay should be confirmed directly with the hotel where you have made your reservation and are subject to room availability.<br /><br />If you decide to shorten the period of your stay during your visit, the hotel will not be under the obligation to refund any amount that has been charged for the remaining days.<br /><br />4.- We reserve the right to cancel or modify reservations on the suspicion of unlawful intent or in circumstances where a reservation contains palpably erroneous details or has been made as the result of error.<br /><br />5.- The client authorises the inclusion of personal data in an electronic database, the handling of which is the responsibility of Med Playa Management, SL and whose aim is the normal maintenance of the contractual relationship between Med Playa and the client as well as to keep clients informed of the company's services, special offers and promotions. The client will be able to exercise the right to see, modify and cancel this data via e-mail at clientes@medplaya.com or by ordinary mail by writing to General Mendoza, 1, 6a planta - 17002 Girona. The client also authorises the sharing of the said data with other companies of the group for marketing purposes. If you do not wish to be kept informed of our products and services or those of other companies, please unmark the box (Law 15/1999 of 13 December).</p>]]>
</BookingConditions>
<CurrencyCode>EUR</CurrencyCode>
<Occupation>
<BabyAge From="0" To="1" Units="Year" />
<ChildrenAge From="2" To="12" Units="Year" />
<AdultAge From="13" To="200" Units="Year" />
</Occupation>
<reception>
<checkin from="14:00" to="23:00" />
<checkout from="08:00" to="12:00" />
</reception>
<RatePlans>
<RatePlan Code="NRAI" Name="Non Refundable All inclusive" />
<RatePlan Code="STAI" Name="All inclusive" />
<RatePlan Code="STRO" Name="Room Only" />
</RatePlans>
<RoomTypes>
<RoomType Code="2" Model="1" SurfaceArea="60" Name="Double/Twin MedPlaya Room With Balcony/Terrace" InHome="1">
<Description>
<![CDATA[<p>The Hotel Calypso Salou has double rooms with two separate beds, full bathroom, balcony, air conditioning and heating, cable and satellite TV and telephone. Optional safe deposit box.</p>]]>
</Description>
<Images>
<Image Code="2" Url="/files/hotel/calypso/room/Doble-Med-518x300.jpg" Name="Double room" />
<Image Code="4090" Url="/files/hotel/calypso/room/Family-room-518x300.jpg" Name="Habitación doble mcp" />
</Images>
<Services>
<Service Code="47" Name="Hotel minibus to Tossa de Mar" />
<Service Code="48" Name="Supermarket" />
<Service Code="49" Name="Al Fresco restaurant (July and August)" />
<Service Code="50" Name="Ping Pong" />
</Services>
</RoomType>
<RoomType Code="3" Model="1" SurfaceArea="60" Name="Double/Twin MedPlaya Room With Balcony/Terrace (2 adults + 1 child)" InHome="0">
<Description>
<![CDATA[<p>The Hotel Calypso has double rooms with two separate beds, full bathroom, balcony, air conditioning and heating, cable and satellite TV and telephone. Optional safe deposit box.</p>]]>
</Description>
<Images>
<Image Code="3" Url="/files/hotel/calypso/Hab-doble-Med-518x310.jpg" Name="Double room" />
<Image Code="285" Url="/files/hotel/calypso/room/bany2_518x310.jpg" Name="Doble med" />
</Images>
<Services></Services>
</RoomType>
<RoomType Code="7" Model="1" SurfaceArea="60" Name="Family Room with Balcony / Terrace (2 adults + 2 children)">
<Description>
<![CDATA[<p>The hotel has family rooms. Each room has a double bed and double sofa-bed suitable for 2 children between 2 and 12 years old, a full bathroom, balcony, air conditioning and heating, satellite TV and telephone. Optional safe deposit box.</p>]]>
</Description>
<Images>
<Image Code="1" Url="/files/hotel/calypso/Hab-Family-Med-518x310.jpg" Name="Family room" />
<Image Code="287" Url="/files/hotel/calypso/room/bany2_518x310.jpg" Name="Family Room" />
</Images>
<Services></Services>
</RoomType>
</RoomTypes>
<Images>
<Image Code="111" Url="/files/hotel/calypso/tour/hotel-518x300.jpg" Name="Hotel Calypso" />
<Image Code="417" Url="/files/hotel/calypso/room/piscina07_518x310.jpg" Name="Swimming pool" />
<Image Code="405" Url="/files/hotel/calypso/tour/piscina_518x310.jpg" Name="Hotel Calypso" />
<Image Code="391" Url="/files/hotel/calypso/Panorama5FNAL.jpg" Name="" />
</Images>
<HotelServices>
<HotelService Code="7" Name="Disco" />
<HotelService Code="10" Name="Solarium" />
<HotelService Code="14" Name="Outdoor swimming pool" />
<HotelService Code="15" Name="Restaurant" />
<HotelService Code="56" Name="Bowling alley" />
<HotelService Code="57" Name="Games room" />
<HotelService Code="58" Name="No pets" />
</HotelServices>
</OTA_HotelInfoRS>
Response with error
<?xml version="1.0" encoding="utf-8" ?>
<OTA_HotelInfoRS TimeStamp="2014-12-19T12:07:17" Target="Development">
<Error code="XXXX">
<![CDATA[Detail of error]]>
</Error>
</OTA_HotelInfoRS>
Response with warning
<?xml version="1.0" encoding="utf-8" ?>
<OTA_HotelInfoRS TimeStamp="2014-12-19T12:07:17" Target="Development">
<Warning code="XXXX">
<![CDATA[Detail of error]]>
</Warning>
</OTA_HotelInfoRS>
The request for hotel information is used to acquire all the details regarding the hotel. With this request we will receive information about the situation, public facilities, room facilities, and cancellation policy of the hotel and other relevant information of interest. For example, we will also receive the URL with the photos of the different services offered by the hotel.
Notes:
- This structure only supports one hotel for request.
- The Type attribute in Hotel element define the type of hotel (see Type Hotel List Request)
- The CurrencyCode is the code ISO of default currency of hotel.
- The BabyAge, ChildenAge, AdultAge are range of babies, children and adults respectly (minimum and maximum).
- The Rateplan is the name of the board types in the hotel. Always has 4 letters.
- All descriptives fields are returned in <![CDATA[…]]> element.
- Each roomtype has your description, your images and your services.
Parameters
| Parameter | Type | Description |
|---|---|---|
| Agency/UserId | String | Agency Username. |
| Hotel/Code | Integer | Hotel id. |
| PrimaryLangID | String | Language code. |
Get hotel availability
Request
<?xml version="1.0" encoding="UTF-8"?>
<OTA_HotelAvailRQ PrimaryLangID="en">
<Agency UserId="xxxxx"/>
<StayDate Start="2015-03-04" End="2015-03-08"/>
<Guests>
<Guest Request="1">
<Occupants>
<Occupant Age="30" />
<Occupant Age="30" />
</Occupants>
</Guest>
</Guests>
<Include />
<HotelSearchCriteria>
<Hotel Code="6" />
<Hotel Code="12" />
</HotelSearchCriteria>
</OTA_HotelAvailRQ>
Request for multi occupancy (fe. two rooms: 2+0 and 2+1)
<?xml version="1.0" encoding="UTF-8"?>
<OTA_HotelAvailRQ PrimaryLangID="en">
<Agency UserId="xxxxx"/>
<StayDate Start="2015-03-04" End="2015-03-08"/>
<Guests>
<Guest Request="1">
<Occupants>
<Occupant Age="30" />
<Occupant Age="30" />
</Occupants>
</Guest>
<Guest Request="2">
<Occupants>
<Occupant Age="33" />
<Occupant Age="33" />
<Occupant Age="10" />
</Occupants>
</Guest>
</Guests>
<Include />
<HotelSearchCriteria>
<Hotel Code="6" />
</HotelSearchCriteria>
</OTA_HotelAvailRQ>
Response
<?xml version="1.0" encoding="UTF-8"?>
<OTA_HotelAvailRS TimeStamp="2015-02-24T12:41:49" Target="Development">
<RoomStays>
<RoomStay HotelCode="6" Status="AvailableForSale" NumberOfUnits="26" RequestGuest="1">
<RoomType Code="2" NonRefundable="0" Model="1" SurfaceArea="60" Name="Double/Twin MedPlaya Room With Balcony/Terrace ">
<Description>
<![CDATA[<p>The Hotel Calypso Salou has double rooms with two separate beds, full bathroom, balcony, air conditioning and heating, cable and satellite TV and telephone. Optional safe deposit box.</p>]]>
</Description>
<Images>
<Image Code="2" Url="/files/hotel/calypso/room/Doble-Med-518x300.jpg" Name="Double room"/>
<Image Code="4090" Url="/files/hotel/calypso/room/Family-room-518x300.jpg" Name="Habitación doble mcp"/>
</Images>
<Services>
<Service Code="47" Name="Hotel minibus to Tossa de Mar"/>
<Service Code="48" Name="Supermarket"/>
<Service Code="49" Name="Al Fresco restaurant (July and August)"/>
<Service Code="50" Name="Ping Pong"/>
</Services>
</RoomType>
<RatePlan Code="STRO" Name="Room Only">
<Description/>
<Images/>
</RatePlan>
<StayDate Start="2015-03-04" End="2015-03-08">
<Date Value="2015-03-04" Amount="49.50" AmountBeforeSpecial="55.00">
<Offer Code="50" Name="10% Salou - Hotel Calypso"/>
</Date>
<Date Value="2015-03-05" Amount="49.50" AmountBeforeSpecial="55.00">
<Offer Code="50" Name="10% Salou - Hotel Calypso"/>
</Date>
<Date Value="2015-03-06" Amount="49.50" AmountBeforeSpecial="55.00">
<Offer Code="50" Name="10% Salou - Hotel Calypso"/>
</Date>
<Date Value="2015-03-07" Amount="49.50" AmountBeforeSpecial="55.00">
<Offer Code="50" Name="10% Salou - Hotel Calypso"/>
</Date>
</StayDate>
<RoomRate Amount="198.00" AmountBeforeSpecial="220.00" CurrencyCode="EUR" PriceType="cm" Commission="18.00" />
<Guest AdultsCount="2" ChildsCount="0" BabiesCount="0"/>
<BasicInfo HotelCode="6" HotelName="MedPlaya Hotel Calypso" HotelCategoryCode="3"/>
<CancelPenalty>
<Description>
<![CDATA[<p><strong>NOTE</strong>: The ages of the children are between 3 and 12.</p> <p>Cancellations confirmed up to 48 hours prior to arrival date will incur <span style="color: #008000;"><strong>no cancellation fees</strong></span>. <br /><br />In case of cancellation within 48 hours of the arrival date, a cancellation fee - equal to one night accommodation, will be charged.</p> <p>If you do not arrive at the hotel on the reserved arrival date, your reservation will be automatically cancelled.<br /><br /><strong>Tourist tax information</strong></p> <p>These prices do not include the tourist or similar tax on hotel stays.<br /> <br />We would like to inform you that in the Community of Catalonia there is a tax on stays at tourist establishments. The basic aspects of this tax are as follows: <br />a) The tax does not apply to 16 year olds and minors.<br />b) The amount of the Tax is € 0.50 per person per day with a maximum of 7 nights. In the case of 4 **** hotels the amount is €1.<br /> <br />The amount of the tax or corresponding fee must be paid, providing the corresponding legal requirements have been met, on the customer’s day of arrival, in the hotel reception. For this reason the customer must be informed of this obligation before entering into the travel contract.</p>]]>
</Description>
<Conditions>
<Penalty Item="1" Percent="50" Nights="none" DaysToCheckin="2" CancellationFees="110.00"/>
</Conditions>
</CancelPenalty>
</RoomStay>
<RoomStay HotelCode="12" Status="AvailableForSale" NumberOfUnits="4" RequestGuest="1">
<RoomType Code="45" NonRefundable="0" Model="1" SurfaceArea="60" Name="Double/Twin MedPlaya Room With Balcony/Terrace ">
<Description>
<![CDATA[<p>The Hotel Pez Espada has double rooms with two separate beds, full bathroom, balcony, air conditioning and heating, cable and satellite TV and telephone. Optional safe deposit box.</p>]]>
</Description>
<Images>
<Image Code="254" Url="/files/hotel/pez-espada/room/Doble-Med-518x300.jpg" Name="Double room"/>
<Image Code="404" Url="/files/hotel/pez-espada/room/Family-room-518x300.jpg" Name="Habitación doble suite"/>
</Images>
<Services>
<Service Code="47" Name="Hotel minibus to Tossa de Mar"/>
<Service Code="48" Name="Supermarket"/>
<Service Code="49" Name="Al Fresco restaurant (July and August)"/>
<Service Code="50" Name="Ping Pong"/>
</Services>
</RoomType>
<RatePlan Code="STAI" Name="All inclusive">
<Description/>
<Images/>
</RatePlan>
<StayDate Start="2015-03-04" End="2015-03-08">
<Date Value="2015-03-04" Amount="84.60" AmountBeforeSpecial="94.00"></Date>
<Date Value="2015-03-05" Amount="84.60" AmountBeforeSpecial="94.00"></Date>
<Date Value="2015-03-06" Amount="84.60" AmountBeforeSpecial="94.00"></Date>
<Date Value="2015-03-07" Amount="84.60" AmountBeforeSpecial="94.00"></Date>
</StayDate>
<RoomRate Amount="338.40" AmountBeforeSpecial="376.00" CurrencyCode="EUR" PriceType="cm" Commission="18.00" />
<Guest AdultsCount="2" ChildsCount="0" BabiesCount="0"/>
<BasicInfo HotelCode="12" HotelName="MedPlaya Hotel Pez Espada" HotelCategoryCode="4"/>
<CancelPenalty>
<Description>
<![CDATA[<p><strong>NOTE</strong>: The ages of the children are between 3 and 12.</p> <p>Cancellations confirmed up to 48 hours prior to arrival date will incur <span style="color: #008000;"><strong>no cancellation fees</strong></span>. <br /><br />In case of cancellation within 48 hours of the arrival date, a cancellation fee - equal to one night accommodation, will be charged.</p> <p>If you do not arrive at the hotel on the reserved arrival date, your reservation will be automatically cancelled.<br /><br /><strong>Tourist tax information</strong></p> <p>These prices do not include the tourist or similar tax on hotel stays.<br /> <br />We would like to inform you that in the Community of Catalonia there is a tax on stays at tourist establishments. The basic aspects of this tax are as follows: <br />a) The tax does not apply to 16 year olds and minors.<br />b) The amount of the Tax is € 0.50 per person per day with a maximum of 7 nights. In the case of 4 **** hotels the amount is €1.<br /> <br />The amount of the tax or corresponding fee must be paid, providing the corresponding legal requirements have been met, on the customer’s day of arrival, in the hotel reception. For this reason the customer must be informed of this obligation before entering into the travel contract.</p>]]>
</Description>
<Conditions>
<Penalty Item="1" Percent="50" Nights="none" DaysToCheckin="2" CancellationFees="188.00"/>
</Conditions>
</CancelPenalty>
</RoomStay>
</RoomStays>
</OTA_HotelAvailRS>
Response with any error
<?xml version="1.0" encoding="utf-8" ?>
<OTA_HotelAvailRS TimeStamp="2014-12-31T13:47:11" Target="Development">
<Error code="XXXX">
<![CDATA[Detail of error]]>
</Error>
</OTA_HotelAvailRS>
Response with any warning
<?xml version="1.0" encoding="utf-8" ?>
<OTA_HotelAvailRS TimeStamp="2014-12-31T13:47:11" Target="Development">
<Warning code="XXXX">
<![CDATA[Detail of error]]>
</Warning>
</OTA_HotelAvailRS>
Specific response with restriction element. If the b2b partner needs to know the reason for no availability. (for default is disabled)
<?xml version="1.0" encoding="utf-8" ?>
<OTA_HotelAvailRS TimeStamp="2014-12-19T09:44:13" Target="Development">
<RoomStays>
<RoomStay HotelCode="6" Status="NotAvailable" NumberOfUnits="0" RequestGuest="1" >
<Restrictions>
<Restriction code="1" value="0" detail="none" />
</Restrictions>
</RoomStay>
</RoomStays>
</OTA_HotelAvailRS>
The availability request by hotel, city, province, country or destination is used to acquire all rooms the hotels according to various parameters as situation, dates and guests.
Notes:
- You can get the availability of cities using City Code element in HotelSearchCriteria structure. For example <City Code="4555" />.
- You can get the availability of province using Province Code element in HotelSearchCriteria structure. For example <Province Code="4555" />.
- You can get the availability of country using Country Code element in HotelSearchCriteria structure. For example <Country Code="4555" />.
- You can get the availability of destinations using Destination Code element in HotelSearchCriteria structure. For example <Destination Code="4555" />.
- Using others XML requests specified in this document you can get a list of codes of cities, destinations and zones for do these queries.
- You can get the availability using severals Hotel Code in one request. The same for cities, destinations and zones requests.
- If you request availability for a hotel for which you don’t have credentials, you will receive an error message.
- You can get the availability of one or more rooms using multiple Guest elements.
- Look at the attribute RoomRequest in the response in order to see which Guest request is each room stay response. You always will receive the rooms ordered by room request
- The Include tags in XML request aren’t available for B2B partners. These tags are used in order to check packages availability or apply discount coupon to price. For example.
- Include package: <include><Package Code="45" /></include>
- Or coupon discount: <include><Promotion Code="000470000046327" /></include>
- Depending on the commercial agreement the B2B partner might receive nonrefundable rooms. Theses rooms have the attribute NonRefundable equals to 1 in RoomStay element. The cancel policy for theses rooms are different.
- The dates are specified with following format: YYYY-MM-DD.
- All descriptives fields are returned in <![DATA[...]]> element.
- Each roomtype has your description, your images and your services.
- Note that in order to confirm a reservation you will need the hotel code, roomtype code, rateplan code, refundable code obtained in these availabilities responses.
- The attribute Model in Roomtype elements indicates the type of room models. The room models are the tipology of roomtype. You could see a complete list in point 3.12 of this document.
- The attribute SurfaceArea in Roomtype elements indicates the surface area of room in m2.
- The attribute Price Type can be "pn" for Net Rates or "cm" for Gross Rates.
- The attribute Commission shows the commission rate agreed between the Agency and the Hotel.
Parameters
| Parameter | Type | Description |
|---|---|---|
| PrimaryLangID | String | Language code. |
| Agency/UserId | String | Agency Username. |
| StayDate/Start | String | Date of checkin (YYYY-MM-DD). |
| StayDate/End | String | Date of checkout (YYYY-MM-DD). |
| Guest/Request | Integer | Number of room. |
| Occupant/Age | Integer | Age of the occupant. |
| HotelSearchCriteria/Hotel/Code | Integer | Hotel id. |
Get hotel prices
Request
<?xml version="1.0" encoding="UTF-8"?>
<OTA_HotelPriceRQ PrimaryLangID="en">
<Agency UserId="xxxxx" />
<StayDate Start="2021-03-04" End="2021-03-08" />
<Hotel Code="12" />
</OTA_HotelPriceRQ>
Response
<?xml version="1.0" encoding="UTF-8"?>
<OTA_HotelPriceRS TimeStamp="2018-02-24T12:41:49" Target="Development">
<Registers>
<Register Day="2021-03-04" BaseRate="93.45" />
<Register Day="2021-03-05" BaseRate="93.45" />
<Register Day="2021-03-06" BaseRate="105.00" />
<Register Day="2021-03-07" BaseRate="105.00" />
<Register Day="2021-03-08" BaseRate="99.00" />
</Registers>
</OTA_HotelPriceRS>
Response with any error
<?xml version="1.0" encoding="utf-8" ?>
<OTA_HotelPriceRS TimeStamp="2014-12-31T13:47:11" Target="Development">
<Error code="XXXX">
<![CDATA[Detail of error]]>
</Error>
</OTA_HotelPriceRS>
Response with any warning
<?xml version="1.0" encoding="utf-8" ?>
<OTA_HotelPriceRS TimeStamp="2014-12-31T13:47:11" Target="Development">
<Warning code="XXXX">
<![CDATA[Detail of error]]>
</Warning>
</OTA_HotelPriceRS>
This request returns a minimum prices for day between two dates.
The price is the hotel's base rate. It does not include discounts for offers or promotions that depend on the length of the stay. It also doesn't show sales closings and other retictions like CTA or CTD.
Parameters
| Parameter | Type | Description |
|---|---|---|
| PrimaryLangID | String | Language code. |
| Agency/UserId | String | Agency Username. |
| StayDate/Start | String | Start date of range (YYYY-MM-DD). |
| StayDate/End | String | End date of range (YYYY-MM-DD). |
| /Hotel/Code | Integer | Hotel id. |
Get hotel package list
Request
<?xml version="1.0" encoding="UTF-8"?>
<OTA_PackageListRQ PrimaryLangID="es">
<Agency UserId="xxxxx"/>
<Hotel Code="6"/>
<Package Code="234"/> /* Optional */
</OTA_PackageListRQ>
Response
<?xml version="1.0" encoding="UTF-8"?>
<OTA_PackageListRS TimeStamp="2018-02-25T18:01:06" Target="Development">
<Packages>
<Package Code="111" Name="Halloween en Port Aventura" InHome="1" >
<Restriction MinimumDays="1" MaximumDays="28" />
<Price From="0.00" />
<Description>
<![CDATA[Una entrada de un día para todos los ocupantes de la habi...]]>
</Description>
<Cancellation>
<![CDATA[Los importes de las entradas no son reembolsables en caso de cancelación.]]>
</Cancellation>
<Keywords>
<![CDATA[halloween,en,port,aventura]]>
</Keywords>
<Url>
<![CDATA[halloween-en-port-aventura]]>
</Url>
<Image>
<Primary><![CDATA[http://media.obehotel.com/show_image.php?idpl=15]]></Primary>
<Secundary><![CDATA[http://media.obehotel.com/show_image.php?idpn=15]]></Secundary>
<Terciary><![CDATA[http://media.obehotel.com/show_image.php?idps=15]]></Terciary>
</Image>
<Video>
<![CDATA[https://www.youtube.com/v/NUCgFYf4Xpo&autoplay=1&rel=0]]>
</Video>
<Available>
<![CDATA[06/2018, 07/2018, 08/2018, 09/2018, 10/2018, 11/2018]]>
</Available>
</Package>
</Packages>
</OTA_PackageListRS>
This request returns a list of packages available in our plataform. You could use it for map all packages of one specific hotel or get a specific package.
Notes
- Package element is optional you must use it only for get a specific package.
Get hotel offer list
Request
<?xml version="1.0" encoding="UTF-8"?>
<OTA_OfferListRQ PrimaryLangID="es">
<Agency UserId="xxxxx"/>
<Hotel Code="6"/>
<Offer Code="234"/> /* Optional */
</OTA_OfferListRQ>
Response
<?xml version="1.0" encoding="UTF-8"?>
<OTA_OfferListRS TimeStamp="2018-02-25T18:01:06" Target="Development">
<Offers>
<Offer Code="232" Name="Descuento 15% Salou - Hotel Calypso - Costa dorada" InHome="0">
<Restriction MinimumDays="1" MaximumDays="28" />
<Discount Percentage="15.00" Fixed="0.00" />
<Description>
<![CDATA[<strong>Reserve</strong> 7 o más noches y le damos un <strong>15% de descuento</strong>...]]>
</Description>
<Keywords>
<![CDATA[oferta,early booking,anticipada,hotel,calypso,salou,costadaurdada,tarragona]]>
</Keywords>
<Url>
<![CDATA[earlybooking-hotelcalypso-salou-costadaurada]]>
</Url>
<Image>
<Primary><![CDATA[http://media.obehotel.com/show_image.php?idol=15]]></Primary>
<Secundari><![CDATA[http://media.obehotel.com/show_image.php?idon=15]]></Secundary>
</Image>
<Video />
<Available>
<![CDATA[01/2018, 02/2018, 03/2018, 04/2018, 05/2018, 06/2018, 07/2018, 08/2018, 09/2018, 10/2018, 11/2018, 12/2018]]>
</Available>
</Offer>
</Offers>
</OTA_OfferListRS>
This request returns a list of offers available in our plataform. You could use it for map all offers of one specific hotel or get a specific offer.
Notes
- Offer element is optional you must use it only for get a specific offer.
Get hotel promotion codes list
Request (One Hotel)
<?xml version="1.0" encoding="UTF-8"?>
<OTA_PromotionListRQ PrimaryLangID="es">
<Agency UserId="xxxxx"/>
<Hotel Code="12"/>
</OTA_PromotionListRQ>
Request (Multi Hotel)
<?xml version="1.0" encoding="UTF-8"?>
<OTA_PromotionListRQ PrimaryLangID="es">
<Agency UserId="xxxxx"/>
<Hotels>
<Hotel Code="6"/>
<Hotel Code="12"/>
<Hotel Code="15"/>
</Hotels>
</OTA_PromotionListRQ>
Response
<?xml version="1.0" encoding="UTF-8"?>
<OTA_PromotionListRS TimeStamp="2019-05-07T13:15:04" Target="Development">
<Promotions>
<Promotion Id="85" Name="CALL CENTER 5%" >
<Hotel Code="6" Name="MedPlaya Hotel Calypso" City="6491" />
<Codes>
<Code Value="CALLCENTREMPCOM" />
</Codes>
<Available>
<Date From="2018-03-09" To="2020-04-30" />
<Date From="2022-07-09" To="2022-12-30" />
</Available>
</Promotion>
<Promotion Id="24" Name="-5% UNICALL" >
<Hotel Code="6" Name="MedPlaya Hotel Calypso" City="6491" />
<Codes>
<Code Value="0000478711" />
</Codes>
<Available>
<Date From="2014-01-01" To="2020-12-31" />
</Available>
</Promotion>
</Promotions>
</OTA_PromotionListRS >
This request returns a list promotion codes available in our platform that the hotelier allow show through XML webservice.
Get hotel comment list
Request
<?xml version="1.0" encoding="UTF-8"?>
<OTA_CommentListRQ PrimaryLangID="es">
<Agency UserId="xxxxx"/>
<Hotel Code="X"/>
<Date Start="2017-06-01" End="2018-06-01"/>
</OTA_CommentListRQ>
Response
<?xml version="1.0" encoding="utf-8" ?>
<OTA_CommentListRS TimeStamp="2018-07-18T11:26:24" Target="Production">
<Comments>
<Comment Code="xxxxx" Date="2018-07-12 19:58:38">
<Author><![CDATA[Bil Gates]]></Author>
<Title><![CDATA[Wonderful oasis]]>
</Title><Text><![CDATA[What a wonderful oasis. We stayed for a week and enjoyed every moment..]]></Text>
<Location><![CDATA[Sheffield]]></Location>
<Valuation>5</Valuation>
</Comment>
</Comments>
</OTA_CommentListRS>
This request returns a list of the comments available for a hotel on our plataform. You can use it to get all comments for the hotel or only for a specified date range.
Notes
- The Date element is optional, you must use it only to get the comments between two dates.
- The Valuation is the rating of customer. The range is from 1 to 5.
Add comment to Hotel
Request
<?xml version="1.0" encoding="UTF-8"?>
<OTA_CommentInsertRQ PrimaryLangID="es">
<Agency UserId="xxxxx"/>
<Hotel Code="xxxxx"/>
<Author><![CDATA[Bill Gates]]></Author>
<Title><![CDATA[Nice hotel]]></Title>
<Text><![CDATA[Lorem ipsum ...]]></Text>
<Location><![CDATA[Barcelona]]></Location>
<Valuation>4</Valuation>
</OTA_CommentInsertRQ>
Response
<?xml version="1.0" encoding="UTF-8"?>
<OTA_CommentInsertRS TimeStamp="2018-06-01T18:30:15" Target="Production">
<Success>
</OTA_CommentListRS>
This request adds a comment to the hotel. Only one comment is allowed per request.
Notes
- The Valuation is the rating of customer. The range is from 1 to 5.
Get hotel complements
Request
<?xml version="1.0" encoding="UTF-8"?>
<OTA_ComplementListRQ PrimaryLangID="es">
<Agency UserId="xxxxx" />
<Roomstays>
<Roomstay HotelCode="370">
<RoomType Code="3986" />
<RatePlan Code="STRO" />
<Guest Request="1">
<Occupants>
<Occupant Age="30" />
<Occupant Age="30" />
</Occupants>
</Guest>
<StayDate Start="2019-11-14" End="2019-11-16"/>
</Roomstay>
<Roomstay HotelCode="370">
<RoomType Code="3986" />
<RatePlan Code="STRO" />
<Guest Request="2">
<Occupants>
<Occupant Age="30" />
<Occupant Age="30" />
<Occupant Age="5" />
</Occupants>
</Guest>
<StayDate Start="2019-11-14" End="2019-11-16"/>
</Roomstay>
</Roomstays>
</OTA_ComplementListRQ>
Response
<?xml version="1.0" encoding="utf-8" ?>
<OTA_ComplementListRS TimeStamp="2019-11-14T11:05:08" Target="Development">
<RoomStays>
<RoomStay HotelCode="370" RequestGuest="1" >
<Complements>
<Complement Code="1" Name="Parking 24h" Duration="all">
<Image Url="/files/hotel/hotel-txintxua-hernani/complementos/1024px-Parking_icon.svg_270x160.png" />
<Price Value="20.00" />
<Quantity>
<Option Value="0" />
<Option Value="1" />
</Quantity>
<Days>
<Option Value="all" />
</Days>
<Description>
<![CDATA[<p>Parking 24 h para clientes del hotels gsdfgsdfg</p>]]>
</Description>
</Complement>
<Complement Code="4" Name="Entrada Port Aventura" Duration="one">
<Image Url="/files/hotel/hotel-txintxua-hernani/complementos/port-aventura-1-1200x500_c_270x160.jpg" />
<Price Value="35.00" />
<Quantity>
<Option Value="0" />
<Option Value="1" />
<Option Value="2" />
</Quantity>
<Days>
<Option Value="2019-11-14" />
<Option Value="2019-11-15" />
<Option Value="2019-11-16" />
</Days>
<Description>
<![CDATA[<p>Entrada Port Aventura</p>]]>
</Description>
</Complement>
<Complement Code="11" Name="Cuna ( para menores 2 años) " Duration="to_choose">
<Image Url="/files/hotel/hotel-txintxua-hernani/complementos/cuna2_270x160.jpg" />
<Price Value="5.00" />
<Quantity>
<Option Value="0" />
<Option Value="1" />
</Quantity>
<Days>
<Option Value="2019-11-14" />
<Option Value="2019-11-15" />
<Option Value="2019-11-16" />
</Days>
<Description>
<![CDATA[<p>Reserva nuestra cuna con antelacion </p>]]>
</Description>
</Complement>
...
</Complements>
</RoomStay>
<RoomStay HotelCode="370" RequestGuest="2" >
<Complements>
...
</Complements>
</RoomStay>
</RoomStays>
</OTA_ComplementListRS>
This request returns a list of complements available for a hotel, roomtype, rateplan, guests and specified date range on our plataform.
Notes
- The Price element in response is the price per day and guest.
- Possible values of Duration attribute can be all, one or to_choose.
- all means the complement is for every days of the stay.
- one means only it can choose one day of the stay.
- to_choose means it can choose different days of the stay.
XML Requests: Reservations
Make a reservation
Request
<?xml version="1.0" encoding="UTF-8"?>
<OTA_HotelResRQ PrimaryLangID="en">
<Agency UserId="xxxxx"/>
<UniqueIDExternal Value="AAAAA" />
<Client Name="Michael" Surname="Smith Green" Phone="972411600" Email="web@efimatica.com" Address="Passeo de gracia, n1" City="Barcelona" Country="ES" />
<Payment CardType="none" />
<Reservations>
<Reservation HotelCode="6">
<RoomType Code="2" />
<RatePlan Code="STRO" />
<Package Code="none" />
<Promotion Code="none" />
<Guest Request="1">
<Occupants>
<Occupant Age="30" />
<Occupant Age="30" />
</Occupants>
</Guest>
<StayDate Start="2015-03-04" End="2015-03-08" />
<Comment>We will arrive at 4:00 PM</Comment>
</Reservation>
</Reservations>
</OTA_HotelResRQ>
Request with complements
<?xml version="1.0" encoding="UTF-8"?>
<OTA_HotelResRQ PrimaryLangID="en">
<Agency UserId="xxxxx"/>
<UniqueIDExternal Value="AAAAA" />
<Client Name="Michael" Surname="Smith Green" Phone="972411600" Email="web@efimatica.com" Address="Passeo de gracia, n1" City="Barcelona" Country="ES" />
<Payment CardType="none" />
<Reservations>
<Reservation HotelCode="6">
<RoomType Code="2" />
<RatePlan Code="STRO" />
<Package Code="none" />
<Promotion Code="none" />
<Complements>
<Complement Code="1" Quantity="1">
<Days>
<Day>all</Day>
</Days>
</Complement>
<Complement Code="4" Quantity="2">
<Days>
<Day>2019-11-14</Day>
</Days>
</Complement>
<Complement Code="5" Quantity="2">
<Days>
<Day>2019-11-14</Day>
<Day>2019-11-15</Day>
<Day>2019-11-16</Day>
</Days>
</Complement>
...
</Complements>
<Guest Request="1">
<Occupants>
<Occupant Age="30" />
<Occupant Age="30" />
</Occupants>
</Guest>
<StayDate Start="2015-03-04" End="2015-03-08" />
<Comment>We will arrive at 4:00 PM</Comment>
</Reservation>
</Reservations>
</OTA_HotelResRQ>
Response
<?xml version="1.0" encoding="UTF-8"?>
<OTA_HotelResRS TimeStamp="2015-02-24T17:15:03" Target="Development">
<Reservation Success="1"/>
<UniqueID Value="12345"/>
<UniqueIDExternal Value="AAAAA"/>
<Supplier Name="BBBBB"/>
<Client Name="Michael" Surname="Smith Green" Phone="972411600" Email="web@efimatica.com" Address="Passeo de gracia, n1" City="Barcelona" Country="ES" />
<Roomstays>
<Roomstay idDataBase="221268">
<Hotel Code="6" Name="MedPlaya Hotel Calypso" HotelCategory="3">
<Location Address="Pompeu Fabra, 54-62" PostalCode="43840" City="Salou" Province="Tarragona" GPSLatitude="41.071644417044" GPSLongitude="1.154460310936"/>
<Contact Telephone="+34 977 384 900" Fax="+34 977 383 513" Email="calypso@medplaya.com"/>
<Nif Code="A-12345678"/>
</Hotel>
<RoomType Code="2" NonRefundable="0" SurfaceArea="60" Name="Habitación Doble MedPlaya con terraza"/>
<RatePlan Code="STRO" Name="Room Only"/>
<Status Code="2" Name="Confirmed" PreBook="2015-02-24 17:15:00" ConfirmBook="2015-02-24 17:15:00" ModifyBook="none" CancelBook="none"/>
<Guest AdultsCount="2" ChildsCount="0" BabiesCount="0"/>
<StayDate Start="2015-03-04" End="2015-03-08">
<Date Value="2015-03-04" Amount="49.50" AmountBeforeSpecial="55.00">
<Offer Code="50" Name="10% Salou - Hotel Calypso"/>
</Date>
<Date Value="2015-03-05" Amount="49.50" AmountBeforeSpecial="55.00">
<Offer Code="50" Name="10% Salou - Hotel Calypso"/>
</Date>
<Date Value="2015-03-06" Amount="49.50" AmountBeforeSpecial="55.00">
<Offer Code="50" Name="10% Salou - Hotel Calypso"/>
</Date>
<Date Value="2015-03-07" Amount="49.50" AmountBeforeSpecial="55.00">
<Offer Code="50" Name="10% Salou - Hotel Calypso"/>
</Date>
</StayDate>
<RoomRate Amount="198.00" AmountBeforeSpecial="220.00" CurrencyCode="EUR" PercentagePaid="0.00" CancellationFeesAplied="none"/>
<Comment>We will arrive at 4:00 PM, thank you</Comment>
<CancelPenalty>
<Description>
<![CDATA[<p><strong>NOTE</strong>: The ages of the children are between 3 and 12.</p> <p>Cancellations confirmed up to 48 hours prior to arrival date will incur <span style="color: #008000;"><strong>no cancellation fees</strong></span>. <br /><br />In case of cancellation within 48 hours of the arrival date, a cancellation fee - equal to one night accommodation, will be charged.</p> <p>If you do not arrive at the hotel on the reserved arrival date, your reservation will be automatically cancelled.<br /><br /><strong>Tourist tax information</strong></p> <p>These prices do not include the tourist or similar tax on hotel stays.<br /> <br />We would like to inform you that in the Community of Catalonia there is a tax on stays at tourist establishments. The basic aspects of this tax are as follows: <br />a) The tax does not apply to 16 year olds and minors.<br />b) The amount of the Tax is € 0.50 per person per day with a maximum of 7 nights. In the case of 4 **** hotels the amount is €1.<br /> <br />The amount of the tax or corresponding fee must be paid, providing the corresponding legal requirements have been met, on the customer’s day of arrival, in the hotel reception. For this reason the customer must be informed of this obligation before entering into the travel contract.</p>]]>
</Description>
<Conditions>
<Penalty Item="1" Percent="50" Nights="2" DaysToCheckin="2" CancellationFees="99.00"/>
</Conditions>
</CancelPenalty>
</Roomstay>
</Roomstays>
<TotalReservation Amount="198.00" CurrencyCode="EUR" PriceType="pn" Commission="0.00" />
</OTA_HotelResRS>
Response with error
<?xml version="1.0" encoding="utf-8" ?>
<OTA_HotelResRS TimeStamp="2014-12-19T12:07:17" Target="Development">
<Error code="XXXX">
<![CDATA[Detail of error]]>
</Error>
</OTA_HotelResRS>
Response with warning
<?xml version="1.0" encoding="utf-8" ?>
<OTA_HotelResRS TimeStamp="2014-12-19T12:07:17" Target="Development">
<Warning code="XXXX">
<![CDATA[Detail of error]]>
</Warning>
</OTA_HotelResRS>
This request is used to make a reservation of rooms in the hotel. In order to make the reservation it is necessary to check the availability first. You need the roomtype code, rateplan code and refund code obtained in the availability request to define the roomstay.
Notes:
- This request allows reservations with one, two o more rooms. You need create a Reservation element for each room with appropriate information.
- It’s important to check that the reservation been made correctly. You can check it by looking the Reservation element in the response. If the attribute Success is 1 the reservations is correct, otherwise you will receive a message error.
- If you don’t have the telephone, email, address, city, country of client, you set this variable to none.
- The Country values are based as a subset of ISO 3166-1 alpha-2 codes. You can get all supported values using ContryList request.
- If you don’t have the card details, you put none in CardType and don’t write the last of sentence. For example <Payment CardType="none" />.
- If you wish, you could include any comment using Comments element.
- All descriptives fields are returned in <![CDATA[…]]> element.
- The RoomRate Amount is the price of room.
- The RoomRate PercentagePaid is the percentage paid using ObeHotel Payment system. Travel agents shouldn’t use this value.
- The TotalReservation Amount is the total price for the reservation. This is the sum of the price for each room requested.
- The Status Code is the status of reservation. This value could be 0 (Cancelled), 2 (Confirmed) or 3 (Modified).
- The Supplier Name shows where the booking has been made.
- The attribute Price Type can be "pn" for Net Rates or "cm" for Gross Rates.
- The attribute Commission shows the commission rate agreed between the Agency and the Hotel.
Parameters
| Parameter | Type | Description |
|---|---|---|
| PrimaryLangID | String | Language code. |
| Agency/UserId | String | Agency Username. |
| Hotel/Code | Integer | Hotel id. |
| Roomtype/Code | Integer | Room id. |
| StayDate/Start | String | Date of checkin (YYYY-MM-DD). |
| StayDate/End | String | Date of checkout (YYYY-MM-DD). |
Reservation simulation
Request
<?xml version="1.0" encoding="UTF-8"?>
<OTA_HotelResRQ PrimaryLangID="en" Action="one_step">
<Test Value="1"/>
<Agency UserId="xxxxx"/>
<UniqueIDExternal Value="AAAAA" />
<Client Name="Michael" Surname="Smith Green" Phone="972411600" Email="web@efimatica.com" Address="none" City="none" Country="none" />
<Payment CardType="none" />
<Reservations>
<Reservation HotelCode="6">
<RoomType Code="2" />
<RatePlan Code="STRO" />
<NonRefundable Code="0" />
<Package Code="none" />
<Promotion Code="none" />
<Guest Request="1">
<Occupants>
<Occupant Age="30" />
<Occupant Age="30" />
</Occupants>
</Guest>
<StayDate Start="2015-03-04" End="2015-03-08" />
<Comment>We will arrive at 4:00 PM</Comment>
</Reservation>
</Reservations>
</OTA_HotelResRQ>
Response
<?xml version="1.0" encoding="UTF-8"?>
<OTA_HotelResRS TimeStamp="2015-02-24T17:15:03" Target="Development"> <Test Value="1"/>
<Reservation Success="1"/>
<UniqueID Value="12345"/>
<UniqueIDExternal Value="AAAAA"/>
<Supplier Name="BBBBB"/>
<Client Name="Michael" Surname="Smith Green" Phone="972411600" Email="web@efimatica.com" Address="none" City="none" Country="none" />
<Roomstays>
<Roomstay idDataBase="221268">
<Hotel Code="6" Name="MedPlaya Hotel Calypso" HotelCategory="3">
<Location Address="Pompeu Fabra, 54-62" PostalCode="43840" City="Salou" Province="Tarragona" GPSLatitude="41.071644417044" GPSLongitude="1.154460310936"/>
<Contact Telephone="+34 977 384 900" Fax="+34 977 383 513" Email="calypso@medplaya.com"/>
<Nif Code="A-12345678"/>
</Hotel>
<RoomType Code="2" NonRefundable="0" SurfaceArea="60" Name="Habitación Doble MedPlaya con terraza"/>
<RatePlan Code="STRO" Name="Room Only"/>
<Status Code="2" Name="Confirmed" PreBook="2015-02-24 17:15:00" ConfirmBook="2015-02-24 17:15:00" ModifyBook="none" CancelBook="none"/>
<Guest AdultsCount="2" ChildsCount="0" BabiesCount="0"/>
<StayDate Start="2015-03-04" End="2015-03-08">
<Date Value="2015-03-04" Amount="49.50" AmountBeforeSpecial="55.00">
<Offer Code="50" Name="10% Salou - Hotel Calypso"/>
</Date>
<Date Value="2015-03-05" Amount="49.50" AmountBeforeSpecial="55.00">
<Offer Code="50" Name="10% Salou - Hotel Calypso"/>
</Date>
<Date Value="2015-03-06" Amount="49.50" AmountBeforeSpecial="55.00">
<Offer Code="50" Name="10% Salou - Hotel Calypso"/>
</Date>
<Date Value="2015-03-07" Amount="49.50" AmountBeforeSpecial="55.00">
<Offer Code="50" Name="10% Salou - Hotel Calypso"/>
</Date>
</StayDate>
<RoomRate Amount="198.00" AmountBeforeSpecial="220.00" CurrencyCode="EUR" PercentagePaid="0.00" CancellationFeesAplied="none" />
<Comment>We will arrive at 4:00 PM, thank you</Comment>
<CancelPenalty>
<Description>
<![CDATA[<p><strong>NOTE</strong>: The ages of the children are between 3 and 12.</p> <p>Cancellations confirmed up to 48 hours prior to arrival date will incur <span style="color: #008000;"><strong>no cancellation fees</strong></span>. <br /><br />In case of cancellation within 48 hours of the arrival date, a cancellation fee - equal to one night accommodation, will be charged.</p> <p>If you do not arrive at the hotel on the reserved arrival date, your reservation will be automatically cancelled.<br /><br /><strong>Tourist tax information</strong></p> <p>These prices do not include the tourist or similar tax on hotel stays.<br /> <br />We would like to inform you that in the Community of Catalonia there is a tax on stays at tourist establishments. The basic aspects of this tax are as follows: <br />a) The tax does not apply to 16 year olds and minors.<br />b) The amount of the Tax is € 0.50 per person per day with a maximum of 7 nights. In the case of 4 **** hotels the amount is €1.<br /> <br />The amount of the tax or corresponding fee must be paid, providing the corresponding legal requirements have been met, on the customer’s day of arrival, in the hotel reception. For this reason the customer must be informed of this obligation before entering into the travel contract.</p>]]>
</Description>
<Conditions>
<Penalty Item="1" Percent="50" Nights="none" DaysToCheckin="2" CancellationFees="99.00"/>
</Conditions>
</CancelPenalty>
</Roomstay>
</Roomstays>
<TotalReservation Amount="198.00" CurrencyCode="EUR" PriceType="cm" Commission="15.00" />
</OTA_HotelResRS>
Response with error
<?xml version="1.0" encoding="utf-8" ?>
<OTA_HotelResRS TimeStamp="2014-12-19T12:07:17" Target="Development">
<Error code="XXXX">
<![CDATA[Detail of error]]>
</Error>
</OTA_HotelResRS>
Response with warning
<?xml version="1.0" encoding="utf-8" ?>
<OTA_HotelResRS TimeStamp="2014-12-19T12:07:17" Target="Development">
<Warning code="XXXX">
<![CDATA[Detail of error]]>
</Warning>
</OTA_HotelResRS>
The Obehotel booking engine is a platform which functions in real time. It is possible that, between the availability search and the reservation confirmation, the prices of the reservation have changed or that there is no availability. If you wish to avoid this scenario, you can use the Reservation Simulation request prior to making the final reservation.
This request simulates the reservation, but does not confirm it, enabling the agency to confirm that the prices are the same and that there is still availability.
In order to produce the Reservation Simulation, you only need to add the following line to the request: <Test Value="1"/>
The format of the XML responses is exactly the same as the request "Make a reservation", you just need to check that the following element is included at the start of the request: <Test Value="1"/>
Please note that the Reservation Simulation will always have the booking reference (UniqueId) "111111" and is not a pre-reservation. This request does not block the room.
Notes
- The attributes of the XML requests and responses are exactly the same as the request "Make a reservation".
Parameters
| Parameter | Type | Description |
|---|---|---|
| PrimaryLangID | String | Language code. |
| Agency/UserId | String | Agency Username. |
| Hotel/Code | Integer | Hotel id. |
| Roomtype/Code | Integer | Room id. |
| StayDate/Start | String | Date of checkin (YYYY-MM-DD). |
| StayDate/End | String | Date of checkout (YYYY-MM-DD). |
Modify dates of reservation
First Request
Modify dates: Check availability and price of new dates
Request
<?xml version="1.0" encoding="UTF-8"?>
<OTA_HotelModRQ PrimaryLangID="en" Action="check_dates" >
<Agency UserId="xxxxx"/>
<UniqueID Value="12345"/>
<RoomStay idDataBase="67890" >
<StayDate Start="2015-03-05" End="2015-03-08"/>
</RoomStay>
</OTA_HotelModRQ>
Response
<?xml version="1.0" encoding="UTF-8"?>
<OTA_HotelModRS Action="check_dates" TimeStamp="2015-02-25T12:02:30" Target="Development">
<Check Success="1"/>
<UniqueID Value="123456"/>
<UniqueIDExternal Value="AAAAA"/>
<RoomStays>
<RoomStay idDataBase="67890">
<RoomRate Amount="148.50"/>
<CancelPenalty>
<Description>
<![CDATA[<p><strong>NOTE</strong>: The ages of the children are between 3 and 12.</p> <p>Cancellations confirmed up to 48 hours prior to arrival date will incur <span style="color: #008000;"><strong>no cancellation fees</strong></span>. <br /><br />In case of cancellation within 48 hours of the arrival date, a cancellation fee - equal to one night accommodation, will be charged.</p> <p>If you do not arrive at the hotel on the reserved arrival date, your reservation will be automatically cancelled.<br /><br /><strong>Tourist tax information</strong></p> <p>These prices do not include the tourist or similar tax on hotel stays.<br /> <br />We would like to inform you that in the Community of Catalonia there is a tax on stays at tourist establishments. The basic aspects of this tax are as follows: <br />a) The tax does not apply to 16 year olds and minors.<br />b) The amount of the Tax is € 0.50 per person per day with a maximum of 7 nights. In the case of 4 **** hotels the amount is €1.<br /> <br />The amount of the tax or corresponding fee must be paid, providing the corresponding legal requirements have been met, on the customer’s day of arrival, in the hotel reception. For this reason the customer must be informed of this obligation before entering into the travel contract.</p>]]>
</Description>
<Conditions>
<Penalty Item="1" Percent="100" Nights="none" DaysToCheckin="2" CancellationFees="148.50"/>
</Conditions>
</CancelPenalty>
</RoomStay>
</RoomStays>
</OTA_HotelModRS>
Response with warning or error
<?xml version="1.0" encoding="utf-8" ?>
<OTA_HotelModRS Action="check_dates" TimeStamp="2015-02-25T12:03:35" Target="Development">
<Error code="XXXX">
<![CDATA[Detail of error]]>
</Error>
</OTA_HotelModRS>
<?xml version="1.0" encoding="utf-8" ?>
<OTA_HotelModRS Action="check_dates" TimeStamp="2015-02-25T12:03:35" Target="Development">
<Warning code="XXXX">
<![CDATA[Detail of error]]>
</Warning>
</OTA_HotelModRS>
Second Request
Modify dates: Change dates
Request (This request is necessary for confirm the changes. This is the same as before but you must change check_dates value for change_dates in Action attribute. The response returns updated reservation)
<?xml version="1.0" encoding="UTF-8"?>
<OTA_HotelModRQ PrimaryLangID="en" Action="change_dates" >
<Agency UserId="xxxxx"/>
<UniqueID Value="12345"/>
<RoomStay idDataBase="67890" >
<StayDate Start="2015-03-05" End="2015-03-08"/>
</RoomStay>
</OTA_HotelModRQ>
Response
<?xml version="1.0" encoding="UTF-8"?>
<OTA_HotelModRS Action="change_dates" TimeStamp="2015-02-25T12:10:12" Target="Development">
<Change Success="1"/>
<UniqueID Value="12345"/>
<UniqueIDExternal Value="AAAAA"/>
<Supplier Name="BBBBB"/>
<Client Name="Michael" Surname="Smith Green" Phone="972411600" Email="web@efimatica.com" Address="none" City="none" Country="none" />
<Roomstays>
<Roomstay idDataBase="67890">
<Hotel Code="6" Name="MedPlaya Hotel Calypso" HotelCategory="3">
<Location Address="Pompeu Fabra, 54-62" PostalCode="43840" City="Salou" Province="Tarragona" GPSLatitude="41.071644417044" GPSLongitude="1.154460310936"/>
<Contact Telephone="+34 977 384 900" Fax="+34 977 383 513" Email="calypso@medplaya.com"/>
<Nif Code="A-12345678"/>
</Hotel>
<RoomType Code="2" NonRefundable="0" Name="Habitación Doble MedPlaya con terraza"/>
<RatePlan Code="STRO" Name="Room Only"/>
<Status Code="3" Name="Modified" PreBook="2015-02-25 10:16:54" ConfirmBook="2015-02-25 10:16:54" ModifyBook="2015-02-25 12:10:12" CancelBook="none"/>
<Guest AdultsCount="2" ChildsCount="0" BabiesCount="0"/>
<StayDate Start="2015-03-05" End="2015-03-08">
<Date Value="2015-03-05" Amount="49.50" AmountBeforeSpecial="55.00">
<Offer Code="50" Name="10% Salou - Hotel Calypso"/>
</Date>
<Date Value="2015-03-06" Amount="49.50" AmountBeforeSpecial="55.00">
<Offer Code="50" Name="10% Salou - Hotel Calypso"/>
</Date>
<Date Value="2015-03-07" Amount="49.50" AmountBeforeSpecial="55.00">
<Offer Code="50" Name="10% Salou - Hotel Calypso"/>
</Date>
</StayDate>
<RoomRate Amount="148.50" AmountBeforeSpecial="165.00" CurrencyCode="EUR" PercentagePaid="0.00" CancellationFeesAplied="none" />
<Comment></Comment>
<CancelPenalty>
<Description>
<![CDATA[<p><strong>NOTE</strong>: The ages of the children are between 3 and 12.</p> <p>Cancellations confirmed up to 48 hours prior to arrival date will incur <span style="color: #008000;"><strong>no cancellation fees</strong></span>. <br /><br />In case of cancellation within 48 hours of the arrival date, a cancellation fee - equal to one night accommodation, will be charged.</p> <p>If you do not arrive at the hotel on the reserved arrival date, your reservation will be automatically cancelled.<br /><br /><strong>Tourist tax information</strong></p> <p>These prices do not include the tourist or similar tax on hotel stays.<br /> <br />We would like to inform you that in the Community of Catalonia there is a tax on stays at tourist establishments. The basic aspects of this tax are as follows: <br />a) The tax does not apply to 16 year olds and minors.<br />b) The amount of the Tax is € 0.50 per person per day with a maximum of 7 nights. In the case of 4 **** hotels the amount is €1.<br /> <br />The amount of the tax or corresponding fee must be paid, providing the corresponding legal requirements have been met, on the customer’s day of arrival, in the hotel reception. For this reason the customer must be informed of this obligation before entering into the travel contract.</p>]]>
</Description>
<Conditions>
<Penalty Item="1" Percent="100" Nights="none" DaysToCheckin="2" CancellationFees="148.00"/>
</Conditions>
</CancelPenalty>
</Roomstay>
</Roomstays>
</OTA_HotelModRS>
Response with warning or error
<?xml version="1.0" encoding="utf-8" ?>
<OTA_HotelModRS Action="changes_dates" TimeStamp="2015-02-25T12:03:35" Target="Development">
<Error code="XXXX">
<![CDATA[Detail of error]]>
</Error>
</OTA_HotelModRS>
<?xml version="1.0" encoding="utf-8" ?>
<OTA_HotelModRS Action="changes_dates" TimeStamp="2015-02-25T12:03:35" Target="Development">
<Warning code="XXXX">
<![CDATA[Detail of error]]>
</Warning>
</OTA_HotelModRS>
These two requests are used to modify the dates of reservation. Using the first request, you can check the availability and prices of new dates. Then you can change the dates using second request.
Notes
- The Status Code is the status of reservation. This value could be 0 (Cancelled), 2 (Confirmed) or 3 (Modified).
- The Status Code of reservation is updated to 3.
- This request requires an idDataBase of room in order to modify the booking. You can obtain this value when you make a booking or consult it using the request Get reservation information.
- Modify reservation isn’t supported in case of non-refundable reservations and reservations with packages or discount cupons.
- It’s important to check the Success status in the response of second request (change_dates). If the value equals to 1, the change has been completed correctly. Otherwise you will receive a warning o error message.
- All descriptives fields are returned in <![CDATA[...]]> element.
Modify roomtype of reservation
First Request
Modify roomtpye: Check availability of others compatible room type
Request
<?xml version="1.0" encoding="UTF-8"?>
<OTA_HotelModRQ PrimaryLangID="en" Action="check_roomtype" >
<Agency UserId="xxxxx"/>
<UniqueID Value="12345"/>
<RoomStay idDataBase="67890" />
</OTA_HotelModRQ>
Response
<?xml version="1.0" encoding="utf-8" ?>
<OTA_HotelModRS Action="check_roomtype" TimeStamp="2015-02-25T12:21:57" Target="Development">
<Check Success="1"/>
<RoomStays>
<RoomStay HotelCode="6" Status="AvailableForSale" NumberOfUnits="20" RequestGuest="1">
<RoomType Code="2" NonRefundable="1" Model="1" SurfaceArea="60" Name="Double/Twin MedPlaya Room With Balcony/Terrace ">
<Description>
<p>The Hotel Calypso Salou has double rooms with two separate beds, full bathroom, balcony, air conditioning and heating, cable and satellite TV and telephone. Optional safe deposit box.</p>
</Description>
<Images>
<Image Code="2" Url="/files/hotel/calypso/room/Doble-Med-518x300.jpg" Name="Double room"/>
<Image Code="4090" Url="/files/hotel/calypso/room/Family-room-518x300.jpg" Name="Habitación doble mcp"/>
</Images>
<Services>
<Service Code="47" Name="Hotel minibus to Tossa de Mar"/>
<Service Code="48" Name="Supermarket"/>
<Service Code="49" Name="Al Fresco restaurant (July and August)"/>
<Service Code="50" Name="Ping Pong"/>
</Services>
</RoomType>
<RatePlan Code="NRAI" Name="Non Refundable All inclusive">
<Description/>
<Images/>
</RatePlan>
<StayDate Start="2015-03-05" End="2015-03-08">
<Date Value="2015-03-05" Amount="100.00" AmountBeforeSpecial="100.00"/>
<Date Value="2015-03-06" Amount="100.00" AmountBeforeSpecial="100.00"/>
<Date Value="2015-03-07" Amount="100.00" AmountBeforeSpecial="100.00"/>
</StayDate>
<RoomRate Amount="300.00" AmountBeforeSpecial="300.00" CurrencyCode="EUR" PercentagePaid="0.00"/>
<Guest AdultsCount="2" ChildsCount="0" BabiesCount="0"/>
<BasicInfo HotelCode="6" HotelName="MedPlaya Hotel Calypso" HotelCategoryCode="3"/>
<CancelPenalty>
<Description>
<![CDATA[<p><strong><strong>Advance payment:</strong> </strong>The full amount or the percentage indicated in the room conditions will be charged upon making the reservation.<br /><br /><strong>Cancellations "Non-Refundable": </strong> if you cancel or modify your reservation, the hotel will charge you either the full amount of your stay or will bill the amount deposited with your credit card as a guarantee of you reservation. If you fail to arrive at the hotel on the check in date, you will be charged for the full stay.<br /><br /><strong>Amigo Card Holders:</strong> Amigo points cannot be redeemed for non refundable bookings</p> <p><em><strong>NOTE</strong>: The ages of the children are between 2 and 12.</em></p> <p><em> </em></p> <p><strong>Tourist tax informaction</strong></p> <p>These prices do not include the tourist or similar tax on hotel stays.<br /> <br />We would like to inform you that in the Community of Catalonia there is a tax on stays at tourist establishments. The basic aspects of this tax are as follows: <br />a) The tax does not apply to 16 year olds and minors.<br />b) The amount of the Tax is € 0.50 per person per day with a maximum of 7 nights. In the case of 4 **** hotels the amount is €1.<br /> <br />The amount of the tax or corresponding fee must be paid, providing the corresponding legal requirements have been met, on the customer’s day of arrival, in the hotel reception. For this reason the customer must be informed of this obligation before entering into the travel contract.</p>]]>
</Description>
<Conditions>
<Penalty Item="1" Percent="100" Nights="none" DaysToCheckin="365" CancellationFees="188.00"/>
</Conditions>
</CancelPenalty>
</RoomStay>
</RoomStays>
</OTA_HotelModRS>
Response with warning or error
<?xml version="1.0" encoding="utf-8" ?>
<OTA_HotelModRS Action="check_roomtype" TimeStamp="2015-02-25T12:03:35" Target="Development">
<Error code="XXXX">
<![CDATA[Detail of error]]>
</Error>
</OTA_HotelModRS>
<?xml version="1.0" encoding="utf-8" ?>
<OTA_HotelModRS Action="check_roomtype" TimeStamp="2015-02-25T12:03:35" Target="Development">
<Warning code="XXXX">
<![CDATA[Detail of error]]>
</Warning>
</OTA_HotelModRS>
Second Request
Modify roomtype: Change roomtype of reservations
Request (Use this second request to select the new room that you wish to confirm. You will need some of the values obtained from response request of first request)
<?xml version="1.0" encoding="UTF-8"?>
<OTA_HotelModRQ PrimaryLangID="en" Action="change_roomtype" >
<Agency UserId="xxxxx"/>
<UniqueID Value="12345"/>
<RoomStay idDataBase="67890" >
<RoomType Code="2"/>
<RatePlan Code="NRAI"/>
</RoomStay>
</OTA_HotelModRQ>
Response
<?xml version="1.0" encoding="utf-8" ?>
<OTA_HotelModRS Action="change_roomtype" TimeStamp="2015-02-25T12:29:54" Target="Development">
<Change Success="1"/>
<UniqueID Value="12345"/>
<UniqueIDExternal Value="AAAAA"/>
<Supplier Name="BBBBB"/>
<Client Name="Michael" Surname="Smith Green" Phone="972411600" Email="web@efimatica.com" Address="none" City="none" Country="none" />
<Roomstays>
<Roomstay idDataBase="67890">
<Hotel Code="6" Name="MedPlaya Hotel Calypso" HotelCategory="3">
<Location Address="Pompeu Fabra, 54-62" PostalCode="43840" City="Salou" Province="Tarragona" GPSLatitude="41.071644417044" GPSLongitude="1.154460310936"/>
<Contact Telephone="+34 977 384 900" Fax="+34 977 383 513" Email="calypso@medplaya.com"/>
<Nif Code="A-12345678"/>
</Hotel>
<RoomType Code="2" NonRefundable="0" SurfaceArea="60" Name="Habitación Doble MedPlaya con terraza"/>
<RatePlan Code="STAI" Name="All inclusive"/>
<Status Code="3" Name="Modified" PreBook="2015-02-25 10:16:54" ConfirmBook="2015-02-25 10:16:54" ModifyBook="2015-02-25 12:29:54" CancelBook="none"/>
<Guest AdultsCount="2" ChildsCount="0" BabiesCount="0"/>
<StayDate Start="2015-03-05" End="2015-03-08">
<Date Value="2015-03-05" Amount="100.00" AmountBeforeSpecial="100.00"/>
<Date Value="2015-03-06" Amount="100.00" AmountBeforeSpecial="100.00"/>
<Date Value="2015-03-07" Amount="100.00" AmountBeforeSpecial="100.00"/>
</StayDate>
<RoomRate Amount="300.00" AmountBeforeSpecial="300.00" CurrencyCode="EUR" PercentagePaid="0.00"/>
<Comment></Comment>
<CancelPenalty>
<Description>
<![CDATA[<p><strong>NOTE</strong>: The ages of the children are between 3 and 12.</p> <p>Cancellations confirmed up to 48 hours prior to arrival date will incur <span style="color: #008000;"><strong>no cancellation fees</strong></span>. <br /><br />In case of cancellation within 48 hours of the arrival date, a cancellation fee - equal to one night accommodation, will be charged.</p> <p>If you do not arrive at the hotel on the reserved arrival date, your reservation will be automatically cancelled.<br /><br /><strong>Tourist tax information</strong></p><p>These prices do not include the tourist or similar tax on hotel stays.<br /> <br />We would like to inform you that in the Community of Catalonia there is a tax on stays at tourist establishments. The basic aspects of this tax are as follows: <br />a) The tax does not apply to 16 year olds and minors.<br />b) The amount of the Tax is € 0.50 per person per day with a maximum of 7 nights. In the case of 4 **** hotels the amount is €1.<br /> <br />The amount of the tax or corresponding fee must be paid, providing the corresponding legal requirements have been met, on the customer’s day of arrival, in the hotel reception. For this reason the customer must be informed of this obligation before entering into the travel contract.</p>]]>
</Description>
<Conditions>
<Penalty Item="1" Percent="100" Nights="none" DaysToCheckin="2" CancellationFees="300.00"/>
</Conditions>
</CancelPenalty>
</Roomstay>
</Roomstays>
</OTA_HotelModRS>
Response with warning or error
<?xml version="1.0" encoding="utf-8" ?>
<OTA_HotelModRS Action="change_roomtype" TimeStamp="2015-02-25T12:31:24" Target="Development">
<Error code="XXXX">
<![CDATA[Detail of error]]>
</Error>
</OTA_HotelModRS>
<?xml version="1.0" encoding="utf-8" ?>
<OTA_HotelModRS Action="change_roomtype" TimeStamp="2015-02-25T12:31:24" Target="Development">
<Warning code="XXXX">
<![CDATA[Detail of error]]>
</Warning>
</OTA_HotelModRS>
These two requests are used to modify the roomtype or rateplan of reservation. With the first request, you can obtain the roomtypes availability. The second requests, will be used to change a roomtype or rateplan.
Notes
- The Status Code is the status of reservation. This value could be 0 (Cancelled), 2 (Confirmed) or 3 (Modified).
- The Status Code of reservation is updated to 3.
- This request requires an idDataBase of room to enable the modification of the booking. You can obtain this value when you make a booking or consult it using the request Get reservation information.
- Modify reservation isn’t supported in case of non-refundable reservations and reservations with packages or discount cupons.
- It’s important to check the Success status in the response of second request (change_roomtype). If the value equals to 1, the change has been completed correctly. Otherwise you will receive a warning o error message.
- All descriptives fields are returned in <![CDATA[...]]> element.
Add comment to reservation
Request
<?xml version="1.0" encoding="UTF-8"?>
<OTA_HotelModRQ PrimaryLangID="en" Action="add_comment" >
<Agency UserId="xxxxx"/>
<UniqueID Value="12345"/>
<AddComment>
<![CDATA[Sorry, we will arrive late.]]>
</AddComment>
</OTA_HotelModRQ>
Response
<?xml version="1.0" encoding="utf-8" ?>
<OTA_HotelModRS Action="add_comment" TimeStamp="2015-02-25T13:09:54" Target="Development">
<Add Success="1"/>
<UniqueID Value="12345"/>
<UniqueIDExternal Value="AAAAA"/>
</OTA_HotelModRS>
Response with warning or error
<?xml version="1.0" encoding="utf-8" ?>
<OTA_HotelModRS Action="add_comment" TimeStamp="2015-02-25T12:31:24" Target="Development">
<Error code="XXXX">
<![CDATA[Detail of error]]>
</Error>
</OTA_HotelModRS>
<?xml version="1.0" encoding="utf-8" ?>
<OTA_HotelModRS Action="add_comment" TimeStamp="2015-02-25T12:31:24" Target="Development">
<Warning code="XXXX">
<![CDATA[Detail of error]]>
</Warning>
</OTA_HotelModRS>
This request allows the addition of new comments to reservations. The hoteliers will recive an email with new comments and they can also check them in the obehotel extranet.
Notes
- The comment must be in plain text. The system doesn’t accept HTML tags or other type of structurated languages.
- We recommend write the comment in <![CDATA[...]]> element as the example.
- Comments may only be added using our identifier of booking (UniqueID). You couldn’t use your identifier (UniqueIDExternal)
Apply promotion to reservation
Request
<?xml version="1.0" encoding="UTF-8"?>
<OTA_HotelModRQ PrimaryLangID="en" Action="apply_promocode" >
<Agency UserId="xxxxx"/>
<UniqueID Value="12345" />
<RoomStay idDataBase="12345" />
<Promotion Code="OFFER2019" />
</OTA_HotelModRQ>
Response
<?xml version="1.0" encoding="utf-8" ?>
<OTA_HotelModRS Action="apply_promocode" TimeStamp="2015-02-25T13:09:54" Target="Development">
<Add Success="1"/>
</OTA_HotelModRS>
Response with warning or error
<?xml version="1.0" encoding="utf-8" ?>
<OTA_HotelModRS Action="apply_promocode" TimeStamp="2015-02-25T12:31:24" Target="Development">
<Error code="XXXX">
<![CDATA[Detail of error]]>
</Error>
</OTA_HotelModRS>
<?xml version="1.0" encoding="utf-8" ?>
<OTA_HotelModRS Action="apply_promocode" TimeStamp="2015-02-25T12:31:24" Target="Development">
<Warning code="XXXX">
<![CDATA[Detail of error]]>
</Warning>
</OTA_HotelModRS>
This request apply a promotion code to reservation. The hoteliers will recive a notification with new reservation prices.
Notes
- It’s important to check the Success status in the response
Cancel reservation
Request
<?xml version="1.0" encoding="UTF-8"?>
<OTA_CancelRQ PrimaryLangID="en">
<Agency UserId="xxxxx"/>
<UniqueID Value="12345" />
<Roomstay idDataBase="all" />
</OTA_CancelRQ>
Request using identifier of agency B2B
<?xml version="1.0" encoding="UTF-8"?>
<OTA_CancelRQ PrimaryLangID="en">
<Agency UserId="xxxxx"/>
<UniqueIDExternal Value="AAAAA" />
<Roomstay idDataBase="all" />
</OTA_CancelRQ>
Response
<?xml version="1.0" encoding="utf-8" ?>
<OTA_CancelRS TimeStamp="2015-02-25T15:26:57" Target="Development">
<Cancel Success="1"/>
<UniqueID Value="12345"/>
<UniqueIDExternal Value="AAAAA"/>
<Supplier Name="BBBBB"/>
<Client Name="Michael" Surname="Smith Green" Phone="972411600" Email="web@efimatica.com" Address="none" City="none" Country="none" />
<Roomstays>
<Roomstay idDataBase="67890">
<Hotel Code="6" Name="MedPlaya Hotel Calypso" HotelCategory="3">
<Location Address="Pompeu Fabra, 54-62" PostalCode="43840" City="Salou" Province="Tarragona" GPSLatitude="41.071644417044" GPSLongitude="1.154460310936"/>
<Contact Telephone="+34 977 384 900" Fax="+34 977 383 513" Email="calypso@medplaya.com"/>
<Nif Code="A-12345678"/>
</Hotel>
<RoomType Code="2" NonRefundable="1" SurfaceArea="60" Name="Habitación Doble MedPlaya con terraza"/>
<RatePlan Code="NRAI" Name="Non Refundable All inclusive"/>
<Status Code="0" Name="Cancelled" PreBook="2015-02-25 10:16:54" ConfirmBook="2015-02-25 10:16:54" ModifyBook="2015-02-25 12:29:54" CancelBook="2015-02-25 15:21:10"/>
<Guest AdultsCount="2" ChildsCount="0" BabiesCount="0"/>
<StayDate Start="2015-03-05" End="2015-03-08">
<Date Value="2015-03-05" Amount="100.00" AmountBeforeSpecial="100.00"/>
<Date Value="2015-03-06" Amount="100.00" AmountBeforeSpecial="100.00"/>
<Date Value="2015-03-07" Amount="100.00" AmountBeforeSpecial="100.00"/>
</StayDate>
<RoomRate Amount="300.00" AmountBeforeSpecial="300.00" CurrencyCode="EUR" PercentagePaid="0.00" CancellationFeesApplied="37.60" />
<Comment>
<![CDATA[This ' and and finaly. ok | Sorry, we will arrive late.]]>
</Comment>
<CancelPenalty>
<Description>
<![CDATA[<p><strong>NOTE</strong>: The ages of the children are between 3 and 12.</p> <p>Cancellations confirmed up to 48 hours prior to arrival date will incur <span style="color: #008000;"><strong>no cancellation fees</strong></span>. <br /><br />In case of cancellation within 48 hours of the arrival date, a cancellation fee - equal to one night accommodation, will be charged.</p> <p>If you do not arrive at the hotel on the reserved arrival date, your reservation will be automatically cancelled.<br /><br /><strong>Tourist tax information</strong></p> <p>These prices do not include the tourist or similar tax on hotel stays.<br /> <br />We would like to inform you that in the Community of Catalonia there is a tax on stays at tourist establishments. The basic aspects of this tax are as follows: <br />a) The tax does not apply to 16 year olds and minors.<br />b) The amount of the Tax is € 0.50 per person per day with a maximum of 7 nights. In the case of 4 **** hotels the amount is €1.<br /> <br />The amount of the tax or corresponding fee must be paid, providing the corresponding legal requirements have been met, on the customer’s day of arrival, in the hotel reception. For this reason the customer must be informed of this obligation before entering into the travel contract.</p>]]>
</Description>
<Conditions>
<Penalty Item="1" Percent="50" Nights="none" DaysToCheckin="2" CancellationFees="188.00"/>
<Penalty Item="2" Percent="25" Nights="none" DaysToCheckin="14" CancellationFees="94.00"/>
<Penalty Item="3" Percent="10" Nights="none" DaysToCheckin="31" CancellationFees="37.60"/>
</Conditions>
</CancelPenalty>
</Roomstay>
</Roomstays>
<TotalReservation Amount="300.00" CurrencyCode="EUR" PriceType="cm" Commission="15.00"/>
</OTA_CancelRS>
Response with warning or error
<?xml version="1.0" encoding="utf-8" ?>
<OTA_CancelRS TimeStamp="2015-02-25T15:45:05" Target="Development">
<Error code="XXXX">
<![CDATA[Detail of error]]>
</Error>
</OTA_CancelRS>
<?xml version="1.0" encoding="utf-8" ?>
<OTA_CancelRS TimeStamp="2015-02-25T15:45:05" Target="Development">
<Warning code="XXXX">
<![CDATA[Detail of error]]>
</Warning>
</OTA_CancelRS>
The request for a reservation cancellation is used to cancel a reservation. If the reservation has several rooms, you could cancel only one room or all the reservation. All the cancellations are subject to a cancellation policy and this policy should be reviewed prior to cancelling a reservation.
Notes
- The Status Code is the status of reservation. This value could be 0 (Cancelled), 2 (Confirmed) or 3 (Modified).
- The Status Code of reservation is updated to 0.
- Use UniqueID element for cancel the reservation using the ObeHotel identifier of booking.
- Use UniqueIDExternal element for cancel the reservation using your (parent B2B) identifier of booking.
- If the reservation has multiple rooms, you could cancel all rooms setting the value all in idDataBase attribute. You can find it in element Roomstay.
- If the reservation has multiple rooms you could cancel only one room using the idDateBase value. You can obtain this value when you make a booking or consult it using the request Get reservation information.
- All descriptive fields are returned in <![CDATA[...]]> element.
- The CancelPenalty Description is a detail of cancellation policy with text format.
- The CancelPenalty Conditions is a detail of cancellation with parameters. The mean of parameters are:
- Penalty - Item: Name of rule cancellation policy parameterized.
- Penalty - Percent: Percentage of payment in case of cancellation.
- Penalty - Nights: This value is only informative. It is a value greater than zero when the hotel has put the cancellation policy in nights. The system has calculed the Percent field value from this. In the case that the policy is directly in percentage, this field is "none".
- Penalty - DaysToCheckin: Days in advance applicable for cancellation fees.
- Penalty - CancellationFees: Calculated fees in case of cancellation.
Get information of reservations
Request
<?xml version="1.0" encoding="UTF-8"?>
<OTA_ReservationInfoRQ PrimaryLangID="en">
<Agency UserId="xxxxx"/>
<UniqueID Value="12345"/>
</OTA_ReservationInfoRQ>
Request using indentifier of agency B2B
<?xml version="1.0" encoding="UTF-8"?>
<OTA_ReservationInfoRQ PrimaryLangID="en">
<Agency UserId="xxxxx"/>
<UniqueIDExternal Value="AAAAA"/>
</OTA_ReservationInfoRQ>
Request by hotel and dates
<?xml version="1.0" encoding="UTF-8"?>
<OTA_ReservationInfoRQ PrimaryLangID="en">
<Agency UserId="xxxxx"/>
<Date Start="2015-02-25" End="2015-02-25" HotelCode="6" />
</OTA_ReservationInfoRQ>
Response
<?xml version="1.0" encoding="UTF-8"?>
<OTA_ReservationInfoRS TimeStamp="2015-02-25T16:36:48" Target="Development">
<Reservations>
<Reservation>
<UniqueID Value="12345"/>
<UniqueIDExternal Value="AAAAA"/>
<Supplier Name="BBBBB"/>
<Client Name="Michael" Surname="Smith Green" Phone="972411600" Email="web@efimatica.com" Address="none" City="none" Country="none" />
<Roomstays>
<Roomstay idDataBase="67890">
<Hotel Code="6" Name="MedPlaya Hotel Calypso" HotelCategory="3">
<Location Address="Pompeu Fabra, 54-62" PostalCode="43840" City="Salou" Province="Tarragona" GPSLatitude="41.071644417044" GPSLongitude="1.154460310936"/>
<Contact Telephone="+34 977 384 900" Fax="+34 977 383 513" Email="calypso@medplaya.com"/>
<Nif Code="A-12345678"/>
</Hotel>
<RoomType Code="2" NonRefundable="1" SurfaceArea="60" Name="Habitación Doble MedPlaya con terraza"/>
<RatePlan Code="NRAI" Name="Non Refundable All inclusive"/>
<Status Code="0" Name="Cancelled" PreBook="2015-02-25 10:16:54" ConfirmBook="2015-02-25 10:16:54" ModifyBook="2015-02-25 12:29:54" CancelBook="2015-02-25 15:23:53"/>
<Guest AdultsCount="2" ChildsCount="0" BabiesCount="0"/>
<StayDate Start="2015-03-05" End="2015-03-08">
<Date Value="2015-03-05" Amount="100.00" AmountBeforeSpecial="100.00"/>
<Date Value="2015-03-06" Amount="100.00" AmountBeforeSpecial="100.00"/>
<Date Value="2015-03-07" Amount="100.00" AmountBeforeSpecial="100.00"/>
</StayDate>
<RoomRate Amount="300.00" AmountBeforeSpecial="300.00" CurrencyCode="EUR" PercentagePaid="0.00" CancellationFeesApplied="37.60" />
<Comment>
<![CDATA[This ' and and finaly. ok | Sorry, we will arrive late.]]>
</Comment>
<CancelPenalty>
<Description>
<![CDATA[<p><strong>NOTE</strong>: The ages of the children are between 3 and 12.</p> <p>Cancellations confirmed up to 48 hours prior to arrival date will incur <span style="color: #008000;"><strong>no cancellation fees</strong></span>. <br /><br />In case of cancellation within 48 hours of the arrival date, a cancellation fee - equal to one night accommodation, will be charged.</p> <p>If you do not arrive at the hotel on the reserved arrival date, your reservation will be automatically cancelled.<br /><br /><strong>Tourist tax information</strong></p> <p>These prices do not include the tourist or similar tax on hotel stays.<br /> <br />We would like to inform you that in the Community of Catalonia there is a tax on stays at tourist establishments. The basic aspects of this tax are as follows: <br />a) The tax does not apply to 16 year olds and minors.<br />b) The amount of the Tax is € 0.50 per person per day with a maximum of 7 nights. In the case of 4 **** hotels the amount is €1.<br /> <br />The amount of the tax or corresponding fee must be paid, providing the corresponding legal requirements have been met, on the customer’s day of arrival, in the hotel reception. For this reason the customer must be informed of this obligation before entering into the travel contract.</p>]]>
</Description>
<Conditions>
<Penalty Item="1" Percent="50" Nights="none" DaysToCheckin="2" CancellationFees="188.00"/>
<Penalty Item="2" Percent="25" Nights="none" DaysToCheckin="14" CancellationFees="94.00"/>
<Penalty Item="3" Percent="10" Nights="none" DaysToCheckin="31" CancellationFees="37.60"/>
</Conditions>
</CancelPenalty>
</Roomstay>
</Roomstays>
<TotalReservation Amount="300.00" CurrencyCode="EUR" PriceType="cm" Commission="15.00"/>
</Reservation>
</Reservations>
</OTA_ReservationInfoRS>
Response with no reservations
<?xml version="1.0" encoding="utf-8" ?>
<OTA_ReservationInfoRS TimeStamp="2015-02-25T15:45:05" Target="Development">
<Error code="XXXX">
<![CDATA[Detail of error]]>
</Error>
</OTA_ReservationInfoRS>
This XML request returns confirmed, cancelled o modified reservations depending on filters. You could get the information of one reservation using UniqueID or UniqueIDExternal element. Otherwise, you could get all reservations using a range of dates.
Notes
- You can get the information of reservations using UniqueID, UniqueIDExternal or dates ranges.
- You can get all reservations of one day. For example, day 25 of March of 2015. <Date Start="2015-03-25" End="2015-03-25" HotelCode="X" />
- All descriptive fields are returned in <![CDATA[...]]> element.
- The IdDataBase is the identifier of the roomstay in that reservation.
- The Status Code is the status of reservation. This value could be 0 (Cancelled), 2 (Confirmed) or 3 (Modified).
- The Status prebook is the time of pre-reservation. In this version of obehotel, it will always appear as ConfirmBook.
- The Status ConfirmBook is the time of reservation is confirmed.
- The Status CancelBook is the time of reservation cancelled.
- The Status ModifyBook is the time of reservation is modified.
- The RoomRate Amount is the price of room.
- The RoomRate PercentagePaid is the percentage paid using ObeHotel Payment system. Travel agents shouldn’t use this value.
- The TotalReservation Amount is the total price for the reservation. This is the sum of the price for each room requested.
- The CancelPenalty Description is a detail of cancellation policy with text format.
- The CancelPenalty Conditions is a detail of cancellation with parameters. The meanings of the parameters are:
- Penalty - Item: Name of rule cancellation policy parameterized.
- Penalty - Percent: Percentage of payment in case of cancellation.
- Penalty - Nights: This value is only informative. It is a value greater than zero when the hotel has put the cancellation policy in nights. The system has calculed the Percent field value from this. In the case that the policy is directly in percentage, this field is "none".
- Penalty - DaysToCheckin: Days in advance applicable for cancellation fees.
- Penalty - CancellationFees: Calculated fees in case of cancellation.
- The Comments are the comments of client about the reservation.
- The Supplier Name shows where the booking has been made.
- The attribute Price Type can be "pn" for Net Rates or "cm" for Gross Rates.
- The attribute Commission shows the commission rate agreed between the Agency and the Hotel.
XML Requests: Generic
Get languages list
Request
<?xml version="1.0" encoding="UTF-8"?>
<OTA_LanguageListRQ PrimaryLangID="en">
<Agency UserId="xxxxx"/>
</OTA_LanguageListRQ>
Response
<?xml version="1.0" encoding="UTF-8"?>
<OTA_LanguageListRS TimeStamp="2015-02-25T17:16:35" Target="Development">
<Languages>
<Language Code="de" Name="Alemán"/>
<Language Code="ma" Name="Árabe"/>
<Language Code="ca" Name="Catalán"/>
<Language Code="cn" Name="Chino"/>
<Language Code="es" Name="Español"/>
<Language Code="eu" Name="Euskera"/>
<Language Code="fr" Name="Francés"/>
<Language Code="en" Name="Inglés"/>
<Language Code="it" Name="Italiano"/>
<Language Code="nl" Name="Nederlands"/>
<Language Code="pl" Name="Polaco"/>
<Language Code="ru" Name="Ruso"/>
</Languages>
</OTA_LanguageListRS>
This request returns a list of all supportable languages.
Get countries list
Request
<?xml version="1.0" encoding="UTF-8"?>
<OTA_CountryListRQ PrimaryLangID="en">
<Agency UserId="xxxxx"/>
</OTA_CountryListRQ>
Response
<?xml version="1.0" encoding="utf-8" ?>
<OTA_CountryListRS TimeStamp="2020-06-10T10:44:22" Target="Production">
<Countries>
<Country Code="1" CodeIso3361="AD" Name="Andorra" />
<Country Code="2" CodeIso3361="AE" Name="E.A.U." />
<Country Code="3" CodeIso3361="AF" Name="Afghanistan" />
<Country Code="4" CodeIso3361="AG" Name="Antigua / Barbuda" />
<Country Code="5" CodeIso3361="AI" Name="Eel" />
<Country Code="6" CodeIso3361="AL" Name="Albania" />
<Country Code="7" CodeIso3361="AM" Name="Armenia" />
<Country Code="8" CodeIso3361="AN" Name="Netherlands Antilles." />
<Country Code="9" CodeIso3361="AO" Name="Angola" />
<Country Code="10" CodeIso3361="AQ" Name="Antarctica" />
<Country Code="11" CodeIso3361="AR" Name="Argentina" />
</Countries>
</OTA_CountryListRS>
This request returns a list of all the countries in our database.
Notes
- The CodeIso3361 is a country code based as a subset of ISO 3166-1 alpha-2 codes. More info: https://www.iso.org/iso-3166-country-codes.html.
Get provinces list
Request
<?xml version="1.0" encoding="UTF-8"?>
<OTA_ProvinceListRQ PrimaryLangID="en">
<Agency UserId="xxxxx"/>
<Countries>
<Country Code="66" />
</Countries>
</OTA_ProvinceListRQ>
Response
<?xml version="1.0" encoding="UTF-8"?>
<OTA_ProvinceListRS TimeStamp="2015-02-25T17:48:27" Target="Development">
<Provinces>
<Province Code="1" Name="Álava" IdCountry="66"/>
<Province Code="2" Name="Albacete" IdCountry="66"/>
<Province Code="3" Name="Alicante" IdCountry="66"/>
<Province Code="48" Name="Vizcaya" IdCountry="66"/>
<Province Code="49" Name="Zamora" IdCountry="66"/>
<Province Code="50" Name="Zaragoza" IdCountry="66"/>
</Provinces>
</OTA_ProvinceListRS>
This request returns a list of provinces that are part of the requested country.
Notes
- If you set the value 0 to Country Code, you will recive a list of all provinces. For example <Country Code="0" />
Get cities list
Request
<?xml version="1.0" encoding="UTF-8"?>
<OTA_CityListRQ PrimaryLangID="en">
<Agency UserId="xxxxx"/>
<Provinces>
<Province Code="8" />
<Province Code="17" />
</Provinces>
</OTA_CityListRQ>
Response
<?xml version="1.0" encoding="UTF-8"?>
<OTA_CityListRS TimeStamp="2015-02-25T17:52:08" Target="Development">
<Cities>
<City Code="872" Name="Abrera" IdProvince="8"/>
<City Code="873" Name="Aguilar de Segarra" IdProvince="8"/>
<City Code="2461" Name="Agullana" IdProvince="17"/>
<City Code="1181" Name="Vilobí del Penedès" IdProvince="8"/>
<City Code="2681" Name="Vilopriu" IdProvince="17"/>
<City Code="1182" Name="Viver i Serrateix" IdProvince="8"/>
</Cities>
</OTA_CityListRS>
This request gets all the cities that are part of a province or country.
Notes
- You can search citeis using filters of Province Code o Country Code.
- If you set the value 0 to Country Code, you will recive a list of all cities. For example <Country Code="0" />
Get destinations list
Request
<?xml version="1.0" encoding="UTF-8"?>
<OTA_DestinationListRQ PrimaryLangID="en">
<Agency UserId="xxxxx"/>
</OTA_DestinationListRQ>
Response
<?xml version="1.0" encoding="UTF-8"?>
<OTA_DestinationListRS TimeStamp="2015-02-25T17:55:51" Target="Development">
<Destinations>
<Destination Code="168" CodeByRequestCity="ds-168" Name="Adeje"/>
<Destination Code="119" CodeByRequestCity="ds-119" Name="Aguadulce"/>
<Destination Code="152" CodeByRequestCity="ds-152" Name="Alcudia"/>
<Destination Code="158" CodeByRequestCity="ds-158" Name="Tossa de Mar"/>
<Destination Code="134" CodeByRequestCity="ds-134" Name="Vera"/>
<Destination Code="171" CodeByRequestCity="ds-171" Name="Yaiza"/>
</Destinations>
</OTA_DestinationListRS>
This request gets all destinations.
Get hotels list
Request
<?xml version="1.0" encoding="UTF-8"?>
<OTA_HotelListRQ PrimaryLangID="en">
<Agency UserId="xxxxx"/>
</OTA_HotelListRQ>
Request with filter by country
<?xml version="1.0" encoding="UTF-8"?>
<OTA_HotelListRQ PrimaryLangID="en">
<Agency UserId="xxxxx"/>
<Countries>
<Country Code="66" />
</Countries>
</OTA_HotelListRQ>
Response
<?xml version="1.0" encoding="UTF-8"?>
<OTA_HotelListRS TimeStamp="2020-03-10T13:20:21" Target="Production">
<Hotels>
<Hotel Code="1" Name="MedPlaya Hotel Monterrey" Category="3" IdCity="2504" IdProvince="17" IdCountry="66" City="Platja d'Aro" Province="Girona" Country="Spain" Latitude="41.808303" Longitude="3.064683" Website="https://www.medplaya.com/hotels/hotel-monterrey-platja-aro.html" Inventory="Yes" />
<Hotel Code="2" Name="MedPlaya Hotel Esmeraldas" Category="2" IdCity="2651" IdProvince="17" IdCountry="66" City="Tossa de Mar" Province="Girona" Country="Spain" Latitude="41.7242215882" Longitude="2.93119445443" Website="https://www.medplaya.com/hotels/hotel-esmeraldas-tossa-de-mar.html" Inventory="Yes" />
<Hotel Code="3" Name="MedPlaya Hotel San Eloy" Category="2" IdCity="2651" IdProvince="17" IdCountry="66" City="Tossa de Mar" Province="Girona" Country="Spain" Latitude="41.729306" Longitude="2.907905" Website="https://www.medplaya.com/hotels/hotel-san-eloy-tossa-de-mar.html" Inventory="Yes" />
<Hotel Code="4" Name="Albatros Family" Category="3" IdCity="6491" IdProvince="43" IdCountry="66" City="Salou" Province="Tarragona" Country="Spain" Latitude="41.067165" Longitude="1.149622" Website="https://www.medplaya.com/hotels/albatros-family-salou.html" Inventory="Yes" />
<Hotel Code="5" Name="MedPlaya Hotel Santa Monica" Category="3" IdCity="908" IdProvince="8" IdCountry="66" City="Calella" Province="Barcelona" Country="Spain" Latitude="41.611412" Longitude="2.649915" Website="https://www.medplaya.com/hotels/hotel-santa-monica-calella.html" Inventory="Yes"/>
<Hotel Code="6" Name="MedPlaya Hotel Calypso" Category="3" IdCity="6491" IdProvince="43" IdCountry="66" City="Salou" Province="Tarragona" Country="Spain" Latitude="41.071644417044" Longitude="1.154460310936" Website="https://www.medplaya.com/hotels/hotel-calypso-salou.html" Inventory="Yes" />
<Hotel Code="7" Name="MedPlaya Hotel Balmoral" Category="2" IdCity="4490" IdProvince="29" IdCountry="66" City="Benalmadena Costa" Province="Málaga" Country="Spain" Latitude="36.588806" Longitude="-4.531091" Website="https://www.medplaya.com/hotels/hotel-balmoral-benalmadena.html" Inventory="Yes" />
<Hotel Code="8" Name="MedPlaya Hotel Rio Park" Category="2" IdCity="179" IdProvince="3" IdCountry="66" City="Benidorm" Province="Alicante" Country="Spain" Latitude="38.541174" Longitude="-0.117859" Website="https://www.medplaya.com/hotels/hotel-riopark-benidorm.html" Inventory="Yes" />
<Hotel Code="9" Name="MedPlaya Hotel Riudor" Category="3" IdCity="179" IdProvince="3" IdCountry="66" City="Benidorm" Province="Alicante" Country="Spain" Latitude="38.536328" Longitude="-0.111229" Website="https://www.medplaya.com/hotels/hotel-riudor-benidorm.html" Inventory="Yes" />
<Hotel Code="10" Name="MedPlaya Hotel Bali" Category="3" IdCity="4490" IdProvince="29" IdCountry="66" City="Benalmadena Costa" Province="Málaga" Country="Spain" Latitude="36.595226" Longitude="-4.522845" Website="https://www.medplaya.com/hotels/hotel-bali-benalmadena.html" Inventory="Yes" />
<Hotel Code="11" Name="MedPlaya Hotel Riviera" Category="4" IdCity="4490" IdProvince="29" IdCountry="66" City="Benalmadena Costa" Province="Málaga" Country="Spain" Latitude="36.59466" Longitude="-4.520493" Website="https://www.medplaya.com/hotels/hotel-riviera-benalmadena.html" Inventory="Yes"/>
<Hotel Code="12" Name="MedPlaya Hotel Pez Espada" Category="4" IdCity="4555" IdProvince="29" IdCountry="66" City="Torremolinos" Province="Málaga" Country="Spain" Latitude="36.605816" Longitude="-4.50772" Website="https://www.medplaya.com/hotels/hotel-pez-espada-torremolinos.html" Inventory="Yes" />
<Hotel Code="13" Name="MedPlaya Hotel Regente" Category="3" IdCity="179" IdProvince="3" IdCountry="66" City="Benidorm" Province="Alicante" Country="Spain" Latitude="38.538576" Longitude="-0.10473" Website="https://www.medplaya.com/hotels/hotel-regente-benidorm.html" Inventory="Yes"/>
<Hotel Code="14" Name="MedPlaya Hotel Flamingo Oasis" Category="4" IdCity="179" IdProvince="3" IdCountry="66" City="Benidorm" Province="Alicante" Country="Spain" Latitude="38.541168" Longitude="-0.104505" Website="https://www.medplaya.com/hotels/hotel-flamingo-oasis-benidorm.html" Inventory="Yes" />
<Hotel Code="15" Name="MedPlaya Bella Vista Beach Club" Category="4" IdCity="8123" IdProvince="152" IdCountry="22" City="Sinemorets" Province="Burgas" Country="Bulgaria" Latitude="42.057976" Longitude="27.986877" Website="http://www.bellavistahotelbulgaria.com/" Inventory="Yes" />
<Hotel Code="17" Name="MedPlaya Hotel Piramide Salou" Category="4" IdCity="6491" IdProvince="43" IdCountry="66" City="Salou" Province="Tarragona" Country="Spain" Latitude="41.075158" Longitude="1.149036" Website="https://www.medplaya.com/hotels/hotel-piramide-salou.html" Inventory="No" />
<Hotel Code="18" Name="MedPlaya Hotel Agir" Category="4" IdCity="179" IdProvince="3" IdCountry="66" City="Benidorm" Province="Alicante" Country="Spain" Latitude="38.537233" Longitude="-0.121457" Website="https://www.medplaya.com/hotels/hotel-agir-benidorm.html" Inventory="No" />
</Hotels>
</OTA_HotelListRS>
This request get a list of hotels enabled for an agency. It is also possible to use location filters.
Notes
- You could get hotels using Country Code, Province Code, City Code or Destination Code
Get hotel services list
Request
<?xml version="1.0" encoding="UTF-8"?>
<OTA_ServiceHotelListRQ PrimaryLangID="en">
<Agency UserId="xxxxx"/>
</OTA_ServiceHotelListRQ>
Response
<?xml version="1.0" encoding="UTF-8"?>
<OTA_ServiceHotelListRS TimeStamp="2015-02-25T18:04:24" Target="Development">
<Services>
<Service Code="31" Name="24 hour reception"/>
<Service Code="49" Name="Al Fresco restaurant (July and August)"/>
<Service Code="37" Name="Bar"/>
<Service Code="48" Name="Supermarket"/>
<Service Code="6" Name="Tennis court"/>
<Service Code="39" Name="Wi-Fi"/>
</Services>
</OTA_ServiceHotelListRS>
This request returns a list of all available services of the hotel.
Get room services list
Request
<?xml version="1.0" encoding="UTF-8"?>
<OTA_ServiceRoomListRQ PrimaryLangID="en">
<Agency UserId="xxxxx"/>
</OTA_ServiceRoomListRQ>
Response
<?xml version="1.0" encoding="UTF-8"?>
<OTA_ServiceRoomListRS TimeStamp="2015-02-25T18:05:40" Target="Development">
<Services>
<Service Code="1" Name="Air-conditioning"/>
<Service Code="25" Name="Balcony/Terrace"/>
<Service Code="61" Name="Bathrobe"/>
<Service Code="20" Name="Satellite television"/>
<Service Code="66" Name="Telephone"/>
<Service Code="65" Name="Welcome Amenities"/>
</Services>
</OTA_ServiceRoomListRS>
This request returns a list of all available services of the room.
Get room models list
Request
<?xml version="1.0" encoding="UTF-8"?>
<OTA_RoomModelRQ PrimaryLangID="en">
<Agency UserId="xxxxx"/>
</OTA_RoomModelRQ>
Response
<?xml version="1.0" encoding="UTF-8"?>
<OTA_RoomModelRS TimeStamp="2015-05-06T12:48:03" Target="Production">
<Models>
<Model Code="1" Name="Generic" />
<Model Code="2" Name="Twin" />
<Model Code="3" Name="Twin Sea View" />
<Model Code="4" Name="Twin Superior" />
<Model Code="5" Name="Twin with extra bed" />
<Model Code="6" Name="Triple" />
<Model Code="7" Name="Quadruple" />
<Model Code="8" Name="Single" />
<Model Code="9" Name="Junior Suite" />
<Model Code="10" Name="Suite" />
<Model Code="11" Name="1 bedroomed Apartment (2 – 4)" />
<Model Code="12" Name="2 bedroomed Apartment (4 – 6)" />
<Model Code="13" Name="Studio" />
</Models>
</OTA_RoomModelRS>
This request returns a list of all room models available in our plataform. You could use it for map roomtypes with your system.
Get rateplan models list
Request
<?xml version="1.0" encoding="UTF-8"?>
<OTA_RateModelRQ PrimaryLangID="en">
<Agency UserId="xxxxx"/>
</OTA_RateModelRQ>
Response
<?xml version="1.0" encoding="UTF-8"?>
<OTA_RateModelRS TimeStamp="2015-05-06T12:52:01" Target="Production">
<Models>
<Model Code="STRO" Name="Rate Room Only" />
<Model Code="STBB" Name="Rate Bed and Breakfast" />
<Model Code="STHB" Name="Rate Half Board" />
<Model Code="STFB" Name="Rate Full Board" />
<Model Code="STAI" Name="Rate All inclusive" />
<Model Code="EBRO" Name="Early Booking Room Only" />
<Model Code="EBBB" Name="Early Booking Bed and Breakfast" />
<Model Code="EBHB" Name="Early Booking Half Board" />
<Model Code="EBFB" Name="Early Booking Full Board" />
<Model Code="EBAI" Name="Early Booking All inclusive" />
<Model Code="ONRO" Name="One Night Room Only" />
<Model Code="ONBB" Name="One Night Bed and Breakfast" />
<Model Code="ONHB" Name="One Night Half Board" />
<Model Code="ONFB" Name="One Night Full Board" />
<Model Code="ONAI" Name="One Night All inclusive" />
<Model Code="SSRO" Name="Short Stay Room Only" />
<Model Code="SSBB" Name="Short Stay Bed and Breakfast" />
<Model Code="SSHB" Name="Short Stay Half Board" />
<Model Code="SSFB" Name="Short Stay Full Board" />
<Model Code="SSAI" Name="Short Stay All inclusive" />
<Model Code="S2RO" Name="Short Stay 2N Room Only" />
<Model Code="S2BB" Name="Short Stay 2N Bed and Breakfast" />
<Model Code="S2HB" Name="Short Stay 2N Half Board" />
<Model Code="S2FB" Name="Short Stay 2N Full Board" />
<Model Code="S2AI" Name="Short Stay 2N All inclusive" />
<Model Code="S3RO" Name="Short Stay 3N Room Only" />
<Model Code="S3BB" Name="Short Stay 3N Bed and Breakfast" />
<Model Code="S3HB" Name="Short Stay 3N Half Board" />
<Model Code="S3FB" Name="Short Stay 3N Full Board" />
<Model Code="S3AI" Name="Short Stay 3N All inclusive" />
<Model Code="LSRO" Name="Long Stay Room Only" />
<Model Code="LSBB" Name="Long Stay Bed and Breakfast" />
<Model Code="LSHB" Name="Long Stay Half Board" />
<Model Code="LSFB" Name="Long Stay Full Board" />
<Model Code="LSAI" Name="Long Stay All inclusive" />
<Model Code="L7RO" Name="Long Stay 7N Room Only" />
<Model Code="L7BB" Name="Long Stay 7N Bed and Breakfast" />
<Model Code="L7HB" Name="Long Stay 7N Half Board" />
<Model Code="L7FB" Name="Long Stay 7N Full Board" />
<Model Code="L7AI" Name="Long Stay 7N All inclusive" />
<Model Code="L1RO" Name="Long Stay 10N Room Only" />
<Model Code="L1BB" Name="Long Stay 10N Bed and Breakfast" />
<Model Code="L1HB" Name="Long Stay 10N Half Board" />
<Model Code="L1FB" Name="Long Stay 10N Full Board" />
<Model Code="L1AI" Name="Long Stay 10N All inclusive" />
<Model Code="NRRO" Name="Non Refundable Room Only" />
<Model Code="NRBB" Name="Non Refundable Bed and Breakfast" />
<Model Code="NRHB" Name="Non Refundable Half Board" />
<Model Code="NRFB" Name="Non Refundable Full Board" />
<Model Code="NRAI" Name="Non Refundable All inclusive" />
</Models>
</OTA_RateModelRS>
This request returns a list of all rateplans models available in our plataform. You could use it for map ratepan with your system.
Get hotel types list
Request
<?xml version="1.0" encoding="UTF-8"?>
<OTA_HotelTypeListRQ PrimaryLangID="en">
<Agency UserId="xxxxx"/>
</OTA_HotelTypeListRQ>
Response
<?xml version="1.0" encoding="UTF-8"?>
<OTA_HotelTypeListRS TimeStamp="2016-02-10T12:52:01" Target="Production">
<HotelType>
<Type Code="1" Name="Apartment" />
<Type Code="2" Name="Guest accomodation" />
<Type Code="3" Name="Hotel" />
<Type Code="4" Name="Residence" />
<Type Code="5" Name="Roulette" />
<Type Code="6" Name="Pension" />
</HotelType>
</OTA_HotelTypeListRS>
This request returns a list of hotels types available in our plataform. You could use it for map all hotels types in your system.
Errors
The Kittn API uses the following error codes:
| Error Code | Meaning |
|---|---|
| 400 | Bad Request -- Your request is invalid. |
| 401 | Unauthorized -- Your API key is wrong. |
| 403 | Forbidden -- The kitten requested is hidden for administrators only. |
| 404 | Not Found -- The specified kitten could not be found. |
| 405 | Method Not Allowed -- You tried to access a kitten with an invalid method. |
| 406 | Not Acceptable -- You requested a format that isn't json. |
| 410 | Gone -- The kitten requested has been removed from our servers. |
| 418 | I'm a teapot. |
| 429 | Too Many Requests -- You're requesting too many kittens! Slow down! |
| 500 | Internal Server Error -- We had a problem with our server. Try again later. |
| 503 | Service Unavailable -- We're temporarily offline for maintenance. Please try again later. |
Release notes
2016-02-10 | Version 4.2.1
- First release of the new ObeHotel API XML specification.
2016-02-12 | Version 4.2.1
- Added request Get Hotel Types List.
- Added the Type attribute in the Hotel element on Get hotel information response.
- Added value 3 in Status on Get information of reservations response. This value could be 0 (Cancelled), 2 (Confirmed) or 3 (Modified).
- The request Get information of reservations by dates returns the reservations cancelled or modified between these dates too.
- Added Supplier Name field in Get information of reservations response. It shows where the booking has been made.
2016-02-29 | Version 4.2.2
- Added attribute Price Type in Get Availability, Make reservation and Get Reservation. This attribute can be "pn" for Net Rates or "cm" for Gross Rates.
- Added attribute Commission in Get Availability, Make reservation and Get Reservation. This attribute shows the commission rate agreed between the Agency and the Hotel.
2018-02-27 | Version 4.2.3
- Added requests Get Package List & Get Offer List.
2018-04-08 | Version 4.5.5
- Added % NRF policy in description.
2018-04-26 | Version 4.5.6
- Added checkin and checkout time of reception.
2018-07-06 | Version 4.5.7
- Added request Get Hotel Comment List.
- Added description and examples for the attribute CancellationFees in the Penalty element for Cancel Reservation and Get information of reservations.
- Added multiple examples of Penalty elements in Cancel Reservation and Get information of reservations. There can be up to three.
2018-07-16 | Version 4.5.8
- Added request for add comments to Hotel.
2019-04-30 | Version 5.0.0
- Added compatibility for policy cancellation in nights.
- Added field CancellationFeesApplied in cancelled reservations.
- Added field Name on reservations status.
- Added support for list and insert comments.
2019-05-07 | Version 5.0.1
- Added promtion code list request.
2019-08-20 | Version 5.0.2
- Added multi hotel support to promotion code list request.
2020-02-20 | Version 5.0.3
- Added apply promotion to reservation request.
- Added minified hotel list request.
2020-06-10 | Version 5.0.4
- Added ISO 3166-1 alpha-2 codes on country list request.
2020-06-10 | Version 5.0.5
- Added support for address, city and country on client details.
Contact details
Please do not hesitate to contact us for any query or question you may have.
IT Department - Integrations XML.
Tel. +34 972 411 600
web@efimatica.com
Monday to Friday
9.00 - 14.00 and 15.00 - 18.00