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.

Element	Rel	Type	Description
RuntimeConfigurationRQ/Hotel	1
Hotel/Code	1	String	Hotel code requested.

DescriptiveInfo Response

The response to the previous request is a hotel from our database that corresponds to the supplier specified in the request.

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

Element

Rel

Type

Description

DescriptiveInfoRS/UpgradeUTCDate

DateTime

Indicates the update date of the information in UTC format.

DescriptiveInfoRS/Hotel

0..n

Hotel/Code

String

Hotel Code

Hotel/Name

String

Hote Name

Hotel/PropertyCategory

0..1

PropertyCategory/Code

String

Supplier property code.

PropertyCategory/Name

String

Supplier property name.

Hotel/Address

String

Hotel Adress

Hotel/Airports

0..1

Airports/Airport

1..n

Airport/IATACode

String

IATA airport Code (airport near the hotel).

Hotel/Town

String

Town

Hotel/ZipCode

String

ZipCode

Hotel/CountryISOCode

String

Country ISOCode

Hotel/AvailDestination

0..1

@code

String

Avail destination code (lowest destination level).

@name

String

Avail destination name (lowest destination level).

Hotel/GeographicDestination

@code

String

Geographic Destination code (lowest destination level).

@name

String

Geographic Destination name (lowest destination level).

@avail

Boolean

Indicates if it is allowed in availability.

Hotel/Latitude

0..1

String

Latitude. Format is Decimal Degrees (e.g. 37.207295).

Hotel/Longitude

0..1

String

Longitude. Format is Decimal Degrees (e.g. -7.23768).

Hotel/LocationType

0..1

String

Location type

Hotel/Contact

0..1

Contact/Email

String

Hotel contact email.

Contact/Telephone

String

Hotel contact telephone.

Contact/Fax

String

Hotel contact fax.

Hotel/BookingContact

0..1

BookingContact/Email

String

Booking dept email.

BookingContact/Telephone

String

Booking dept telephone.

BookingContact/Fax

String

Booking dept fax.

Hotel/CategoryCode

String

Hotel category code.

Hotel/Chaincode

0..1

String

Hotel chain code.

Hotel/ShortDescription

0..1

String

Hotel short description.

Hotel/LongDescription

0..1

String

Hotel long description.

Hotel/SituationDescription

0..1

String

Hotel area description.

Hotel/RestaurantsDescription

0..1

String

Restaurants description

Hotel/PoolsDescription

0..1

String

Pools description

Hotel/ActivitiesDescription

0..1

String

Activities description

Hotel/ServicesDescription

0..1

String

Services description

Hotel/AdditionalDetails

0..1

String

Additional details

Hotel/HowToGet

0..1

String

Directions to the hotel.

Hotel/Attributes

1..n

Attributes/Attribute

1..n

Specific attributes of the hotel.

Attribute/Code

String

Attribute code

Attribute/Value

String

Attribute value

Attribute/Classification

String

Classification codes

Code	Name
HOT	Hotel
HAB	Room
SER	Service
GRAL	Generic

Attribute/Description

0..1

String

Attribute description

Hotel/Images

0..1

Images/Picture

1..n

Specific pictures of the hotel.

Picture/Url

String

Picture url

Picture/Classification

String

Classification codes

Code	Name
HOT	Hotel
HAB	Room
SER	Service
GRAL	Generic

Picture/Description

0..1

String

Picture description

Picture/Ordered

0..1

String

Images should be ordered from 1 onward. 1 is top.

Picture/Code

0..1

String

Picture code

Picture/UpgradeUTCDate

0..1

DateTime

Indicates the upgrade date of the picture in UTC format.

Hotel/PaymentOptions

0..1

String

Type of cards allowed by the supplier. This tag is only mandatory if payment type is different than MerchantPay.

PaymentOptions/Cards

@cash

Boolean

Cash indicates whether payment will be made in cash (true) or by card (false).

@bankAcct

Boolean

BankAcct specifies whether payment will be made via bank transfer (true) or not (false).

Cards/Card

1..n

@code

String

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/ExclusiveDeal

0..1

Boolean

Indicates that a Hotel is an Exlusive Deal.

Hotel/Rooms

0..1

Rooms/Room

1..n

@code

String

Room Code

@size

Integer

Size of the room.

@viewCode

String

Main view of the room.

@classificationCode

String

Room classification code.

@occupancy

Integer

Number of rooms availables at the hotel.

Room/Beds

0..1

@sharedBed

Boolean

Indicates if it’s a shared bed.

Beds/Bed

1..n

@numberOfBeds

String

Number of beds allocated in the room.

@type

String

Type of bed (Queen Bed, Single…).

Room/RoomOccupancy

0..1

Indicates the amount of each occupant type staying in the room.

RoomOccupancy/Adults

Adults/Min

Integer

Indicates the minimum amount of adults staying in the room.

Adults/Max

Integer

Indicates the maximum amount of adults staying in the room.

RoomOccupancy/Children

Children/Min

Integer

Indicates the minimum amount of children staying in the room.

Children/Max

Integer

Indicates the maximum amount of children staying in the room.

RoomOccupancy/Infants

Infants/Min

Integer

Indicates the minimum amount of infants staying in the room.

Infants/Max

Integer

Indicates the maximum amount of infants staying in the room.

RoomOccupancy/Total

Total/Min

Integer

Indicates the minimum total amount of occupants staying in the room.

Total/Max

Integer

Indicates the maximum total amount of occupants staying in the room.

Room/Attributes

Attributes/Attribute

1..n

Specific attributes of the room.

Attribute/Code

String

Attribute code

Attribute/Value

String

Attribute value

Attribute/Classification

String

Classification codes

Code	Name
HOT	Hotel
HAB	Room
SER	Service
GRAL	Generic

Attribute/Description

0..1

String

Attribute description

Room/Images

Images/Picture

Specific pictures of the room.

Picture/Code

0..1

String

Picture code

Picture/Url

String

Picture url

Picture/Classification

String

Classification codes

Code	Name
HOT	Hotel
HAB	Room
SER	Service
GRAL	Generic

Picture/Ordered

0..1

String

Images should be ordered from 1 onward. 1 is top.

Picture/Description

0..1

String

Picture description

Picture/UpgradeUTCDate

0..1

DateTime

Indicates the upgrade date of the picture in UTC format.

Room/Description

String

Room Description

Room/Views

0..1

Views of the room.

Views/View

1..n

View/Code

1..n

String

View code

View/Name

1..n

String

Name of the view.

Room/Area

0..1

String

Room area.

Error

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

DescriptiveInfo Request​

Request Data Breakdown​

DescriptiveInfo Response​

Success​

Success Response Data Breakdown​

Error​

DescriptiveInfo Request

Request Data Breakdown

DescriptiveInfo Response

Success

Success Response Data Breakdown

Error