Under construction
This page is currently a work-in-progress. After the Beta, you can find the finalised version here.
Understanding the contracting API¶
The Contracting API enables you to efficiently participate in and keep track of the contracting process of your Accommodation Partners.
What is contracting?¶
For an Accommodation Partner's property to become open and bookable, the Accommodation Partner must sign a contract with Booking.com.
In addition, to start building a property with HotelDescriptiveContentNotif you must first provide either of the following:
- Legal entity id: Specifies the unique Booking.com id of an Accommodation Partner.
- Legal contact email: Specifies the email of the Accommodation Partner's legal contact with Booking.com.
Two contracting flows¶
Which flow you use depends on how actively you want to participate in the contracting process. Look at the following two main flows to understand what can work best for you:
- Legal entity id first flow: This flow uses only the Contracting API.
- Build first flow (with legal contact email): This flow uses both the build first contracting flow feature and some of the Contracting API functionalities.
→ To switch on the contracting feature, see the Accommodation Partner build first contracting flow feature on the feature management page.
Legal entity id first¶
To understand how to use the legal entity id flow, look at the following diagram and descriptions:
Build first¶
To understand how to use the build first flow, look at the following diagram and descriptions:
What is possible with the Contracting API?¶
On a high level, the Contracting API enables you to:
- Accept legal details of Accommodation Partner (AP) to return a legal entity id and send an email to AP with link to Booking.com contracting tool.
- Check whether AP has signed the contract with Booking.com.
- Resend email to AP with link to Booking.com contracting tool.
- Retrieve basic legal details AP: Legal entity ID, contract signed status, and countries in which the AP has properties.
Why use the Contracting API?¶
How does the Contracting API work?¶
Main URL and use of shortened endpoint paths¶
The Contracting API's main URL is https://supply-xml.booking.com/contracts-api. All shortened endpoint paths imply that you must add the main URL. For example: /partners/legal-details becomes https://supply-xml.booking.com/contracts-api/partners/legal-details in an actual request.
Authentication¶
Contracting API uses the same [authentication methods][authentication] as other APIs.