Retrieve property details
Use the /ota/OTA_HotelDescriptiveInfo endpoint to retrieve a property's details. You can use this endpoint to also view property details for properties in pending connection status. For more information on how to check the connection status with the property, see Retrieve property attributes.
Before you start
You need to specify at least one property ID.
URL
POST https://supply-xml.booking.com/hotels/ota/OTA_HotelDescriptiveInfo
Request body parameters
The following table describes the elements you can add in the request body:
| Element | Attribute | Description | Type | Required/Optional | Notes |
|---|---|---|---|---|---|
OTA_HotelDescriptiveInfoRQ | Root element. | object | required | - | |
__ >__ HotelDescriptiveInfos | Contains one or multiple HotelDescriptiveInfo element(s). | object | required | - | |
__ >>__ HotelDescriptiveInfo | Contains property IDs. | object | required | - | |
HotelCode | Specifies the Property ID. | string | required | - |
Request body
The following is a request body example:
<OTA_HotelDescriptiveInfoRQ> <HotelDescriptiveInfos> <!-- Replace the {PlaceHolder} in the following line! --> <HotelDescriptiveInfo HotelCode="{PropertyID}"></HotelDescriptiveInfo> </HotelDescriptiveInfos> </OTA_HotelDescriptiveInfoRQ>
Response body parameters
The following table describes the response elements:
| Element | Attribute | Description | Type | Notes |
|---|---|---|---|---|
OTA_HotelDescriptiveInfoRS | Root element | object | ||
> HotelDescriptiveContents | Contains property details. | object | ||
>> HotelDescriptiveContent | ||||
HotelName | Specifies the name of the property on Booking.com. | string | ||
LanguageCode | Specifies the language in which the property wants their Booking.com Extranet content and communication (emails, notifications, etc.) | enumerated string | ||
ID | Specifies a custom property ID generated when the property was first created. | string | ||
Status | Specifies the property status from a list of possible values. | enumerated string | Possible values are: - Test Hotel: The property configurations are in the test mode. The property does not appear in the search results on Booking.com. - Open / bookable: The property appears in the search results on Booking.com and online visitors of Booking.com can book the property. For more information on all supported property statuses, see Property statuses. | |
CurrencyCode | Specifies the currency code. | enumerated string | Booking.com defines the currency for each property. To retrieve a list of all currency codes, use the /xml/currencies endpoint. | |
>>> HotelInfo | Contains information about the types of rooms and services a property offers. | object | - | |
>>>> CategoryCodes | Contains general property details, such as number of rooms and property type. | object | - | |
>>>>> GuestRoomInfo | Contains room details. | object | - | |
Quantity | Specifies the number of sellable units that the property offers. | integer | ||
>>>>> HotelCategory | Contains property type details. | object | - | |
Code | Specifies the property class type code. | enumerated string | For a list of supported property class type codes, see Property Class Type Code. | |
>>>> Languages | Contains languages spoken at the property. | array of Language | ||
>>>>> Language | Contains language spoken at a property. | object | Can contain multiple Language elements. | |
LanguageCode | Specifies the Booking.com Language Code. | enumerated string | For a list of supported language codes, see Booking.com Language Code table. | |
>>>> Descriptions | object | |||
>>>>> MultimediaDescriptions | Container to hold multimedia information. | object | ||
>>>>>> MultimediaDescription | Container to hold multimedia information. | object | ||
>>>>>>> TextItems | object | |||
>>>>>>>> TextItem | object | |||
>>>>>>>>> Description | Specifies the description of the multimedia object. | object | ||
>>>>>>>>>> URL | Specifies the URL of the multimedia object. | object | ||
>>>> Position | Contains the geographical coordinates of property. | object | - | |
Longitude | Specifies the longitude coordinates. | longitude | - | |
Latitude | Specifies the latitude coordinates. | latitude | - | |
>>>> Services | Contains the services offered at the property. | array of Service | - | |
>>>>> Service | Contains details of individual services offered at the property. | object | - | |
Code | Specifies the property amenity code for the service. | enumerated string | For a list of Booking.com supported property amenity codes, see Amenity codes. | |
ExistsCode | Specifies if the service exists (present or missing). | enumerated string | Possible values are: * 1 = yes(present) * 2 = no(missing). | |
Price | The price for the service, specified in the property's default currency. | integer | Required if Code is 173 (breakfast), 6000 (lunch), 6001 (dinner). | |
CurrencyCode | Specifies the currency code. | enumerated string | Booking.com defines the currency for each property. To retrieve a list of all currency codes, use the /xml/currencies endpoint. | |
>>>>>> Types | Contains the types of service offered. | array of Type | Currently used for breakfast services only. | |
>>>>>>> Type | Contains the types of service offered. | object | Currently used for breakfast services only. | |
Code | Specifies the Booking.com breakfast type code. | enumerated string | For a list of supported breakfast type code, see Booking.com Breakfast Type Code | |
>>>>>> Items | Contains a collection of items. | array of Item | Currently used for breakfast services only. | |
>>>>>>> Item | Contains the items for the service offered. | object | Currently used for breakfast services only. | |
Code | Specifies the Booking.com breakfast type code. | enumerated string | For a list of supported breakfast type code, see Booking.com Breakfast Type Code | |
>>>>>> OperationTimes | Contains the opening/closing times for the service offered. | array of OperationTime | Currently used for breakfast services only. | |
>>>>>>> OperationTime | Contains the opening/closing times for a Restaurant or Service like breakfast. | object | Can contain multiple OperationTime elements. | |
Mon | Specifies whether the Start and End times apply on this day of the week. | integer | 1 = true, 0 = false. | |
Tue | Specifies whether the Start and End times apply on this day of the week. | integer | 1 = true, 0 = false. | |
Weds | Specifies whether the Start and End times apply on this day of the week. | integer | 1 = true, 0 = false. | |
Thur | Specifies whether the Start and End times apply on this day of the week. | integer | 1 = true, 0 = false. | |
Fri | Specifies whether the Start and End times apply on this day of the week. | integer | 1 = true, 0 = false. | |
Sat | Specifies whether the Start and End times apply on this day of the week. | integer | 1 = true, 0 = false. | |
Sun | Specifies whether the Start and End times apply on this day of the week. | integer | 1 = true, 0 = false. | |
Start | The opening time of the Restaurant or Service. | enumerated string | For a list of opening time, see Booking.com Check-in/Check-Out Time Code. | |
End | The closing time of the Restaurant or Service. | enumerated string | For a list of closing time, see Booking.com Check-in/Check-Out Time Code. | |
>>>> OwnershipManagementInfos | Information about the property's relationship to Booking.com. | array of OwnershipManagementInfo | - | |
>>>>> OwnershipManagementInfo | Details about the property's relationship to Booking.com. | object | - | |
>>>>>> CompanyName | Details of the company that owns/manages the property. | object | ||
Code | Specifies the ID of the legal entity to which the property belongs. | integer | Only allowed for new properties. | |
>>>> RelativePositions | Contains the travel routes to and from the property. | array of RelativePosition | - | |
>>>>> RelativePosition | Contains the details of a travel route to or from the property. | object | Can contain multiple RelativePosition elements. | |
>>>>>> Transportations | Contains transportation details. | array of Transportation | - | |
>>>>>>> Transportation | Container for TPA_Extensions. | object | Can contain multiple Transportation elements. | |
>>>>>>>> TPA_Extensions | Container for Route. | object | Can contain multiple TPA_Extensions elements. | |
>>>>>>>>> Route | Contains the details of a travel route. | object | - | |
>>>>>>>>>> Leg | Contains the details of the starting point, destination, and transport method. | object | - | |
>>>>>>>>>>> Departure | Contains the departure times. | object | - | |
Interval | Specifies the departure interval in minutes, if the transportation departs multiple times a day. | integer | - | |
UponArrangement | Specifies whether the transportation is available only by arrangement. | integer | 1 = true, 0 false | |
>>>>>>>>>>> Junction | Contains the motorway/highway junction/exit to take. | object | - | |
Name | Specifies the name of the junction/exit to take, if travelling by car. | string | TransportType[Code="5"] (car). | |
>>>>>>>>>>> Line | Contains the public transport line details. | object | - | |
Name | Specifies the name or number of the line to take, if travelling by shuttle or public transport. | string | Only allowed when TransportType[Code] is 3, 10, 18, 22, or 5001. | |
>>>>>>>>>>> Motorway | Contains the motorway/highway details. | object | - | |
Name | Specifies the name of the motorway to take, if travelling by car. | string | Only allowed when TransportType[Code="5"] (car). | |
>>>>>>>>>>> Start | Contains the starting point details. | object | - | |
Type | Specifies the type of starting point. | enumerated string | Accepted values: airport | |
Code | Specifies the 3-letter IATA code of the airport that serves as the starting location. | enumerated string | For a list of supported IATA codes, see IATA. | |
>>>>>>>>>>> TransportType | Contains the transportation method. | object | - | |
Code | Specifies the Transportation Code for the Leg's transportation type. | enumerated string | - | |
>>>>>>>>>> JourneyTime | Contains the travel time details. | object | - | |
Minutes | Specifies the journey time, specified in minutes. | integer | - | |
>>>>>>>>>> Price | Contains the travel price details. | object | - | |
Amount | Specifies the estimated price of the journey, in CurrencyCode. | real | - | |
CurrencyCode | Specifies the currency code. | enumerated string | - | |
>>>> TPA_Extensions | Container for AcceptedPayments, and InvoiceDetails. | object | - | |
>>>>> AcceptedPayments | Contains the details of payment methods. | object | Can contain multiple AcceptedPayments elements. | |
>>>>>> AcceptedPayment | Contains the details of a payment method. | object | Can contain multiple AcceptedPayment elements. | |
PaymentTypeCode | Specifies the Booking.com Payment Type Code. | enumerated string | - | |
>>>>> PaymentPreferences | Contains details such as whether properties can see guest's credit card details and collect CVC codes. | object | ||
NoCVC | Specifies whether properties can collect CVC for a booking. | boolean | * 0 - Properties can collect CVC details. * 1 - Properties cannot collect CVC details. | |
ViewCCDetails | Specifies whether trusted properties can view the guest's credit card details. | boolean | * 0 - Properties cannot view credit card details. * 1 - A trusted property can view the credit card details. | |
>>> FacilityInfo | Contains property's facility details. | object | ||
>>>> GuestRooms | Contains property's room details. | object | ||
>>>>> GuestRoom | Contains property's room details. | object | ||
ID | Specifies the room type ID. | string | - | |
Active | Specifies the room type status (active or inactive). | boolean | Possible values are: - 1: Active. - 0: Inactive. | |
RoomTypeName | Specifies the BCRT room type name. | enumerated string | - | |
Quantity | Specifies the number of sellable units in this room type. | integer | ||
NonSmoking | Specifies whether smoking is allowed in the room. | enumerated string | Possible values are: - Unknown: The property's preference is not known at this time. - 0: Smoking is not allowed. - 1: Smoking is allowed. | |
SizeMeasurement | Specifies the room size. | double | ||
SizeMeasurementUnit | Specifies the unit of measurement used to specify the room size. | enumerated string | ||
>>>>>> Amenity | Contains the details of a room amenity. | object | - | |
RoomAmenityCode | Specifies the Room Amenity Type Code. | enumerated string | - | |
Quantity | Specifies the available number of amenities of this type. | integer | - | |
AmenityCode | Specifies the Room Amenity Type Code. | enumerated string | Same as RoomAmenityCode, introduced for compatibility with OTA_HotelInvNotifRQ. | |
Value | Specifies the available number of amenities of this type. | enumerated string | Same as Quantity, introduced for compatibility with OTA_HotelInvNotifRQ. | |
Configuration | Specifies whether the amenity is available in the standard or alternative room arrangement. | enumerated string | Accepted only when RMA code is a bed type. Possible values: 1 (standard arrangement), 2 (alternative arrangement). Introduced for compatibility with OTA_HotelInvNotifRQ. | |
>>>>>> DescriptiveText | Contains the localised room type name. | string | - | |
>>>>>> TPA_Extensions | Contains extra information like occupancy details. | object | ||
>>>>>>> Occupancy | Contains occupancy details. | object | ||
MaxChildPayableOccupancy | Specifies the maximum number of children that are eligible for the children rate. Any additional child is charged as an adult. | object | ||
>>>>>> Subrooms | Contains sub room details. | object | ||
>>>>>>> Subroom | Contains individual sub room details. | object | ||
RoomType | Specifies the room type details. | enumerated string | ||
PrivateBathroom | Specifies whether the sub room has a private bathroom. | boolean | Possible values are: - 1: True - 0: False | |
MaxGuests | Specifies the maximum number of guests allowed in the room. | integer | ||
>>>>>>>> Amenities | Contains property's amenities details. | object | ||
>>>>>>>>> Amenity | Contains property's amenity details. | object | To avoid duplicates in room amenity codes, the system groups similar amenities using a common amenity code internally. The OTA amenities table provides the default amenity code that is set internally by the Content API when amenities that are same or similar are set using their respective codes. For example, using any of the codes with desk, which are 28 (Desk), 29 (Desk with lamp) and 64 (Large desk), internally default to 28 (Desk). So even when you set code 29, when you retrieve the amenity with the OTA_HotelDescriptiveInfo endpoint, it shows as 28. To learn more about which codes default to what, see room type amenity codes. | |
AmenityCode | Specifies the room amenity type code. | enumerated string | Same as RoomAmenityCode, introduced for compatibility with OTA_HotelInvNotifRQ. | |
Value | Specifies the available number of amenities of this type. | enumerated string | Same as Quantity, introduced for compatibility with OTA_HotelInvNotifRQ. | |
>>>>>> Occupancy | Contains room occupancy details. | object | ||
MaxOccupancy | Specifies the maximum number of guests that can physically fit in the room. | integer | ||
MaxAdultOccupancy | Specifies the maximum number of adults that can physically fit in the room. | integer | ||
MaxChildOccupancy | Specifies the maximum number of children that can physically fit in the room. | integer | ||
>>>>>> Quantities | Contains the maximum number of cribs and rollaways allowed. | object | ||
MaxCribs | Specifies the maximum number of cribs allowed for the room type. | integer | - | |
MaxRollaways | Specifies the maximum number of rollaways allowed for the room type | integer | - | |
>>>> Restaurants | Contains property's restaurant details. | object | ||
>>>>> Restaurant | Contains individual restaurant details. | object | ||
RestaurantName | Name of the restaurant. | string | - | |
OfferBreakfast | Specifies whether the restaurant offers breakfast. | integer | Possible values are: 1, 0. | |
OfferBrunch | Specifies whether the restaurant offers brunch. | integer | Possible values are: 1 - offers brunch, 0 - does not offer brunch. | |
OfferDinner | Specifies whether the restaurant offers dinner. | integer | Possible values are: 1 - offers dinner, 0 - does not offer dinner. | |
OfferLunch | Specifies whether the restaurant offers lunch. | integer | Possible values are: 1 - offers lunch, 0 - does not offer lunch. | |
>>>>>> CuisineCodes | Container for cuisine details. | array of CuisineCode | ||
>>>>>>> CuisineCode | Container for cuisine details. | array of CuisineCode | - | |
Code | Specifies the cuisine codes offered by the restaurant. | integer | For a list of supported cuisine codes, see cuisine codes. | |
>>>>>> OperationSchedules | Container for OperationSchedule. | object | - | |
>>>>>>> OperationSchedule | Container for OperationTimes. | object | - | |
>>>>>>>>> OperationTimes | Contains the opening/closing times for the service offered. | array of OperationTime | Currently used for breakfast services only. | |
>>>>>>>>>> OperationTime | Contains the opening/closing times for a Restaurant or Service like breakfast. | object | Can contain multiple OperationTime elements. | |
Mon | Specifies whether the Start and End times apply on this day of the week. | integer | 1 = true, 0 = false. | |
Tue | Specifies whether the Start and End times apply on this day of the week. | integer | 1 = true, 0 = false. | |
Weds | Specifies whether the Start and End times apply on this day of the week. | integer | 1 = true, 0 = false. | |
Thur | Specifies whether the Start and End times apply on this day of the week. | integer | 1 = true, 0 = false. | |
Fri | Specifies whether the Start and End times apply on this day of the week. | integer | 1 = true, 0 = false. | |
Sat | Specifies whether the Start and End times apply on this day of the week. | integer | 1 = true, 0 = false. | |
Sun | Specifies whether the Start and End times apply on this day of the week. | integer | 1 = true, 0 = false. | |
Start | Specifies the opening time of the Restaurant or Service. | enumerated string | For a list of opening times, see [Booking.com Check-in/Check-Out Time Code.] BCIO | |
End | Specifies the closing time of the Restaurant or Service. | enumerated string | For a list of closing times, see [Booking.com Check-in/Check-Out Time Code.] BCIO | |
>>>>>> Features | Container for special features. | array of Feature | - | |
>>>>>>> Feature | Container for special features. | object | - | |
DescriptiveText | Specifies the feature type. | enumerated string | For all possible values, see DescriptiveText. | |
>>>>>> TPA_Extensions | Container for Ambiances and DietaryOptions. | object | - | |
>>>>>>> Ambiances | Contains the ambiance/mood/atmosphere for a Restaurant. | object | Can contain multiple Ambiances elements. | |
>>>>>>>> Ambiance | Contains the ambiance/mood/atmosphere for a Restaurant. | object | ||
Name | Specifies the ambiance type. | enumerated string | Accepts the following values: * family/kids friendly * modern * romantic * traditional | |
>>>>>>> DietaryOptions | Contains dietary options in a Restaurant. | object | Can contain multiple DietaryOptions elements. | |
>>>>>>>> DietaryOption | Contains a single dietary option in a Restaurant. | object | Can contain multiple DietaryOption elements. | |
Name | Specifies the dietary option. | enumerated string | Possible values are: * dairy free * gluten free * halal * kosher * vegan, vegetarian | |
>>> AreaInfo | Contains details about attractions and amenities near the property. | object | ||
>>>> Attractions | Contains details about attractions and amenities near the property. | object | ||
>>>>> Attraction | Contains attraction details near the property. | object | ||
AttractionCategoryCode | Specifies the attraction Category Code. | enumerated string | For a list of supported attraction codes, see the Attraction code list. | |
AttractionName | Specifies the attraction name (in LanguageCode). | string | - | |
Distance | Specifies the distance from property to attraction (in DistanceUnit). | float | - | |
DistanceUnit | Specifies the measurement unit for Distance. | enumerated string | Possible values are: * meters * kilometers * feet* miles | |
LanguageCode | Specifies the Booking.com Language Code used for the attraction information. | enumerated string | For a list of supported language codes, see Booking.com Language Code table. | |
>>> Policies | Contains all policy details including cancellation and pet policies. | object | - | |
>>>> Policy | Contains policy details. | object | - | |
>>>>> PolicyInfo | Contains the policy information, including check-in/check-out times. | object | - | |
CheckInTime | Specifies the Booking.com Check-in/Check-Out time code for the earliest time a guest can check in. | enumerated string | Format: HH:MM (from) or HH:MM-HH:MM (from-to). Only "from" is required; "to" is optional. 24-hour check-in can be specified using 00:00-00:00. | |
CheckOutTime | Specifies the Booking.com Check-in/Check-Out time code for the time by which a guest should check out at the latest. | enumerated string | Format: HH:MM (from) or HH:MM-HH:MM (from-to). 24-hour check-out can be specified using 00:00-00:00. | |
TotalGuestCount | Specifies the total number of guests that can stay at the property at a given time. | integer | - | |
AcceptedGuestType | Specifies whether the property admits adults and children, or only adults. | enumerated string | Possible values are: AdultOnly and ChildrenAllowed. | |
MinGuestAge | Specifies the minimum age that children are allowed (in case ChildrenAllowed). | integer | ||
>>>>> PetsPolicies | Contains the policies around pets. | array of PetsPolicy | - | |
PetsAllowedCode | Specifies the property's policy regarding pets. | enumerated string | Possible values are: Pets Allowed, Pets Not Allowed, Pets By Arrangements. | |
>>>>>> PetsPolicy | Contains the pets policy details. | object | Required if PetsAllowedCode is Pets Allowed, Pets By Arrangements. | |
NonRefundableFee | Specifies if the property charges for having a pet stay in the room. | enumerated string | Possible values are: free, charges_may_apply | |
>>>>> CancelPolicy | Container for CancelPenalty. | object | - | |
>>>>>> CancelPenalty | Contains the cancellation fee policy details. | object | Can contain multiple CancelPenalty elements. | |
PolicyCode | Specifies the Booking.com Cancellation Policy Code. | enumerated string | ||
Description | Specifies the user-friendly cancellation penalty details. | string | ||
PolicyName | Specifies the policy name that is used internally. You can ignore this value. | enumerated string | ||
>>>>>>> TPA_Extensions | Container for NoShowPolicy. | array of NoShowPolicy | - | |
>>>>>>>> NoShowPolicy | Contains the no-show policy details. | object | Descendant of CancelPenalty. | |
Penalty | Specifies how much the property charges if the guest doesn't show up on the check-in date. | enumerated string | Possible values are: total_price (of stay), default (same as cancellation fee). | |
>>>>> BookingRules | Contains the rules for how long in advance the room can be booked. | array of BookingRule | - | |
>>>>>> BookingRule | Contains the Booking rule details. | object | Can contain multiple BookingRule elements. | |
MinAdvancedBookingOffset | Specifies the minimum amount of time in advance the room must be booked, relative to midnight (24:00 CE(S)T) on the day of check-in. | P[0-9]+(Y/D/H) | The search date is counted as one of the days in the restriction length. Example: P5H means the room must be booked before 19:00 on the check-in date. | |
MaxAdvancedBookingOffset | Specifies the maximum amount of time in advance the room can be booked, relative to midnight (24:00 CE(S)T) on the day of check-in. | P[0-9]+(Y/D/H) | The search date is counted as one of the days in the restriction length. Example: P14D means the room can be booked a maximum of 14 days before the check-in date. | |
ReleaseTimeOfDayStart | Specifies the time of the day the room can start being booked. | HH:MM | Time intervals of 15 minutes starting at midnight. For example: 10:15. | |
ReleaseTimeOfDayEnd | Specifies the time of the day the room can no longer be booked. | HH:MM | Time intervals of 15 minutes starting at midnight. For example: 21:30 | |
>>>>> GuaranteePaymentPolicy | Contains the policies around refunds. | array of GuaranteePayment | - | |
>>>>>> GuaranteePayment | Contains the refund policy details. | object | - | |
PolicyCode | Specifies the Booking.com cancellation policy code. | enumerated string | ||
Description | Specifies the user-friendly guarantee payment details. | string | ||
PolicyName | Specifies the policy name that is used internally. You can ignore this value. | enumerated string | ||
>>>>>>> TPA_Extensions | Container for PrepaymentPolicy | object | - | |
>>>>>>>> PrepaymentPolicy | Contains the prepayment policy details. | object | ||
EffectiveFrom | Specifies the moment at which the refund policy becomes effective. | enumerated string | Possible values are: after_reservation_is_made, after_cancellation_fee_begins. | |
>>>>> TaxPolicies | Contains the policies around taxes. | array of TaxPolicy | - | |
>>>>>> TaxPolicy | Contains the tax policy details. | object | Can contain multiple TaxPolicy elements. | |
Code | Specifies the Fee Tax Type Code. | enumerated string | - | |
Amount | Specifies the amount charged, in the country's local currency. | price | Instead of Amount, you can also use Percent. | |
DecimalPlaces | Specifies the number of decimal places to apply to Amount. | integer | - | |
Percent | Specifies the percentage of the room price that will be added as taxes. | non-negative | Only allowed if Amount is not provided. Required if Code="36" (VAT). | |
Type | Specifies whether the tax is included in the room price or not. | enumerated string | Possible values are: Inclusive, Exclusive. | |
ChargeFrequency | Specifies the Charge Type Code that specifies the basis for the charge. For example, once per stay, every day. | enumerated string | ||
InvCode | Specifies the Booking.com room type ID that this fee applies to. | string | A fee can only apply to one room type at a time. To apply the same fee to multiple rooms, duplicate the entire TaxPolicy element. To apply a fee to all rooms in the property, remove InvCode. Get the room type ID from OTA_HotelInvNotifRS endpoint ResponseInvCode attribute on creation of room type. | |
>>>>> FeePolicies | Contains the policies around service fees (WiFi, heating, pets, etc.). | array of FeePolicy | - | |
>>>>>> FeePolicy | Contains the fee policy details. | object | Can contain multiple FeePolicy elements. | |
Code | Specifies the Fee Tax Type Code. | enumerated string | - | |
Amount | Specifies the amount charged, in the country's local currency. | price | Instead of Amount, you can also use Percent. | |
DecimalPlaces | Specifies the number of decimal places to apply to Amount. | integer | ||
Percent | Specifies the percentage of the room price that will be added as a fee. | non-negative | Only allowed if Amount is not provided. | |
Type | Specifies whether the fee is included in the room price, or is charged only under certain conditions. | enumerated string | Possible values are: Inclusive, Exclusive, Conditional. Conditional is only allowed when [Code="5009"] (cleaning fees). | |
ChargeFrequency | Specifies the Charge Type Code that specifies the unit of time on which the charge is calculated. For example, once per stay, every day. | enumerated string | ||
MinAge | Specifies the minimum age for the children policy to apply. In combination with MaxAge it becomes an age range. | integer | You can use this attribute with Fee Tax Type (FTT) code 37, 38, or 44. If you want to specify different prices per age range, you must create multiple FeePolicy elements within the same request. See example. | |
MaxAge | Specifies the maximum age for the children policy to apply. The max value is 255 (adult). | integer | You can use this attribute with Fee Tax Type (FTT) code 37, 38, or 44. If you want to specify different prices per age range, you must create multiple FeePolicy elements within the same request. See example. | |
InvCode | Specifies the Booking.com room type ID to which the fee applies. | string | You can apply one fee policy to one room type at a time. To apply the same fee policy to multiple rooms, you have to add another FeePolicy element for each additional room type. To apply a fee to all room types in the property, you must remove the InvCode attribute. | |
>>>>>>> TPA_Extensions | Container for Conditions, InternetFeePolicy or ParkingFeePolicy (depending on Type). | object | - | |
>>>>>>>> Conditions | Contains the cleaning fee conditions. | object | - | |
>>>>>>>>> Condition | Contains the cleaning fee condition details. | object | - | |
Type | Specifies when a guest must pay the extra cleaning fee. | enumerated string | Possible values are: guest_brings_pet, guest_doesnt_clean_before_checkout, guest_smokes. | |
>>>>>>>> InternetFeePolicy | Contains the internet fee details. | object | Only allowed when FeePolicy[Type="5035"]. | |
InternetType | Specifies the type of internet connection. **** | enumerated string | Possible values are: wired, wifi, none. | |
InternetCoverage | Specifies the area covered by the internet. | enumerated string | Possible values are: entire_property, public_areas, all_rooms, some_rooms, business_centre. | |
>>>>>>>> ParkingFeePolicy | Contains the parking fee policy details. | object | You can apply parking fee as a FeePolicy, which will not be added to reservation price. To apply parking fee as charges which is applied to all reservations, properties must request Booking.com local support team to set it as VAT/Tax/Charges in the extranet. When the parking fee is set as a charge, ParkingFeePolicy will not be returned with the element TPA_Extensions. | |
ParkingType | Specifies the type of parking the property offers. | enumerated string | Possible values are: on_site, location_nearby, none. | |
ParkingReservation | Specifies whether guests can/must reserve a parking space in advance. | enumerated string | Possible values are: needed, not_needed, not_available. | |
ParkingProperty | Specifies whether the parking facility is publicly accessible or private. | enumerated string | Possible values are: private, public. | |
>>> AffiliationInfo | Contains star ratings and other awards. | object | ||
>>>> Awards | Contains award information. | object | You can only set a star rating for properties with property class hotel, which means you cannot set a star rating for non-hotel properties. To verify whether your property's property class type is a hotel, see the property class type table. | |
>>>>> Award | Contains award details | object | ||
Provider | Specifies the type of award. | enumerated string | Possible values are: Star rating | |
Rating | Specifies the number of stars. | integer | Accepts values: 0–5. Some countries don't use star ratings. | |
>>> ContactInfos | Contains contact information. | object | ||
>>>> ContactInfo | Contains contact details of individual person/channel. | object | ||
ContactProfileType | Specifies the type of contact. | enumerated string | See (#ContactProfileType). | |
>>>>> Names | Contact person names. | array of Name | - | |
>>>>>> Name | Contact person names. | - | ||
Language | Specifies the language used to capture the name. | enumerated string | ||
>>>>>>> GivenName | Contains the contact person names. | object | - | |
>>>>> Addresses | Contains the contact addresses. | array of Address | - | |
>>>>>> Address | Contains the contact addresses. | object | - | |
Language | Specifies the Booking.com Language code for the address details. | enumerated string | For a list of supported language codes, see Booking.com Language Code table. | |
>>>>>>> AddressLine | Specifies the full street name and number. | string | Should not contain abbreviations (such as "Rd." for "Road") and should not exceed 255 characters. | |
>>>>>>> CityName | Specifies the name of the city, town, or village. | string | - | |
>>>>>>> CountryName | Species the two-letter country code. | enumerated string | For more information on how to retrieve the country code details, see xml/countries endpoint. | |
HotelName | Specifies the name of the property (in a language other than English). | object | Required if Language is not en. | |
>>>>>>> PostalCode | Specifies the postal/zip code. | string | - | |
StateProv | Contains the state/province details. | object | - | |
StateCode | Specifies the code for the state or province. | string | Follow the ISO 3166-2 standard to specify the state, province, or other subdivision. | |
>>>>> Emails | Contains the email addresses. | array of Email | - | |
>>>>>> Email | Specifies the email address. | object | - | |
>>>>> Phones | Contains the phone numbers. | array of Phone | - | |
>>>>>> Phone | Specifies the phone number details. | object | - | |
PhonesNumber | Specifies the international phone number. | string | Follows the format: \+[0-9]+ | |
PhoneTechType | Specifies the type of phone line/device. | enumerated string | For a list of supported values, see PTT. | |
>>>>> HiddenAddress | Contains whether the property's address can be shown to the guests before they book a stay on a property. | object | ||
ShouldHideAddress | Specifies whether to hide the address details. | boolean | * 0 - Do not hide the full address. * 1 - Hide the full address from the guest. | |
>>> TPA_Extensions | object | Container for: StandardPhrases, GuestInformation, PropertyTaxInfo, PreventLikelyToBeCancelledBookings, CancellationGracePeriod, TotalNumberOfFloors, PricingType, LongStayInfo, BookingModel. | ||
>>>> StandardPhrases | Contains the standard phrases details. | object | Can contain multiple StandardPhrases elements. | |
>>>>> StandardPhrase | Contains the standard phrase details. | object | Can contain multiple StandardPhrase elements. | |
Enabled | Specifies whether the standard phrase is enabled. | integer | 1 = true, 0 = false. | |
Name | Specifies which standard phrase must be displayed. | enumerated string | For Coronavirus-related phrases, see Standard phrases during the Coronavirus. | |
>>>>>> Options | - | Contains a collection of Options. | ||
>>>>>>> Option | - | Contains the additional configuration for certain types of StandardPhrase. | Required if Name is KeyCollection, Renovation,HotelChainBedLinen, or SecurityDeposit. | |
Name | Specifies the type of option. | enumerated string | Possible values are: KeyCollectionAddressLine, KeyCollectionCityName, KeyCollectionPostalCode, RenovationFrom, RenovationUntil, SecurityDepositAmount, SecurityDepositCollectMethod, SecurityDepositCollectWhen, SecurityDepositCollectNumDays, SecurityDepositReturnMethod, SecurityDepositReturnWhen, HotelChainBedLinenAmount. | |
>>>> GuestInformation | Contains flags that specify which information guests must provide. | object | - | |
RequireGuestAddress | Specifies whether guests must provide an address. | integer | Possible values are: 1 (required), 0 (not required). | |
RequireGuestContactNumber | Specifies whether guests must provide a contact telephone number. | integer | Possible values are: 1 (required), 0 (not required). | |
HasAgeRestriction | Specifies whether there is an age limit to check-in. | integer | Possible values are: 1 (has age restriction), 0 (does not have age restriction). | |
AgeRestrictionMin | Specifies the minimum allowed age for guests to check-in. Only effective when HasAgeRestriction=1. | integer | 18..99 | |
AgeRestrictionMax | Specifies the maximum allowed age for guests to check-in. Only effective when HasAgeRestriction=1. | integer | 18..99 | |
HasCurfew | Specifies whether property has a curfew - times at which guests cannot enter/leave the property. | integer | Possible values are: 1 (has curfew), 0 (does not have curfew). | |
CurfewStart | Specifies the curfew start time in HH:MM format. | string | Only effective when HasCurfew=1. | |
CurfewEnd | Specifies the curfew end time in HH:MM format. | string | Only effective when HasCurfew=1. | |
>>>> PropertyTaxInfo | Object that contains city tax-related information. | object | - | |
PropertyRegisteredInVcs | Specifies whether the property is registered as a professional at the trade commercial register (Registre du Commerce et des Sociétés)? | integer | Possible values are: 1 (yes), 0 (no). | |
PropertyHasVat | Specifies whether the property has a VAT registered for this activity? | integer | Possible values are: 1 (yes), 0 (no). | |
PropertyDeclaresRevenue | Specifies whether the property declares revenues as professional for direct tax purposes (see article 155 IV du CGI)? | integer | Possible values are: 1 (yes), 0 (no). | |
PropertyTaxCategory | Specifies a number - city tax category ID. You can retrieve available categories using the /xml/citytaxcategory call. | integer | If your answer to any of the preceding questions is (yes), then you must NOT send the PropertyTaxCategory. The system sets it up automatically. Possible values are: integer value containing category ID. | |
PropertyNatureCategory | Specifies a number - nature category ID. You can retrieve available categories using /xml/citytaxcategory call. | integer | Specify an integer value containing category ID. | |
Enabled | Enable/disable selling meal plans as addons through booking or not. | boolean | ||
>>>> PreventLikelyToBeCancelledBookings | Contains feature object | object | - | |
Enabled | Enable/disable the feature for current property. | boolean | ||
>>>> CancellationGracePeriod | Contains the cancellation exceptions container object. | object | - | |
HoursAfterBooking | Specifies the grace period - amount of hours after booking when free cancellation is available. | integer | Possible values are: 0, 1, 4, 24. | |
WeeksBeforeCheckIn | Specifies the advance cancellation - amount of weeks before check-in when free cancellation is available. | integer | Possible values are: 0, 4, 8, 12 | |
>>>> TotalNumberOfFloors | Allows to set the total number of floors in the building excluding underground floors. | object | - | |
Number | Specifies the total number of floors the building has (excl. underground floors). | non-negative | ||
>>>> PricingType | Contains additional pricing configuration for HotelProduct. | object | To see this detail, make sure to enable the feature: Include hotel pricing model (include_hotel_pricing_model) in the Provider portal. | |
Value | Specifies the pricing type for the product. | enumerated string | Possible values are: Standard, LOS. length of stay pricing (LOS) must be enabled for a property before it can be used. | |
>>>> LongStayInfo | Contains long stay container object. | object | - | |
AcceptLongStay | Specifies whether the property accepts a stay longer than 30 nights. | boolean | Possible values are: - 0: False - 1: true | |
MaxLengthOfStay | Specifies the maximum length of stay that a guest can book. | integer | Possible values are: 45, 60, 75, 90. | |
>>>> BookingModel | Contains Booking Model container object. | object | - | |
Type | Specifies the type of option. | enumerated string | Possible values are: IB, RTB. | |
RtbEligible | Specifies property's eligibility to use RTB. | boolean | 1 - Property is eligible. 0 - Property is not eligible. |
ContactProfileType
ContactInfo[ContactProfileType] displays the following values. Each value corresponds with a similarly named heading on the Contacts page in our extranet.
A property must have all the required contact profiles before you can open it.
| Value | Description | Required |
|---|---|---|
general | Primary point of contact for the property. | Required |
contract | Contact for contract matters. | Optional |
reservations | Contact for reservations. | Optional |
invoices | Contact for accounts payable. | Required |
availability | Contact for questions about availability. | Optional |
site_content | Contact for photos, descriptions, and other website content. | Optional |
parity | Contact for pricing and rate matters. | Optional |
requests | Contact for special requests. | Optional |
central_reservations | Contact for central reservations. Applies to properties that manage reservations from another location. | Optional |
PhysicalLocation | Address details for the property's physical location. | Required |
Response
The following is a successful response body example:
<?xml version="1.0" encoding="UTF-8"?> <OTA_HotelDescriptiveInfoRS xmlns="http://www.opentravel.org/OTA/2003/05" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.opentravel.org/OTA/2003/05 OTA_HotelDescriptiveInfoRS.xsd" TimeStamp="2023-02-10T14:44:32+00:00" Target="Production" Version="1.006"> <HotelDescriptiveContents> <HotelDescriptiveContent HotelName="Deluxe HillTop Suites" LanguageCode="en-gb" ID="8135188" Status="Test Hotel" CurrencyCode="GBP"> <HotelInfo> <CategoryCodes> <GuestRoomInfo Quantity="30"/> <HotelCategory Code="20"/> </CategoryCodes> <Descriptions> <MultimediaDescriptions> <MultimediaDescription> <TextItems> <TextItem> <Description>Booking.com url</Description> <URL/> </TextItem> </TextItems> </MultimediaDescription> </MultimediaDescriptions> </Descriptions> <Position Longitude="4.9099" Latitude="52.3653"/> <Services> <Service Code="79"/> <Service Code="282"/> <Service Code="5054"/> <Service Code="173" Price="7" CurrencyCode="GBP"> <Types> <Type Code="5001"/> <Type Code="5003"/> <Type Code="5006"/> <Type Code="5010"/> <Type Code="5011"/> </Types> <Items> <Item Code="5001"/> <Item Code="5002"/> <Item Code="5003"/> <Item Code="5006"/> <Item Code="5007"/> <Item Code="5008"/> <Item Code="5010"/> <Item Code="5011"/> <Item Code="5012"/> <Item Code="5017"/> <Item Code="5019"/> </Items> </Service> </Services> <OwnershipManagementInfos> <OwnershipManagementInfo> <CompanyName Code="52383"/> </OwnershipManagementInfo> </OwnershipManagementInfos> <RelativePositions> <RelativePosition> <Transportations/> </RelativePosition> </RelativePositions> <TPA_Extensions> <AcceptedPayments/> <PaymentPreferences NoCVC="1" ViewCCDetails="0"/> </TPA_Extensions> </HotelInfo> <FacilityInfo> <GuestRooms> <GuestRoom ID="813518802" Active="1" RoomTypeName="Quadruple" Quantity="10" NonSmoking="Unknown" SizeMeasurement="144.00" SizeMeasurementUnit="sqft"> <Amenity RoomAmenityCode="13" AmenityCode="13"/> <Amenity RoomAmenityCode="5039" AmenityCode="5039"/> <Amenity RoomAmenityCode="5160" AmenityCode="5160"/> <Amenity RoomAmenityCode="5163" AmenityCode="5163"/> <Amenity RoomAmenityCode="5116" AmenityCode="5116"/> <Amenity RoomAmenityCode="5175" AmenityCode="5175"/> <Amenity RoomAmenityCode="5090" AmenityCode="5090"/> <Amenity RoomAmenityCode="5141" AmenityCode="5141"/> <Amenity RoomAmenityCode="5140" AmenityCode="5140"/> <Amenity RoomAmenityCode="203" Quantity="2" AmenityCode="203" Value="2" Configuration="1"/> <DescriptiveText>Classic Quadruple Room</DescriptiveText> <Occupancy MaxOccupancy="5" MaxAdultOccupancy="5" MaxChildOccupancy="0"/> <Quantities MaxCribs="0" MaxRollaways="0"/> </GuestRoom> <GuestRoom ID="813518803" Active="1" RoomTypeName="Quadruple" Quantity="40" NonSmoking="Unknown" SizeMeasurement="144.00" SizeMeasurementUnit="sqft"> <Amenity RoomAmenityCode="5141" AmenityCode="5141"/> <Amenity RoomAmenityCode="5140" AmenityCode="5140"/> <Amenity RoomAmenityCode="13" AmenityCode="13"/> <Amenity RoomAmenityCode="5039" AmenityCode="5039"/> <Amenity RoomAmenityCode="5160" AmenityCode="5160"/> <Amenity RoomAmenityCode="5163" AmenityCode="5163"/> <Amenity RoomAmenityCode="5116" AmenityCode="5116"/> <Amenity RoomAmenityCode="5175" AmenityCode="5175"/> <Amenity RoomAmenityCode="5090" AmenityCode="5090"/> <DescriptiveText>Double Room</DescriptiveText> <TPA_Extensions> <SubRooms> <SubRoom RoomType="Bedroom" MaxGuests="2"> <Amenities> <Amenity AmenityCode="249" Value="1"/> </Amenities> </SubRoom> <SubRoom RoomType="Bedroom" MaxGuests="2"> <Amenities> <Amenity AmenityCode="203" Value="2"/> </Amenities> </SubRoom> <SubRoom RoomType="Bathroom" Number="1"/> </SubRooms> </TPA_Extensions> <Occupancy MaxOccupancy="2" MaxAdultOccupancy="2" MaxChildOccupancy="0"/> <Quantities MaxCribs="0" MaxRollaways="0"/> </GuestRoom> <GuestRoom ID="813518804" Active="1" RoomTypeName="Chalet" Quantity="5" NonSmoking="1" SizeMeasurement="284.00" SizeMeasurementUnit="sqft"> <Amenity RoomAmenityCode="5141" AmenityCode="5141"/> <Amenity RoomAmenityCode="5140" AmenityCode="5140"/> <Amenity RoomAmenityCode="5160" AmenityCode="5160"/> <Amenity RoomAmenityCode="5163" AmenityCode="5163"/> <Amenity RoomAmenityCode="5116" AmenityCode="5116"/> <Amenity RoomAmenityCode="13" AmenityCode="13"/> <Amenity RoomAmenityCode="5039" AmenityCode="5039"/> <Amenity RoomAmenityCode="5175" AmenityCode="5175"/> <Amenity RoomAmenityCode="5090" AmenityCode="5090"/> <DescriptiveText>Three-Bedroom Chalet</DescriptiveText> <Occupancy MaxOccupancy="7" MaxAdultOccupancy="7" MaxChildOccupancy="0"/> <Quantities MaxCribs="0" MaxRollaways="0"/> </GuestRoom> </GuestRooms> <Restaurants/> </FacilityInfo> <AreaInfo> <Attractions> <Attraction AttractionName="Christmas market" AttractionCategoryCode="29" Distance="1.20" DistanceUnit="miles" LanguageCode="en-gb"/> <Attraction AttractionName="Sushi restaurant" AttractionCategoryCode="41" Distance="3.00" DistanceUnit="meters" LanguageCode="en-gb"/> <Attraction AttractionName="Scuba diving venue" AttractionCategoryCode="5" Distance="3.00" DistanceUnit="meters" LanguageCode="en-gb"/> </Attractions> </AreaInfo> <Policies> <Policy> <PolicyInfo CheckInTime="12:00" CheckOutTime="10:00" MinGuestAge="0" AcceptedGuestType="AdultOnly"/> <PetsPolicies PetsAllowedCode="Pets Allowed"> <PetsPolicy NonRefundableFee="charges_may_apply"/> </PetsPolicies> <CancelPolicy> <CancelPenalty PolicyCode="43" Description="The guest can cancel free of charge until 14:00 on the day of arrival. The guest will be charged the cost of the first night if they cancel after 14:00 on the day of arrival." PolicyName="PTT_GENERAL"> <TPA_Extensions> <NoShowPolicy Penalty="default"/> </TPA_Extensions> </CancelPenalty> <CancelPenalty PolicyCode="62" Description="The guest can cancel free of charge until 5 days before arrival. The guest will be charged 50% of the total price if they cancel in the 5 days before arrival." PolicyName="PTT_SPECIAL_CONDITIONS"> <TPA_Extensions> <NoShowPolicy Penalty="default"/> </TPA_Extensions> </CancelPenalty> <CancelPenalty PolicyCode="152" Description="The guest can cancel free of charge at any time." PolicyName="PTT_FULLY_FLEXIBLE"> <TPA_Extensions> <NoShowPolicy Penalty="default"/> </TPA_Extensions> </CancelPenalty> <CancelPenalty PolicyCode="568" Description="The guest can cancel free of charge until 45 days before arrival. The guest will be charged the cost of the first night if they cancel in the 45 days before arrival." PolicyName="PTT_SPECIAL_CONDITIONS_2"> <TPA_Extensions> <NoShowPolicy Penalty="default"/> </TPA_Extensions> </CancelPenalty> </CancelPolicy> <GuaranteePaymentPolicy> <GuaranteePayment PolicyCode="43" Description="The guest will be charged a prepayment of the cost of the first night after reservation." PolicyName="PTT_GENERAL"> <TPA_Extensions> <PrepaymentPolicy EffectiveFrom="after_reservation_is_made"/> </TPA_Extensions> </GuaranteePayment> <GuaranteePayment PolicyCode="62" Description="The guest will be charged a prepayment of 50% of the total price after reservation." PolicyName="PTT_SPECIAL_CONDITIONS"> <TPA_Extensions> <PrepaymentPolicy EffectiveFrom="after_reservation_is_made"/> </TPA_Extensions> </GuaranteePayment> <GuaranteePayment PolicyCode="152" Description="No prepayment is needed." PolicyName="PTT_FULLY_FLEXIBLE"/> <GuaranteePayment PolicyCode="568" Description="The guest will be charged a prepayment of the cost of the first night after reservation." PolicyName="PTT_SPECIAL_CONDITIONS_2"> <TPA_Extensions> <PrepaymentPolicy EffectiveFrom="after_reservation_is_made"/> </TPA_Extensions> </GuaranteePayment> </GuaranteePaymentPolicy> <TaxPolicies> <TaxPolicy Code="3" Percent="350" DecimalPlaces="2" Type="Exclusive"/> <TaxPolicy Code="36" Percent="1800" DecimalPlaces="2" Type="Inclusive"/> </TaxPolicies> <FeePolicies> <FeePolicy Code="5012" Amount="1600" DecimalPlaces="2" Type="Exclusive" ChargeFrequency="12"/> <FeePolicy Code="5013" Amount="1800" DecimalPlaces="2" Type="Exclusive" ChargeFrequency="12"/> <FeePolicy Code="44" Amount="3100" DecimalPlaces="2" ChargeFrequency="21" MinAge="4" MaxAge="12"/> <FeePolicy Code="37" Amount="2400" DecimalPlaces="2" ChargeFrequency="20" MinAge="0" MaxAge="3"/> <FeePolicy Code="5036" Amount="2000" DecimalPlaces="2" Type="Exclusive" ChargeFrequency="2"> <TPA_Extensions> <ParkingFeePolicy ParkingType="location_nearby" ParkingReservation="not_needed" ParkingProperty="public"/> </TPA_Extensions> </FeePolicy> </FeePolicies> </Policy> </Policies> <AffiliationInfo> <Awards> <Award Rating="0"/> </Awards> </AffiliationInfo> <ContactInfos> <ContactInfo ContactProfileType="PhysicalLocation"> <Addresses> <Address> <AddressLine>Nieuwe Kerkstraat 157</AddressLine> <CityName>Amsterdam</CityName> <PostalCode>1000 CC</PostalCode> <CountryName>nl</CountryName> </Address> </Addresses> <HiddenAddress ShouldHideAddress="0"/> </ContactInfo> <ContactInfo ContactProfileType="general"> <Names> <Name Language="en"> <GivenName>Wilson Nivea</GivenName> </Name> </Names> <Addresses/> <Emails> <Email>noreply@test.com</Email> </Emails> <Phones> <Phone PhonesNumber="+31666666666" PhoneTechType="1"/> <Phone PhonesNumber="+31666666666" PhoneTechType="5"/> </Phones> </ContactInfo> <ContactInfo ContactProfileType="invoices"> <Names> <Name Language="en"> <GivenName>Becky Pascal</GivenName> </Name> </Names> <Addresses> <Address> <AddressLine>Herengracht 000</AddressLine> <CityName>Amsterdam</CityName> <PostalCode>100 AB</PostalCode> <CountryName>nl</CountryName> </Address> </Addresses> <Phones> <Phone PhonesNumber="+31207777777" PhoneTechType="1" Extension="30"/> </Phones> </ContactInfo> </ContactInfos> <TPA_Extensions> <StandardPhrases> <StandardPhrase Name="SecurityDeposit" Enabled="1"/> <StandardPhrase Name="NoHenStagParty" Enabled="1"/> </StandardPhrases> <GuestInformation RequireGuestAddress="0" RequireGuestContactNumber="0"/> <PreventLikelyToBeCancelledBookings Enabled="0"/> <TotalNumberOfFloors Number="2"/> <LongStayInfo AcceptLongStay="0"/> <BookingModel Type="RTB" RtbEligible="1"/> <CancellationGracePeriod HoursAfterBooking="0" WeeksBeforeCheckIn="0"/> <PricingType Value="Standard"/> </TPA_Extensions> </HotelDescriptiveContent> </HotelDescriptiveContents> </OTA_HotelDescriptiveInfoRS> <!-- RUID: [XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX]