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.

Metadata

The MetaData method returns a clear and summarized view of the Seller's main characteristics, as well as the methods implemented through their integration and the limitations and restrictions associated with their connection. The returned fields include:MaxNumberHotels, AllowsCurrency, MinimumStay, PaymentTypes, InformFees, TimeZone, AllowsDeltaPrice, AllowsProvideLocator etc.

caution

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

MetaData 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:MetaData>
         <ns:metaDataRQ>
            <ns:timeoutMilliseconds>20000</ns:timeoutMilliseconds>
            <ns:version>1</ns:version>
            <ns:providerRQ>
               <ns:code>suppliercode</ns:code>
               <ns:id>1</ns:id>
               <ns:rqXML>
                  <MetaDataRQ 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>
                  </MetaDataRQ>
               </ns:rqXML>
            </ns:providerRQ>
         </ns:metaDataRQ>
      </ns:MetaData>
   </soapenv:Body>
</soapenv:Envelope>

Request Data Breakdown

info

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

MetaData request does not require any elements.

MetaData Response

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

caution

Values can be -1, this means the supplier has no restriction. For example, if MaxNumberHotels returns -1 means there is no maximum number of hotels to be set in a request.

<MetaDataRS>
   <operationImplemented>true</operationImplemented>
   <Avail>
      <Destinations>
         <MaxNumberHotels reviewDate = "20/06/2022">0</MaxNumberHotels>
         <MaxNumberHotelsRecommended reviewDate = "20/06/2022">0</MaxNumberHotelsRecommended>
         <MaxNumberCities reviewDate = "20/06/2022">0</MaxNumberCities>
         <MaxNumberCitiesRecommended reviewDate = "20/06/2022">0</MaxNumberCitiesRecommended>
         <MaxNumberZones reviewDate = "20/06/2022">0</MaxNumberZones>
         <MaxNumberZonesRecommended reviewDate = "20/06/2022">0</MaxNumberZonesRecommended>
         <MaxNumberGeoCodes reviewDate = "20/06/2022">0</MaxNumberGeoCodes>
         <MaxNumberGeoCodesRecommended reviewDate = "20/06/2022">0</MaxNumberGeoCodesRecommended>
         <HotelSameDestinationRestriction reviewDate = "20/06/2022">false</HotelSameDestinationRestriction>
         <DestinationSameCountryRestriction reviewDate = "20/06/2022">false</DestinationSameCountryRestriction>
      </Destinations>
      <AllowsCurrency reviewDate = "20/06/2022">false</AllowsCurrency>
      <AllowsBusinessRules reviewDate = "20/06/2022">false</AllowsBusinessRules>
      <NumMarketsAllowed reviewDate = "20/06/2022">0</NumMarketsAllowed>
      <Release reviewDate = "20/06/2022">0</Release>
      <MinimumStay reviewDate = "20/06/2022">0</MinimumStay>
      <MaxStay reviewDate = "20/06/2022">0</MaxStay>
      <RoomCandidates>
         <MaxNumberRoomCandidates reviewDate = "20/06/2022">0</MaxNumberRoomCandidates>
         <PaxTypeRangeInRoomCandidates reviewDate = "20/06/2022">
            <Candidate max = "3" min = "1" type = "Adult"/>
            <Candidate max = "2" min = "0" type = "Child"/>
            <Candidate max = "0" min = "0" type = "Infant"/>
         </PaxTypeRangeInRoomCandidates>
         <MaxPaxInRoomCandidates reviewDate = "20/06/2022">0</MaxPaxInRoomCandidates>
         <MaxPaxInAllRooms reviewDate = "20/06/2022">0</MaxPaxInAllRooms>
         <RequiredRoomWithSamePaxConfiguration>
            <SamePaxNumber reviewDate = "20/06/2022">false</SamePaxNumber>
            <SamePaxAge reviewDate = "20/06/2022">false</SamePaxAge>
         </RequiredRoomWithSamePaxConfiguration>
         <AgeRange reviewDate = "11/11/2016">
            <Age max = "5" min = "2" type = "Child"/>
         </AgeRange>
         <RateRules>
            <RateRule reviewDate = "20/06/2022">NonRefundable</RateRule>
            <RateRule reviewDate = "20/06/2022">largeFamily</RateRule>
         </RateRules>
         <Beds>
            <InformNumberOfUnits reviewDate = "20/06/2022">false</InformNumberOfUnits>
            <InformSharedBed reviewDate = "20/06/2022">false</InformSharedBed>
            <InformBedType reviewDate = "20/06/2022">false</InformBedType>
            <InformNumberOfBeds reviewDate = "20/06/2022">false</InformNumberOfBeds>
         </Beds>
      </RoomCandidates>
      <InformBindingPrice reviewDate = "20/06/2022">false</InformBindingPrice>
      <InformCancelPolicies reviewDate = "20/06/2022">false</InformCancelPolicies>
      <InformRoomCancelPolicies reviewDate = "20/06/2022">false</InformRoomCancelPolicies>
      <ImplementsCombination reviewDate = "20/06/2022">false</ImplementsCombination>
      <InformRoomFees reviewDate = "20/06/2022">false</InformRoomFees>
      <InformRemarks reviewDate = "20/06/2022">false</InformRemarks>
      <PaymentTypes>
         <PaymentType reviewDate = "20/06/2022">MerchantPay</PaymentType>
         <PaymentType reviewDate = "20/06/2022">LaterPay</PaymentType>
      </PaymentTypes>
      <OptionTypes>
         <OptionType reviewDate = "20/06/2022">Hotel</OptionType>
      </OptionTypes>
      <Languages>
         <Language reviewDate = "20/06/2022">en</Language>
         <Language reviewDate = "20/06/2022">es</Language>
      </Languages>
      <InformDailyPrice reviewDate = "20/06/2022">false</InformDailyPrice>
      <InformDailyRatePlan reviewDate = "20/06/2022">false</InformDailyRatePlan>
      <InformOffers reviewDate = "20/06/2022">false</InformOffers>
      <InformNRFRateByRoom reviewDate = "20/06/2022">false</InformNRFRateByRoom>
      <InformFees reviewDate = "20/06/2022">false</InformFees>
   </Avail>
   <Valuation>
      <AllowsBlockOption reviewDate = "20/06/2022">false</AllowsBlockOption>
      <InformBindingPrice reviewDate = "20/06/2022">false</InformBindingPrice>
      <InformNRFRate reviewDate = "20/06/2022">false</InformNRFRate>
      <InformRemarks reviewDate = "20/06/2022">false</InformRemarks>
      <InformCancelPolicies reviewDate = "20/06/2022">false</InformCancelPolicies>
      <InformCancelPoliciesDescription reviewDate = "20/06/2022">false</InformCancelPoliciesDescription>
      <InformFees reviewDate = "20/06/2022">false</InformFees>
      <TimeZone reviewDate = "04/01/2022">[eUtc.Utc_Unknown|eUtc.HotelLocalTime|eUtc.Utc_-14|...|eUtc.Utc_0|...|eUtc.Utc_14]</TimeZone>
   </Valuation>
   <Reservation>
      <AllowsDeltaPrice reviewDate = "20/06/2022">false</AllowsDeltaPrice>
      <InformPropertyReservationNumber reviewDate = "20/06/2022">false</InformPropertyReservationNumber>
      <RequiredAllPassengers reviewDate = "20/06/2022">false</RequiredAllPassengers>
      <AllowsRemarks reviewDate = "20/06/2022">false</AllowsRemarks>
      <AllowsUrlCard reviewDate = "20/06/2022">false</AllowsUrlCard>
      <InformBillingSupplier reviewDate = "20/06/2022">false</InformBillingSupplier>
      <InformPrice reviewDate = "20/06/2022">false</InformPrice>
      <AllowsPreferences>
         <Preference hotel = "true" room = "false">
            <PreferenceType>LateArrival</PreferenceType>
            <Value mandatory = "true" type = "numeric"/>
         </Preference>
      </AllowsPreferences>
   </Reservation>
   <ReservationRead>
      <Implements reviewDate = "20/06/2022">false</Implements>
      <InformPropertyReservationNumber reviewDate = "20/06/2022">false</InformPropertyReservationNumber>
      <AllowsProvideLocator reviewDate = "20/06/2022">false</AllowsProvideLocator>
      <AllowsClientLocator reviewDate = "20/06/2022">false</AllowsClientLocator>
      <InformCancelPolicies reviewDate = "20/06/2022">false</InformCancelPolicies>
      <InformPriceCancel reviewDate = "20/06/2022">false</InformPriceCancel>
      <RequiredCheckInDate reviewDate = "18/10/2021">false</RequiredCheckInDate>
      <RequiredCheckOutDate reviewDate = "18/10/2021">false</RequiredCheckOutDate>
      <RequiredReservationDate reviewDate = "18/10/2021">false</RequiredReservationDate>
   </ReservationRead>
   <ReservationList>
      <Implements reviewDate = "20/06/2022">false</Implements>
      <InformPropertyReservationNumber reviewDate = "20/06/2022">false</InformPropertyReservationNumber>
      <AllowsCreationDate reviewDate = "20/06/2022">false</AllowsCreationDate>
      <AllowsCheckDate reviewDate = "20/06/2022">false</AllowsCheckDate>
      <InformCancelPolicies reviewDate = "20/06/2022">false</InformCancelPolicies>
      <InformPriceCancel reviewDate = "20/06/2022">false</InformPriceCancel>
   </ReservationList>
   <Cancel>
      <Implements reviewDate = "20/06/2022">false</Implements>
      <AllowsProvideLocator reviewDate = "20/06/2022">false</AllowsProvideLocator>
      <AllowsClientLocator reviewDate = "20/06/2022">false</AllowsClientLocator>
      <InformPriceCancel reviewDate = "20/06/2022">false</InformPriceCancel>
   </Cancel>
   <Batch>
      <InformExclusiveDeal reviewDate = "20/06/2022">false</InformExclusiveDeal>
      <HotelList>
         <StaticType reviewDate = "20/06/2022">NotImplemented</StaticType>
         <Languages>
            <Language reviewDate = "20/06/2022">en</Language>
            <Language reviewDate = "20/06/2022">es</Language>
         </Languages>
      </HotelList>
      <DescriptiveInfo>
         <StaticType reviewDate = "20/06/2022">NotImplemented</StaticType>
         <Languages>
            <Language reviewDate = "20/06/2022">en</Language>
            <Language reviewDate = "20/06/2022">es</Language>
         </Languages>
      </DescriptiveInfo>
      <GeographicDestinationTree>
         <StaticType reviewDate = "20/06/2022">NotImplemented</StaticType>
         <Languages>
            <Language reviewDate = "20/06/2022">en</Language>
            <Language reviewDate = "20/06/2022">es</Language>
         </Languages>
      </GeographicDestinationTree>
      <AvailDestinationTree>
         <StaticType reviewDate = "20/06/2022">NotImplemented</StaticType>
         <Languages>
            <Language reviewDate = "20/06/2022">en</Language>
         </Languages>
      </AvailDestinationTree>
      <RoomList>
         <StaticType reviewDate = "20/06/2022">NotImplemented</StaticType>
         <Languages>
            <Language reviewDate = "20/06/2022">en</Language>
            <Language reviewDate = "20/06/2022">es</Language>
         </Languages>
      </RoomList>
      <MealPlanList>
         <StaticType reviewDate = "20/06/2022">NotImplemented</StaticType>
         <Languages>
            <Language reviewDate = "20/06/2022">en</Language>
            <Language reviewDate = "20/06/2022">es</Language>
         </Languages>
      </MealPlanList>
      <CategoryList>
         <StaticType reviewDate = "20/06/2022">NotImplemented</StaticType>
         <Languages>
            <Language reviewDate = "20/06/2022">en</Language>
            <Language reviewDate = "20/06/2022">es</Language>
         </Languages>
      </CategoryList>
      <DescriptiveInfoExtended>
         <StaticType reviewDate = "20/06/2022">NotImplemented</StaticType>
         <Languages>
            <Language reviewDate = "20/06/2022">en</Language>
            <Language reviewDate = "20/06/2022">es</Language>
         </Languages>
      </DescriptiveInfoExtended>
      <MarketList>
         <StaticType reviewDate = "20/06/2022">NotImplemented</StaticType>
         <Languages>
            <Language reviewDate = "20/06/2022">en</Language>
            <Language reviewDate = "20/06/2022">es</Language>
         </Languages>
      </MarketList>
      <CurrencyList>
         <StaticType reviewDate = "20/06/2022">NotImplemented</StaticType>
         <Languages>
            <Language reviewDate = "20/06/2022">en</Language>
            <Language reviewDate = "20/06/2022">es</Language>
         </Languages>
      </CurrencyList>
   </Batch>
   <Generic>
      <RequiredNationality reviewDate = "20/06/2022">false</RequiredNationality>
      <AllowsNationality reviewDate = "20/06/2022">true</AllowsNationality>
      <AllowsOnRequest reviewDate = "20/06/2022">false</AllowsOnRequest>
   </Generic>
</MetaDataRS>

Response Data Breakdown

Element Rel Type Description

MetaDataRS/operationImplemented 1 Boolean Indicates if the Supplier has implemented the metadata method.

MetaDataRS/Avail 1

Avail/Destinations 1 Contains information regarding the destinations for AvailRQ.

Destinations/MaxNumberHotels 1 Integer Maximum number of hotels that can be requested.

@reviewDate 1 String Informs of the date when the field was last reviewed.

Destination/MaxNumberHotelsRecommended 1 Integer Maximum number of hotels recommended by the supplier.

@reviewDate 1 String Informs of the date when the field was last reviewed.

Destinations/MaxNumberCities 1 Integer Maximum number of cities that can be requested.

@reviewDate 1 String Informs of the date when the field was last reviewed.

Destinations/MaxNumberCitiesRecommended 1 Integer Maximum number of cities recommended by the supplier.

@reviewDate 1 String Informs of the date when the field was last reviewed.

Destinations/MaxNumberZones 1 Integer Maximum number of zones that can be requested.

@reviewDate 1 String Informs of the date when the field was last reviewed.

Destinations/MaxNumberZonesRecommended 1 Integer Maximum number of zones recommended by the supplier.

@reviewDate 1 String Informs of the date when the field was last reviewed.

Destinations/MaxNumberGeoCodes 1 Integer Maximum number of GeoCodes that can be requested.

@reviewDate 1 String Informs of the date when the field was last reviewed.

Destinations/MaxNumberGeoCodesRecommended 1 Integer Maximum number of GeoCodes recommended by the supplier.

@reviewDate 1 String Informs of the date when the field was last reviewed.

Destinations/HotelSameDestinationRestriction 1 Boolean If the supplier allows the availability for N hotels, this tag indicates whether those hotels must be within the same destination.

@reviewDate 1 String Informs of the date when the field was last reviewed.

Destinations/DestinationSameCountryRestriction 1 Boolean If the supplier allows the availability for N destinations, this tag indicates whether those destinations must be within the same country.

@reviewDate 1 String Informs of the date when the field was last reviewed.

Avail/AllowsCurrency 1 Boolean If true, it is possible to request the currency.

@reviewDate 1 String Informs of the date when the field was last reviewed.

Avail/AllowsBusinessRules 1 Boolean Specifies if this supplier allows businessrules.

@reviewDate 1 String Informs of the date when the field was last reviewed.

Avail/NumMarketsAllowed 1 Integer Number of markets supported by the supplier in the same request.

@reviewDate 1 String Informs of the date when the field was last reviewed.

Avail/Release 1 Integer Minimum days required in between booking date and checking date ( days in advance ). If the value is zero then there is no limitation.

@reviewDate 1 String Informs of the date when the field was last reviewed.

Avail/MinimumStay 1 Integer Minimum number of days required for booking. If the value is zero then there is no limitation.

@reviewDate 1 String Informs of the date when the field was last reviewed.

Avail/MaxStay 1 Integer Maximum number of days allowed for booking.

@reviewDate 1 String Informs of the date when the field was last reviewed.

Avail/RoomCandidates 1 Contains information about the restrictions of the rooms.

RoomCandidates/MaxNumberRoomCandidates 1 Integer Maximum number of room candidates that can be requested in the same avail request.

@reviewDate 1 String Informs of the date when the field was last reviewed.

RoomCandidates/PaxTypeRangeInRoomCandidates 1 Contains information about the age restrictions of the guests in a room.

@reviewDate 1 String Informs of the date when the field was last reviewed.

PaxTypeRangeInRoomCandidates/Candidate 1 Guest restrictions for each candidate type in a room.

@type 1 Enum Candidate classification type.(Adult, Child, Infant)

@min 1 Integer Minimum required number of guest of this type.

@max 1 Integer Maximum number of guest of this type allowed.

RoomCandidates/MaxPaxInRoomCandidates 1 Integer Maximum number paxs in same room that can be requested in the same avail request.

@reviewDate 1 String Informs of the date when the field was last reviewed.

RoomCandidates/MaxPaxInAllRooms 1 Integer Total amount of paxs that can be requested in the same avail request.

@reviewDate 1 String Informs of the date when the field was last reviewed.

RoomCandidates/RequiredRoomWithSamePaxConfiguration 1 Indicates whether all of the distributions must have the same configuration.

RequiredRoomWithSamePaxConfiguration/SamePaxNumber 1 Boolean Indicates whether it is necessary that the number of guests be the same in all of the configurations.

@reviewDate 1 String Informs of the date when the field was last reviewed.

RequiredRoomWithSamePaxConfiguration/SamePaxAge 1 Boolean Indicates whether all of the guests in a particular distribution must be the same age.

@reviewDate 1 String Informs of the date when the field was last reviewed.

RoomCandidates/AgeRange 1 The age range used by the supplier.

@reviewDate 1 String Informs of the date when the field was last reviewed.

AgeRange/Age 1..n Age range.

@type 1 String Type of classification according to age.(Adult, Child, Infant)

@min 1 String Minimum age in range.

@max 1 String Max age in range.

RoomCandidates/RateRules 1 List of rate rule types.

RateRules/RateRule 1..n Enum Rate rules supported by the supplier (You can check these Rate conditions in our Avail section).

@reviewDate 1 String Informs of the date when the field was last reviewed.

RoomCandidates/Beds 1 Information about beds.

Beds/InformNumberOfUnits 1 Boolean Indicates the number of units available per room.

@reviewDate 1 String Informs of the date when the field was last reviewed.

Beds/InformSharedBed 1 Boolean Informs in availability response if beds in the room are shared.

@reviewDate 1 String Informs of the date when the field was last reviewed.

Beds/InformBedType 1 Boolean Informs if the supplier returns the beds types.

@reviewDate 1 String Informs of the date when the field was last reviewed.

Beds/InformNumberOfBeds 1 Boolean Informs if the supplier returns the number of beds for each room.

@reviewDate 1 String Informs of the date when the field was last reviewed.

Avail/InformBindingPrice 1 Boolean Supplier returns binding PVPs.

@reviewDate 1 String Informs of the date when the field was last reviewed.

Avail/InformCancelPolicies 1 Boolean Returns cancellation policies.

@reviewDate 1 String Informs of the date when the field was last reviewed.

Avail/InformRoomCancelPolicies 1 Boolean Returns cancellation policies at room level.

@reviewDate 1 String Informs of the date when the field was last reviewed.

Avail/InformRoomFees 1 Boolean Returns fees at room level.

@reviewDate 1 String Informs of the date when the field was last reviewed.

Avail/ImplementsCombination 1 Boolean Informs whether the integration allows room combination or not.

@reviewDate 1 String Informs of the date when the field was last reviewed.

Avail/InformRemarks 1 Boolean Space available for any remarks or comments aimed at the client.

@reviewDate 1 String Informs of the date when the field was last reviewed.

Avail/PaymentTypes 1 List of payment types accepted by the supplier.

PaymentTypes/PaymentType

1..n

Payment Type codes

Code	Name
MerchantPay	The payment is managed by the supplier.
LaterPay	The payment is managed by the hotel. The customer will use a credit-card as a guarantee for the hotel and the payment will be completed at check in.
CardBookingPay	The payment is managed by the supplier. The payment is effectuated at the time of booking.
CardCheckInPay	The payment is managed by the supplier. The payment is effectuated at check in in the hotel.

@reviewDate 1 String Informs of the date when the field was last reviewed.

Avail/OptionTypes 1 List of option types accepted by the supplier.

OptionTypes/OptionType 1..n Indicates the types of option.

@reviewDate 1 String Informs of the date when the field was last reviewed.

Avail/Languages 1 List of languages.

Languages/Language

1..n

String

Language codes

Code	Name
en	English
es	Spanish
pt	Portuguese
it	Italian
fr	French
de	German
br	Brazilian

@reviewDate 1 String Informs of the date when the field was last reviewed.

Avail/InformDailyPrice 1 Boolean Informs if the supplier returns the daily price.

@reviewDate 1 String Informs of the date when the field was last reviewed.

Avail/InformDailyRatePlan 1 Boolean Informs if the supplier returns the daily rate.

@reviewDate 1 String Informs of the date when the field was last reviewed.

Avail/InformOffers 1 Boolean If true, the supplier returns the offers applied.

@reviewDate 1 String Informs of the date when the field was last reviewed.

Avail/InformNRFRateByRoom 1 Boolean The supplier can inform in availability if the room is non-refundable.

@reviewDate 1 String Informs of the date when the field was last reviewed.

Avail/InformFees 1 Boolean Informs if the supplier returns fees.

@reviewDate 1 String Informs of the date when the field was last reviewed.

MetaDataRS/Valuation 1

Valuation/AllowsBlockOption 1 Boolean Informs if the supplier can block the option.

@reviewDate 1 String Informs of the date when the field was last reviewed.

Valuation/InformBindingPrice 1 Boolean Informs if the price is binding in valuation response.

@reviewDate 1 String Informs of the date when the field was last reviewed.

Valuation/InformNRFRate 1 Boolean The supplier can inform in valuation if the rate is non-refundable.

@reviewDate 1 String Informs of the date when the field was last reviewed.

Valuation/InformRemarks 1 Boolean Returns remarks.

@reviewDate 1 String Informs of the date when the field was last reviewed.

Valuation/InformCancelPolicies 1 Boolean Informs cancellation policies.

@reviewDate 1 String Informs of the date when the field was last reviewed.

Valuation/InformCancelPoliciesDescription 1 Boolean Specifies if the supplier informs the cancel policies in free text.

@reviewDate 1 String Informs of the date when the field was last reviewed.

Valuation/InformFees 1 Boolean Informs if the supplier returns fees.

@reviewDate 1 String Informs of the date when the field was last reviewed.

Valuation/TimeZone

Enum

Informs in which TimeZone are the hoursBefore of cancelation policies.

TimeZone possible values

Unknown

HotelLocalTime

UTC-12

UTC-11

UTC-10

UTC-9

UTC-8

UTC-7

UTC-6

UTC-5

UTC-4

UTC-3

UTC-2

UTC-1

UTC+0

UTC+1

UTC+2

UTC+3

UTC+4

UTC+5

UTC+6

UTC+7

UTC+8

UTC+9

UTC+10

UTC+11

UTC+12

UTC+13

UTC+14

If Unknown is selected we’ll add an offset of +14 only to the Deadline in case it’s calculated and not returned directly by the supplier on UTC Standard. If HotelLocalTime is selected it means we will get the Timezone from the supplier's response.

@reviewDate 1 String Informs of the date when the field was last reviewed.

MetaDataRS/Reservation 1

Reservation/AllowsDeltaPrice 1 Boolean Allows a margin stipulated by the client for booking with a higher price (delta).

@reviewDate 1 String Informs of the date when the field was last reviewed.

Reservation/InformPropertyReservationNumber 1 Boolean Informs if the supplier returns the property reservation number.

@reviewDate 1 String Informs of the date when the field was last reviewed.

Reservation/RequiredAllPassengers 1 Boolean Required data for all passengers (names and surnames).

@reviewDate 1 String Informs of the date when the field was last reviewed.

Reservation/AllowsRemarks 1 Boolean Informs if the supplier allows send remarks.

@reviewDate 1 String Informs of the date when the field was last reviewed.

Reservation/AllowsUrlCard 1 Boolean Specifies if the supplier allows url card data encode when the paymente type is LaterPay.

@reviewDate 1 String Informs of the date when the field was last reviewed.

Reservation/InformBillingSupplier 1 Boolean Informs data of the external supplier in the booking.

@reviewDate 1 String Informs of the date when the field was last reviewed.

Reservation/InformPrice 1 Boolean The supplier informs the booking price.

@reviewDate 1 String Informs of the date when the field was last reviewed.

Reservation/AllowsPreferences 0..1 Preference filters allowed by the provider.

AllowsPreferences/Preference 1 Each filter of preference and its values.

@hotel 1 Boolean At the option / general level.

@room 1 Boolean At the room level.

Preference/PreferenceType

String

Preference types

Preference Type
Smoker
NonSmoker
ExtraBed
Cradle
DoubleBed
TwinBeds
ContigousRoom
Wedding
LateArrival
LateCheckOut
EarlyCheckIn
GroundFloor
TopFloor
WithoutBoucher

Preference/Value 1 Definition of the type of preference.

@mandatory 1 Boolean If it is necessary to pass a value in the Preference tag in reservation request.

@type 0..1 String Type of the required value. (string, numeric, boolean)

MetaDataRS/ReservationRead 1

ReservationRead/InformPropertyReservationNumber 1 Boolean Informs if the supplier returns the property reservation number.

@reviewDate 1 String Informs of the date when the field was last reviewed.

ReservationRead/Implements 1 Boolean Informs if the supplier implements this method.

@reviewDate 1 String Informs of the date when the field was last reviewed.

ReservationRead/AllowsProvideLocator 1 Boolean The supplier allows provider locator.

@reviewDate 1 String Informs of the date when the field was last reviewed.

ReservationRead/AllowsClientLocator 1 Boolean The supplier allows client locator.

@reviewDate 1 String Informs of the date when the field was last reviewed.

ReservationRead/InformCancelPolicies 1 Boolean Informs cancellation policies. In case the booking status is CN, this field allows us to show the price of the cancellation and not the price of the booking.

@reviewDate 1 String Informs of the date when the field was last reviewed.

ReservationRead/InformPriceCancel 1 Boolean The supplier informs the cancellation price.

@reviewDate 1 String Informs of the date when the field was last reviewed.

ReservationRead/RequiredCheckInDate 1 Boolean The supplier informs if it requires the check-in date to return the reservation.

@reviewDate 1 String Informs of the date when the field was last reviewed.

ReservationRead/RequiredCheckOutDate 1 Boolean The supplier informs if it requires the check-out date to return the reservation.

@reviewDate 1 String Informs of the date when the field was last reviewed.

ReservationRead/RequiredReservationDate 1 Boolean The supplier informs if it requires the booking date to return the reservation.

@reviewDate 1 String Informs of the date when the field was last reviewed.

MetaDataRS/ReservationList 1

ReservationList/Implements 1 Boolean Informs if the supplier implements this method.

@reviewDate 1 String Informs of the date when the field was last reviewed.

ReservationList/InformPropertyReservationNumber 1 Boolean Informs if the supplier returns the property reservation number.

@reviewDate 1 String Informs of the date when the field was last reviewed.

ReservationList/AllowsCreationDate 1 Boolean The supplier allows search by creation date.

@reviewDate 1 String Informs of the date when the field was last reviewed.

ReservationList/AllowsCheckDate 1 Boolean The supplier allows search by check in date.

@reviewDate 1 String Informs of the date when the field was last reviewed.

ReservationList/InformCancelPolicies 1 Boolean Informs cancellation policies. In case the booking status is CN, this field allows us to show the price of the cancellation and not the price of the booking.

@reviewDate 1 String Informs of the date when the field was last reviewed.

ReservationList/InformPriceCancel 1 Boolean The supplier informs the cancellation price.

@reviewDate 1 String Informs of the date when the field was last reviewed.

MetaDataRS/Cancel 1

Cancel/Implements 1 Boolean Informs if the supplier implements this method.

@reviewDate 1 String Informs of the date when the field was last reviewed.

Cancel/AllowsProvideLocator 1 Boolean The supplier allows provider locator.

@reviewDate 1 String Informs of the date when the field was last reviewed.

Cancel/AllowsClientLocator 1 Boolean The supplier allows client locator.

@reviewDate 1 String Informs of the date when the field was last reviewed.

Cancel/InformPriceCancel 1 Boolean The supplier informs the cancellation price.

@reviewDate 1 String Informs of the date when the field was last reviewed.

MetaDataRS/Batch 1

Batch/InformExclusiveDeal 1 Boolean The supplier indicates if a Hotel is an Exclusive Deal in HotelList and/or DescriptiveInfo.

@reviewDate 1 String Informs of the date when the field was last reviewed.

Batch/HotelList 1 Contains information regarding HotelList.

HotelList/StaticType 1 Enum Informs the static type.The possible values are: Offline, OfflineCompleted or NotImplemented.

@reviewDate 1 String Informs of the date when the field was last reviewed.

HotelList/Languages 1 List of languages.

Languages/Language

1..n

String

Language codes

Code	Name
en	English
es	Spanish
pt	Portuguese
it	Italian
fr	French
de	German
br	Brazilian

@reviewDate 1 String Informs of the date when the field was last reviewed.

Batch/DescriptiveInfo 1 Contains information regarding DescriptiveInfo.

DescriptiveInfo/StaticType 1 Enum Informs the static type.The possible values are: Offline, OfflineCompleted or NotImplemented.

@reviewDate 1 String Informs of the date when the field was last reviewed.

DescriptiveInfo/Languages 1 List of languages.

Languages/Language

1..n

String

Language codes

Code	Name
en	English
es	Spanish
pt	Portuguese
it	Italian
fr	French
de	German
br	Brazilian

@reviewDate 1 String Informs of the date when the field was last reviewed.

Batch/GeographicDestinationTree 1 Contains information regarding GeographicDestinationTree.

GeographicDestinationTree/StaticType 1 Enum Informs the static type.The possible values are: Offline, OfflineCompleted or NotImplemented.

@reviewDate 1 String Informs of the date when the field was last reviewed.

GeographicDestinationTree/Languages 1 List of languages.

Languages/Language

1..n

String

Language codes

Code	Name
en	English
es	Spanish
pt	Portuguese
it	Italian
fr	French
de	German
br	Brazilian

@reviewDate 1 String Informs of the date when the field was last reviewed.

Batch/AvailDestinationTree 1 Contains information regarding AvailDestinationTree.

AvailDestinationTree/StaticType 1 Enum Informs the static type.The possible values are: Offline, OfflineCompleted or NotImplemented.

@reviewDate 1 String Informs of the date when the field was last reviewed.

AvailDestinationTree/Languages 1 List of languages.

Languages/Language

1..n

String

Language codes

Code	Name
en	English
es	Spanish
pt	Portuguese
it	Italian
fr	French
de	German
br	Brazilian

@reviewDate 1 String Informs of the date when the field was last reviewed.

Batch/RoomList 1 Contains information regarding RoomList.

RoomList/StaticType 1 Enum Informs the static type.The possible values are: Offline, OfflineCompleted or NotImplemented.

@reviewDate 1 String Informs of the date when the field was last reviewed.

RoomList/Languages 1 List of languages.

Languages/Language

1..n

String

Language codes

Code	Name
en	English
es	Spanish
pt	Portuguese
it	Italian
fr	French
de	German
br	Brazilian

@reviewDate 1 String Informs of the date when the field was last reviewed.

Batch/MealPlanList 1 Contains information regarding MealPlanList.

MealPlanList/StaticType 1 Enum Informs the static type.The possible values are: Offline, OfflineCompleted or NotImplemented.

@reviewDate 1 String Informs of the date when the field was last reviewed.

MealPlanList/Languages 1 List of languages.

Languages/Language

1..n

String

Language codes

Code	Name
en	English
es	Spanish
pt	Portuguese
it	Italian
fr	French
de	German
br	Brazilian

@reviewDate 1 String Informs of the date when the field was last reviewed.

Batch/CategoryList 1 Contains information regarding CategoryList.

CategoryList/StaticType 1 Enum Informs the static type.The possible values are: Offline, OfflineCompleted or NotImplemented.

@reviewDate 1 String Informs of the date when the field was last reviewed.

CategoryList/Languages 1 List of languages.

Languages/Language

1..n

String

Language codes

Code	Name
en	English
es	Spanish
pt	Portuguese
it	Italian
fr	French
de	German
br	Brazilian

@reviewDate 1 String Informs of the date when the field was last reviewed.

Batch/DescriptiveInfoExtended 1 Contains information regarding DescriptiveInfoExtended.

DescriptiveInfoExtended/StaticType 1 Enum Informs the static type. The possible values are: Offline, OfflineCompleted or NotImplemented.

@reviewDate 1 String Informs of the date when the field was last reviewed.

DescriptiveInfoExtended/Languages 1 List of languages.

Languages/Language

1..n

String

Language codes

Code	Name
en	English
es	Spanish
pt	Portuguese
it	Italian
fr	French
de	German
br	Brazilian

@reviewDate 1 String Informs of the date when the field was last reviewed.

Batch/MarketList 1 Contains information regarding MarketList.

MarketList/StaticType 1 Enum Informs the static type.The possible values are: Offline, OfflineCompleted or NotImplemented.

@reviewDate 1 String Informs of the date when the field was last reviewed.

MarketList/Languages 1 List of languages.

Languages/Language

1..n

String

Language codes

Code	Name
en	English
es	Spanish
pt	Portuguese
it	Italian
fr	French
de	German
br	Brazilian

@reviewDate 1 String Informs of the date when the field was last reviewed.

Batch/CurrencyList 1 Contains information regarding CurrencyList.

CurrencyList/StaticType 1 Enum Informs the static type.The possible values are: Offline, OfflineCompleted or NotImplemented.

@reviewDate 1 String Informs of the date when the field was last reviewed.

CurrencyList/Languages 1 List of languages.

Languages/Language

1..n

String

Language codes

Code	Name
en	English
es	Spanish
pt	Portuguese
it	Italian
fr	French
de	German
br	Brazilian

@reviewDate 1 String Informs of the date when the field was last reviewed.

MetaDataRS/Generic 1

Generic/RequiredNationality 1 Boolean Informs if the supplier requires nationality in Avail, Valuation and Reservation.

@reviewDate 1 String Informs of the date when the field was last reviewed.

Generic/AllowsNationality 1 Boolean Informs if the supplier allows nationality in Avail, Valuation and Reservation.

@reviewDate 1 String Informs of the date when the field was last reviewed.

Generic/AllowsOnRequest 1 Boolean If true, the supplier informs the onrequest status option in Avail, Valuation, and Reservation.

@reviewDate 1 String Informs of the date when the field was last reviewed.

Metadata

MetaData Request​

Request Data Breakdown​

MetaData Response​

Response Data Breakdown​

MetaData Request

Request Data Breakdown

MetaData Response

Response Data Breakdown