Property Management APIs
Booking.com provides multiple APIs to manage focussed sections of your property and its content. These APIs are part of the initiative to modularise the Content API (used to create and open properties on Booking.com).
The Property Management API consists of the following APIs:
API Name | Purpose | Status |
---|---|---|
Property API | Create and manage property details such as name, property category, physical location, check in/out time among others. | Generally available. |
Property settings endpoint | Set and manage feature opt-in, property flags and standard phrases/fine print. | Generally available. |
Contacts API | Create and manage property contact details. | Generally available. |
Facilities API | Create and manage a property's facilities and room amenities. | Generally available. |
Rooms API | Create and manage room types and room configurations including bedding. | Soon to come. |
Charges API | Set and manage VAT, taxes and fee details for both property and rooms. | Generally available. |
Note that in addition to implementing these APIs, you must follow few other steps to open a property. For additional information on getting the property ready for guests' booking through Booking.com, see the solution page.
Authentication
The Property Management APIs use the same authentication methods as other APIs.
Property API
Create and manage a property by providing only the basic required details.
What can you do with Property Details API
The following are the benefits of using the property-api
:
- Create or update a property's details such as name, property category, check in/out time and physical location without impacting other information.
- Edit the property location by changing the property's latitude and longitude values.
- Specify an external property ID while creating a property. This could be the ID of the property within your system and may be useful for you while you're debugging or testing your integration.
- Create a property ID quickly by providing minimum information. Add the rest of the details later using other endpoints.
- See an improved request and response body structure in Json.
- Get familiar with the validation checks for property creation and property updates early.
For more details on the Property Details API, see Managing property details.
Difference in request parameters between HDCN and property-api
To see the difference in request parameters between the OTA_HotelDescriptiveContentNotif
and property-api
, see the Root parameter in HDCN column under the Request body parameters table.
Managing property settings
Use the Property API's settings
endpoint to manage settings at the property level like property's location coordinates, pets allowance, children policies and so on. For more information, see managing property settings.
Contacts API
Use the Contacts API to create and manage property contact information. To open/list a property on Booking.com, a general/primary point of contact is required.
In addition, you can:
- Create one contact and use the same contact information to represent multiple contact profile types.
- Replace multiple contact details using a single request.
What you can do with Contacts API
The following are the benefits of using the contacts-api
:
- Just send only contacts information and no other property information.
- You can update any contact details including of types:
General
when the property is open and bookable. - You can use the same contact details for multiple contact types. This reduces creating duplicate contacts for different purposes.
- Get familiar with the validation checks early.
- See an improved request and response body structure in Json.
For more details on the Contacts API, see Managing contact details.
Difference in request parameters between HDCN and contacts-api
To see the difference in request parameters between the OTA_HotelDescriptiveContentNotif
and contacts-api
, see the Root parameter in HDCN column under the Request body parameters table.
You need to specify a property ID to create contacts, room details, facilities & amenities or taxes & fees for a property and to set property settings.
Facilities API
Use the Facilities API to manage facilities at both the property and room-level.
Using the Facilities API, you can:
- Explore available facilities, facility IDs and other related details through the meta endpoint.
- Add, update, or remove property facilities.
- Get the list of facilities set for the property.
- Add, update, or remove room facilities.
- Get the list of facilities set for the room.
For more information, see the introduction to the Facilities API.
Charges API
Use the Charges API to manage charges at both the property and room-level.
Using the Charges API, you can:
- Explore available charge types and their related details through the meta endpoint.
- Retrieve, add, update, or remove property and room charges.
For more information, see the introduction to the Charges API.
Using Property Management APIs along with OTA_HotelDescriptiveContentNotif
The following section lists the recommended approach when using either or both of the Property Management APIs along with the OTA_HotelDescriptiveContentNotif
(HDCN) endpoint.
Using Contacts API along with OTA_HotelDescriptiveContentNotif
When using Contacts API along with the OTA_HotelDescriptiveContentNotif
endpoint, make sure to:
- Omit the
ContactInfos
field from theOTA_HotelDescriptiveContentNotif
endpoint call to retain the contact details managed using the Contacts API. - When you cannot use Contacts API due to some issues, make sure to send all the contact details using the
OTA_HotelDescriptiveContentNotif
endpoint to update the contacts.
Using Property Details API along with OTA_HotelDescriptiveContentNotif
When using Property Details API along with the OTA_HotelDescriptiveContentNotif
endpoint, make sure to:
- Omit the fields from the
OTA_HotelDescriptiveContentNotif
endpoint call to retain the information managed using the Property Details API. - When you cannot use the Property Details API due to some issues, you can use the
OTA_HotelDescriptiveContentNotif
endpoint to update the property details. - When using the Property Details API along with the
OTA_HotelDescriptiveInfo
endpoint to retrieve the property details, the contact of type:PhysicalLocation
is created by default.
Using Property Details API, Contacts API along with OTA_HotelDescriptiveContentNotif
When using the OTA_HotelDescriptiveContentNotif
endpoint along with the Contacts and Property Details APIs, make sure to:
- Omit the
ContactInfos
and its child elements along with the parameters specified underRoot Parameter in HDCN
column in the Request body parameters table of Property Details API to retain the information managed by both the Contacts and Property Details API. - If you cannot use the Property Details API, you can continue using Contacts API as recommended in the Using Contacts API along with HDCN section.
- Update the property details using the
OTA_HotelDescriptiveContentNotif
endpoint. - When updating the property's physical location contact, make sure to omit specifying the
email
field.
- Update the property details using the
- If you cannot use the Contacts API, you can continue using the Property Details API as recommended in the Using Property Details API along with HDCN section.
- Use the
OTA_HotelDescriptiveContentNotif
endpoint to update the contact details.
- Use the
Using Facilities API along with OTA_HotelDescriptiveContentNotif
When using the Facilities API along with the OTA_HotelDescriptiveContentNotif
endpoint, make sure to:
- Omit the
Services
field from theOTA_HotelDescriptiveContentNotif
endpoint call to retain the facilities details managed using the Facilities API. - If you cannot use the Facilities API due to some issues, make sure to send all the facilities details using the
OTA_HotelDescriptiveContentNotif
endpoint to update the facilities details.
Using Facilities API along with OTA_HotelInvNotif (rooms endpoint)
When using Facilities API along with the OTA_HotelInvNotif
, make sure to:
- Omit the
Amenities
field from theOTA_HotelInvNotif
endpoint call to retain the room facilities details managed using the Facilities API. - If you cannot use the Facilities API due to some issues, make sure to send all the facilities details using the
OTA_HotelInvNotif
endpoint to update the room facilities.
Using Charges API along with OTA_HotelDescriptiveContentNotif
When using the Charges API along with the OTA_HotelDescriptiveContentNotif
endpoint, make sure to:
- Omit the
TaxPolicies
andFeePolicies
fields from theOTA_HotelDescriptiveContentNotif
endpoint call to retain the charge details managed using the Charges API. - If you cannot use the Charges API due to some issues, make sure to send all the charge details using the
OTA_HotelDescriptiveContentNotif
endpoint to update the charge details.
For more information please see the explanation in the Charges Documentation
Going live
Before you go live with your API integration, you'll need to meet certain requirements. For more information, see Going Live.
Quick Actions
→ To learn more about the Property API, see Introduction to Property API.
→ To learn more about the Contacts API, see Introduction to Contacts API.