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.

Market List

The Market List method returns a comprehensive market list from a supplier's access that may include translations to other languages, granting you access to all the categories configured by the Seller for a given set of credentials. The returned fields include: Market code, Market name, GroupCode etc.

caution

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

MarketList 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:MarketList>
         <ns:marketListRQ>
            <ns:timeoutMilliseconds>20000</ns:timeoutMilliseconds>
            <ns:version>1</ns:version>
            <ns:providerRQ>
               <ns:code>suppliercode</ns:code>
               <ns:id>1</ns:id>
               <ns:rqXML>
                  <MarketListRQ 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>
                  </MarketListRQ>
               </ns:rqXML>
            </ns:providerRQ>
         </ns:marketListRQ>
      </ns:MarketList>
   </soapenv:Body>
</soapenv:Envelope>

Request Data Breakdown

info

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

MarketList request does not require any elements.

MarketList Response

After each request, the Seller will have to process the data and provide a response. Upon receiving a MarketList request, the Seller will send you a corresponding MarketList response.

<MarketListRS>
   <UpgradeUTCDate>2016-10-18T13:18:03+02:00</UpgradeUTCDate>
   <Markets>
      <Market>
         <Code>ES</Code>
         <Name>Spain</Name>
         <GroupCode>Europe</GroupCode>
      </Market>
      <Market>
         <Code>PT</Code>
         <Name>Portugal</Name>
         <GroupCode>Europe</GroupCode>
      </Market>
   </Markets>
</MarketListRS>

Response Data Breakdown

Element	Rel	Type	Description
MarketListRS/UpgradeUTCDate	1	DateTime	Indicates the update date of the information in UTC format.
MarketListRS/Markets	1		Root node, list of markets.
Markets/Market	1..n		Most suppliers use a standard ISO-3166_1_alfa_2, but it depends on each individual supplier.
Market/Code	1	String	Market code
Market/Name	1	String	Market name
Market/GroupCode	0..1	String	Indicates if the supplier groups different markets together and what the group is called, so you can get the same prices/options if two markets belong to the same group.