Last updated

Properties objects

The Booking.com Connectivity APIs store information about the rooms and services in a property inside a HotelInfo element. This page describes the elements and attributes in the HotelInfo descendants tree.

Sample XML

The sample below is an excerpt and not a valid XML document.

<HotelInfo>
   <CategoryCodes>
     <GuestRoomInfo Quantity="100" />
     <HotelCategory ExistsCode="1" Code="20" />
   </CategoryCodes>
   <Languages>
     <Language LanguageCode="fr" />
     <Language LanguageCode="en" />
   </Languages>
   <Position Latitude="49.4092" Longitude="1.0900" />
   <Services>
     <Service Code="5" Included="false" />
     <Service Code="173" Price="14">
      <Types>
        <Type Code="5001" />
        <Type Code="5004" />
        <Type Code="5009" />
      </Types>
      <Items>
        <Item Code="5005"/>
        <Item Code="5006"/>
        <Item Code="5007"/>
        <Item Code="5009"/>
        <Item Code="5011"/>
      </Items>
      <OperationTimes>
        <OperationTime Mon='1' Tue='1' Weds='1' Thur='1' Fri='1' Sat='1' Sun='1' Start="08:00" End="10:00"/>
      </OperationTimes>
     </Service>     
   </Services>
   <OwnershipManagementInfos>
     <OwnershipManagementInfo>
       <CompanyName Code="1234" />
     </OwnershipManagementInfo>
   </OwnershipManagementInfos>
   <RelativePositions>
     <RelativePosition>
       <Transportations>
         <Transportation>
           <TPA_Extensions>
             <Route>
               <Leg>
                 <Start Type='airport' Code='AMS' />
                 <TransportType Code='5000' />
                 <Departure UponArrangement='1' />
               </Leg>
               <JourneyTime Minutes='20' />
               <Price Amount='10' CurrencyCode='EUR' />
             </Route>
           </TPA_Extensions>
         </Transportation>
         <Transportation>
           <TPA_Extensions>
             <Route>
               <Leg>
                 <Start Type='airport' Code='AMS' />
                 <TransportType Code='3' />
                 <Line Name='10'/>
                 <Departure Interval='20' />
               </Leg>
               <JourneyTime Minutes='20' />
               <Price Amount='5.5' CurrencyCode='EUR' />
             </Route>
           </TPA_Extensions>
         </Transportation>
         <Transportation>
           <TPA_Extensions>
             <Route>
               <Leg>
                 <Start Type='airport' Code='AMS' />
                 <TransportType Code='5' />
                 <Motorway Name='A2'/>
                 <Junction Name='Amsterdam Zuid' />
               </Leg>
               <JourneyTime Minutes='30' />
             </Route>
           </TPA_Extensions>
         </Transportation>
       </Transportations>
     </RelativePosition>
   </RelativePositions>
   <TPA_Extensions>
     <AcceptedPayments>
       <AcceptedPayment PaymentTypeCode="1" />
       <AcceptedPayment PaymentTypeCode="2" />
       <AcceptedPayment PaymentTypeCode="3" />
     </AcceptedPayments>
     <InvoiceDetails>
       <InvoiceTaxType Type="CPF"/>
       <InvoiceTaxNumber Code="01234567894123" />
       <InvoiceAddress Email="noreply@booking.com" />
       <CityHallInfo Id="12345678" />
       <BirthDate Date="1980-01-30" />
     </InvoiceDetails>
   </TPA_Extensions>
</HotelInfo>

HotelInfo

Contains information about the types of rooms and services available in a property.

FieldDescriptionTypeRequiredNotes
CategoryCodesSee CategoryCodes.objectOptional-
Languages-array of LanguageOptional-
PositionContainer for child attributes.objectOptional-
Position[@Latitude]Latitude of the property's location.latitudeOptional-
Position[@Longitude]Longitude of the property's location.longitudeOptional-
Services-array of ServiceOptional-
OwnershipManagementInfos-array of OwnershipManagementInfoOptional-
RelativePositions-array of RelativePositionOptional-
TPA_Extensions-objectOptional-

CategoryCodes

Contains general property details, such as the number of rooms and the type of property. Child of HotelInfo.

FieldDescriptionTypeRequiredNotes
GuestRoomInfo-objectRequired-
GuestRoomInfo[@Quantity]The total number of sellable units at the property.integerRequiredA "sellable unit" is the smallest possible space that a guest can book at the property. In a hotel with 200 rooms, each room is a sellable unit, and the value of GuestRoomInfo[@Quantity] would be 200. In a holiday home, guests must typically book the home in its entirety, making the value 1.
HotelCategory-objectRequired-
HotelCategory[@Code]The PCT code representing the type of property.enumRequiredAccepts the values listed under PCT.
HotelCategory[@ExistsCode]Indicates whether the property currently exists.integerOptionalAccepts these values: 1 (true), 0 (false). Default: 1

Language

Contains details of languages spoken by the property's staff. Child of Languages (see HotelInfo).

FieldDescriptionTypeRequiredNotes
Language[@LanguageCode]The two-letter BCL code for the language.enumRequiredAccepts the values listed under BCL.

Service

Contains the details of a service the property offers. Child of Services (see HotelInfo).

FieldDescriptionTypeRequiredNotes
Service[@Code]The Hotel Amenity Code for the service.enumOptionalAccepts the values listed under HAC.
Service[@Included]Indicates whether the service is included in the room price (true), the service comes with an extra charge (false), or there is no information available to specify either way (unknown).enumOptionalAccepts: true, false, unknown. Default: unknown
Service[@Price]The price for the service, in the property's default currency.priceOptionalRequired if Service[@Code="173"] (breakfast service).
Types-array of TypeOptional-
Type-objectOptionalCurrently used only for breakfast services.
Type[@Code]The Booking.com Breakfast Type Code.integerOptionalAccepts the values listed under BCBT.
Features-array of FeatureOptional-

OwnershipManagementInfo

Contains optional details about the property's relationship to Booking.com. Child of OwnershipManagementInfos (see HotelInfo).

FieldDescriptionTypeRequiredNotes
OwnerShipManagementInfo
[@RelationshipTypeCode]
The relationship type, if applicable.integerOptionalOnly allowed for new properties. Default: empty
CompanyName-objectOptional
CompanyName[@Code]The ID of the legal entity to which the property belongs.integerOptionalOnly allowed for new properties.

RelativePosition

Container element for transportation objects.

FieldDescriptionTypeRequiredNotes
Transportations-array of TransportationOptional-

TPA_Extensions

Our extensions to the OTA standard. Child of HotelInfo.

FieldDescriptionTypeRequiredNotes
AcceptedPayments-array of AcceptedPaymentOptional-
InvoiceDetailsSee InvoiceDetails.objectOptionalRequired for Brazilian properties.

AcceptedPayment

Details of payment methods the property accepts. Child of AcceptedPayments (see TPA_Extensions).

FieldDescriptionTypeRequiredNotes
AcceptedPayment[@PaymentTypeCode]The Booking.com Payment Type Code.enumRequiredAccepts the values listed under BCPT.

InvoiceDetails

Special identifying information for Brazilian properties, issued by the Brazilian tax authority. Used for invoicing. Child of TPA_Extensions.

Note

These details are required for Brazilian properties.

FieldDescriptionTypeRequiredNotes
InvoiceTaxType[@Type]Specifies whether the identifying number belongs to a company or a private individual.enumRequiredAccepts: CNPJ (company), CPF (private individual).
InvoiceTaxNumber[@Code]The identifying number.integerRequiredLength depends on value of InvoiceTaxType[@Type]. CNPJ = 14 digits. CPF = 11 digits.
InvoiceAddress[@Email]Email address of invoice recipient.stringRequired-
CityHallInfo[@Id]The 8-digit ID for the city hall which issued the CNPJ or CPF number.integerRequired-
BirthDate[@Date]Date of birth of the individual providing the CPF number.dateOptionalFormat: YYYY-MM-DD. Required if InvoiceTaxType[@Type="CPF"].