Skip to main content
Deprecated API

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

Descriptive Info

The Descriptive Info method returns the details of a hotel (pictures, descriptions…) in a given language from a supplier's access, granting you access to all the properties configured by the Seller for a given set of credentials. The returned fields include: Images, Description, Views, Attributes etc.

caution

The amount of information and content returned might vary between Sellers.

DescriptiveInfo Request​

<soapenv:Envelope xmlns:soapenv = "http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns = "http://schemas.xmltravelgate.com/hub/2012/06" xmlns:wsse = "http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
   <soapenv:Header>
      <wsse:Security>
         <wsse:UsernameToken>
            <wsse:Username>username</wsse:Username>
            <wsse:Password>password</wsse:Password>
         </wsse:UsernameToken>
      </wsse:Security>
   </soapenv:Header>
   <soapenv:Body>
      <ns:DescriptiveInfo>
         <ns:descriptiveInfoRQ>
            <ns:timeoutMilliseconds>20000</ns:timeoutMilliseconds>
            <ns:version>1</ns:version>
            <ns:providerRQ>
               <ns:code>suppliercode</ns:code>
               <ns:id>1</ns:id>
               <ns:rqXML>
                  <DescriptiveInfoRQ xmlns:xsi = "http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd = "http://www.w3.org/2001/XMLSchema">
                     <timeoutMilliseconds>19700</timeoutMilliseconds>
                     <source>
                        <languageCode>en</languageCode>
                     </source>
                     <filterAuditData>
                        <registerTransactions>true</registerTransactions>
                     </filterAuditData>
                     <Configuration>
                        <User>user</User>
                        <Password>password</Password>
                        <UrlAvail>www.supplier.com/avail</UrlAvail>
                        <UrlReservation>www.supplier.com/reservation</UrlReservation>
                        <UrlValuation>www.supplier.com/valuation</UrlValuation>
                        <UrlGeneric>www.supplier.com/generic</UrlGeneric>
                        <Parameters>
                           <Parameter key = "UrlListHotels" value = "http://www.supplier.com/ListHotels"></Parameter>
                           <Parameter key = "Access" value = "22334"></Parameter>
                        </Parameters>
                     </Configuration>
                     <Hotel>
                        <Code>1234AC</Code>
                     </Hotel>
                  </DescriptiveInfoRQ>
               </ns:rqXML>
            </ns:providerRQ>
         </ns:descriptiveInfoRQ>
      </ns:DescriptiveInfo>
   </soapenv:Body>
</soapenv:Envelope>

Request Data Breakdown​

info

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

ElementRelTypeDescription
RuntimeConfigurationRQ/Hotel1
Hotel/Code1StringHotel code requested.

DescriptiveInfo Response​

After each request, the Seller will have to process the data and provide a response. Upon receiving a DescriptiveInfo request, the Seller will send you a corresponding DescriptiveInfo response. There are two response options, success or error.

Success​

<DescriptiveInfoRS>
   <UpgradeUTCDate>2016-10-18T13:18:03+02:00</UpgradeUTCDate>
   <Hotel>
      <Code>70</Code>
      <Name>Nice Stay</Name>
      <PropertyCategory>
         <Code>1</Code>
         <Name>Hotel</Name>
      </PropertyCategory>
      <Address>Avenue Doctor Brown S/N</Address>
      <Airports>
         <Airport>
            <IATACode>LON</IATACode>
         </Airport>
      </Airports>
      <Town>London</Town>
      <ZipCode>21449</ZipCode>
      <CountryISOCode>UK</CountryISOCode>
      <AvailDestination code = "2" name = "London"/>
      <GeographicDestination code = "2" name = "London" avail = "true"/>
      <LocationType>City</LocationType>
      <Contact>
         <Email>emailhotel@xxx.com</Email>
         <Telephone>91547892</Telephone>
         <Fax></Fax>
      </Contact>
      <BookingContact>
         <Email>bookinghotel@xxx.com</Email>
         <Telephone>91547880</Telephone>
         <Fax>910200200</Fax>
      </BookingContact>
      <CategoryCode>4 Stars</CategoryCode>    
      <ShortDescription>the hotel.....</ShortDescription>
      <LongDescription>the hotel....</LongDescription>
      <SituationDescription>....</SituationDescription>
      <HowToGet></HowToGet>
      <Attributes>
         <Attribute>
            <Code>90</Code>
            <Value>RES</Value>
            <Classification>GRAL</Classification>
            <Description>Restaurant</Description>
         </Attribute>
         <Attribute>
            <Code>31</Code>
            <Value>RES</Value>
            <Classification>HOT</Classification>
            <Description>Pool</Description>
         </Attribute>
      </Attributes>
      <Images>
         <Picture>
            <URL>http://www.images.net/infor/work/imagen/hotel_07/mapa.jpg</URL>
            <Classification>GRAL</Classification>
            <Description>Map view</Description>
            <Ordered>1</Ordered>
            <Code>50</Code>
            <UpgradeUTCDate>2016-10-18T13:18:03+02:00</UpgradeUTCDate>
         </Picture>
         <Picture>
            <URL>http://www.images.net/infor/work/imagen/hotel_02/M.jpg</URL>
            <Classification>GRAL</Classification>
            <Description>External view</Description>
            <Ordered>2</Ordered>
            <Code>100</Code>
            <UpgradeUTCDate>2016-10-18T13:18:03+02:00</UpgradeUTCDate>
         </Picture>
      </Images>
      <PaymentOptions cash="false" bankAcct="false">
         <Cards>
            <Card code="VI"/>
            <Card code="AX"/>
            <Card code="CA"/>
         </Cards>
      </PaymentOptions>
      <ExclusiveDeal>true</ExclusiveDeal>
      <Rooms>
         <Room code = "201232338" size = "0" viewCode = "Others" classificationCode = "Others" occupancy = "0">
            <Beds>
               <Bed numberOfBeds = "1" type = "SINGLE"/>
            </Beds>
            <RoomOccupancy>
               <Adults>
                  <Min>1</Min>
                  <Max>1</Max>
                </Adults>
             <Children>
               <Min>0</Min>
               <Max>0</Max>
             </Children>
             <Infants>
               <Min>0</Min>
               <Max>0</Max>
             </Infants>
             <Total>
               <Min>1</Min>
               <Max>1</Max>
             </Total>
           </RoomOccupancy>
           <Attributes>                      
              <Attribute>
                 <Code>2403</Code>
                 <Value>RES</Value>
                 <Classification>HAB</Classification>
                 <Description>Free WiFi</Description>
              </Attribute>
              <Attribute>
                 <Code>318</Code>
                 <Value>RES</Value>
                 <Classification>HAB</Classification>
                 <Description>Balcony</Description>
              </Attribute>
           </Attributes>
           <Images>
              <Picture>
                 <Code>01</Code>
                 <URL>http://www.images.net/infor/work/imagen/hotel_room_02/M.jpg</URL>
                 <Classification>HAB</Classification>
                 <Ordered>1</Ordered>
                 <Description>Room</Description>
                 <UpgradeUTCDate>0001-01-01T00:00:00</UpgradeUTCDate>
              </Picture>
           </Images>
           <Description>Standard Single room</Description>
           <Views>
              <View>
                 <Code>01</Code>
                 <Name>Sea view</Name>
              </View>
            </Views>
            <Area>25</Area>
         </Room>
      </Rooms>
   </Hotel>
</DescriptiveInfoRS>

Success Response Data Breakdown​

ElementRelTypeDescription
DescriptiveInfoRS/UpgradeUTCDate1DateTimeIndicates the update date of the information in UTC format.
DescriptiveInfoRS/Hotel0..n
Hotel/Code1StringHotel Code
Hotel/Name1StringHote Name
Hotel/PropertyCategory0..1
PropertyCategory/Code1StringSupplier property code.
PropertyCategory/Name1StringSupplier property name.
Hotel/Address1StringHotel Adress
Hotel/Airports0..1
Airports/Airport1..n
Airport/IATACode1StringIATA airport Code (airport near the hotel).
Hotel/Town1StringTown
Hotel/ZipCode1StringZipCode
Hotel/CountryISOCode1StringCountry ISOCode
Hotel/AvailDestination0..1
@code1StringAvail destination code (lowest destination level).
@name1StringAvail destination name (lowest destination level).
Hotel/GeographicDestination1
@code1StringGeographic Destination code (lowest destination level).
@name1StringGeographic Destination name (lowest destination level).
@avail1BooleanIndicates if it is allowed in availability.
Hotel/Latitude0..1StringLatitude. Format is Decimal Degrees (e.g. 37.207295).
Hotel/Longitude0..1StringLongitude. Format is Decimal Degrees (e.g. -7.23768).
Hotel/LocationType0..1StringLocation type
Hotel/Contact0..1
Contact/Email1StringHotel contact email.
Contact/Telephone1StringHotel contact telephone.
Contact/Fax1StringHotel contact fax.
Hotel/BookingContact0..1
BookingContact/Email1StringBooking dept email.
BookingContact/Telephone1StringBooking dept telephone.
BookingContact/Fax1StringBooking dept fax.
Hotel/CategoryCode1StringHotel category code.
Hotel/Chaincode0..1StringHotel chain code.
Hotel/ShortDescription0..1StringHotel short description.
Hotel/LongDescription0..1StringHotel long description.
Hotel/SituationDescription0..1StringHotel area description.
Hotel/RestaurantsDescription0..1StringRestaurants description
Hotel/PoolsDescription0..1StringPools description
Hotel/ActivitiesDescription0..1StringActivities description
Hotel/ServicesDescription0..1StringServices description
Hotel/AdditionalDetails0..1StringAdditional details
Hotel/HowToGet0..1StringDirections to the hotel.
Hotel/Attributes1..n
Attributes/Attribute1..nSpecific attributes of the hotel.
Attribute/Code1StringAttribute code
Attribute/Value1StringAttribute value
Attribute/Classification1String
Classification codes
Code Name
HOT Hotel
HAB Room
SER Service
GRAL Generic
Attribute/Description0..1StringAttribute description
Hotel/Images0..1
Images/Picture1..nSpecific pictures of the hotel.
Picture/Url1StringPicture url
Picture/Classification1String
Classification codes
Code Name
HOT Hotel
HAB Room
SER Service
GRAL Generic
Picture/Description0..1StringPicture description
Picture/Ordered0..1StringImages should be ordered from 1 onward. 1 is top.
Picture/Code0..1StringPicture code
Picture/UpgradeUTCDate0..1DateTimeIndicates the upgrade date of the picture in UTC format.
Hotel/PaymentOptions0..1StringType of cards allowed by the supplier. This tag is only mandatory if payment type is different than MerchantPay.
PaymentOptions/Cards1
@cash1BooleanCash indicates whether payment will be made in cash (true) or by card (false).
@bankAcct1BooleanBankAcct specifies whether payment will be made via bank transfer (true) or not (false).
Cards/Card1..n
@code1String
Credit Card codes
Code Name
VI Visa
AX American Express
BC BC Card
CA MasterCard
CB Carte Blanche
CU China Union Pay
DS Discover
DC Diners Club
T Carta Si
R Carte Bleue
N Dankort
L Delta
E Electron
JC Japan Credit Bureau
TO Maestro
S Switch
EC Electronic Cash
EU EuroCard
TP Universal air travel card
OP optima
ER Air Canada/RnRoute
XS access
O others
Hotel/ExclusiveDeal0..1BooleanIndicates that a Hotel is an Exlusive Deal.
Hotel/Rooms0..1
Rooms/Room1..n
@code1StringRoom Code
@size1IntegerSize of the room.
@viewCode1StringMain view of the room.
@classificationCode1StringRoom classification code.
@occupancy1IntegerNumber of rooms availables at the hotel.
Room/Beds0..1
@sharedBed1BooleanIndicates if it’s a shared bed.
Beds/Bed1..n
@numberOfBeds1StringNumber of beds allocated in the room.
@type1StringType of bed (Queen Bed, Single…).
Room/RoomOccupancy0..1Indicates the amount of each occupant type staying in the room.
RoomOccupancy/Adults1
Adults/Min1IntegerIndicates the minimum amount of adults staying in the room.
Adults/Max1IntegerIndicates the maximum amount of adults staying in the room.
RoomOccupancy/Children1
Children/Min1IntegerIndicates the minimum amount of children staying in the room.
Children/Max1IntegerIndicates the maximum amount of children staying in the room.
RoomOccupancy/Infants1
Infants/Min1IntegerIndicates the minimum amount of infants staying in the room.
Infants/Max1IntegerIndicates the maximum amount of infants staying in the room.
RoomOccupancy/Total1
Total/Min1IntegerIndicates the minimum total amount of occupants staying in the room.
Total/Max1IntegerIndicates the maximum total amount of occupants staying in the room.
Room/Attributes1
Attributes/Attribute1..nSpecific attributes of the room.
Attribute/Code1StringAttribute code
Attribute/Value1StringAttribute value
Attribute/Classification1String
Classification codes
Code Name
HOT Hotel
HAB Room
SER Service
GRAL Generic
Attribute/Description0..1StringAttribute description
Room/Images1
Images/PictureSpecific pictures of the room.
Picture/Code0..1StringPicture code
Picture/Url1StringPicture url
Picture/Classification1String
Classification codes
Code Name
HOT Hotel
HAB Room
SER Service
GRAL Generic
Picture/Ordered0..1StringImages should be ordered from 1 onward. 1 is top.
Picture/Description0..1StringPicture description
Picture/UpgradeUTCDate0..1DateTimeIndicates the upgrade date of the picture in UTC format.
Room/Description1StringRoom Description
Room/Views0..1Views of the room.
Views/View1..n
View/Code1..nStringView code
View/Name1..nStringName of the view.
Room/Area0..1StringRoom area.

Error​

<DescriptiveInfoRS>
   <operationImplemented>true</operationImplemented>
   <applicationError>
      <code/>
      <type>302</type>
      <description>Hotel Not Found in DescriptiveInfo.</description>
      <httpStatusCode>0</httpStatusCode>
   </applicationError>
</DescriptiveInfoRS>