Under construction

This page is currently a work-in-progress. After the Beta, you can find the finalised version here.

Managing contracting flow

This section describes all the possible actions related to contracting through the Contracting API.

Quick actions

POST
https://supply-xml.booking.com/contracts-api/partners/invite

The POST /partners/invite request enables you to send the required legal details of a new Accommodation Partner to create their legal entity id.

In addition, a successfull request also triggers an email to be sent to the new Accommodation Partner with a link to the Booking.com contracting tool. The Accommodation Partner must sign the contract before you can set a property as open and bookable.

Body parameters

The following table describes what elements you must add as body parameters:

Element Description Type Required/Optional Notes
legal_contact_email Specifies the Accommodation Partner's legal contact email. string required The system sees this email as the unique identifier for the Accommodation Partner.
legal_contact_name Specifies the Accommodation Partner's legal contact name. string required
legal_contact_phone_number Specifies the Accommodation Partner's legal contact phone number. string optional Follows ITU E.164.
legal_name Specifies the legal name of the Accommodation Partner company. string optional
preferred_language Specifies the preferred language in which the Accommodation Partner wants to communicate. string required For the language codes, see Booking.com Language Code
company_name Specifies the commercial name of the Accommodation Partner company. string required
website Specifies the website of the Accommodation Partner company. string optional
total_number_of_properties Specifies the amount of properties connected to the Accommodation Partner. string optional
country Specifies the country of the Accommodation Partner. string optional To retrieve a list of the available country codes, see retrieving country codes
city Specifies the city of the Accommodation Partner. string optional
zipcode Specifies the zipcode of the Accommodation Partner. string optional
street Specifies the street of the Accommodation Partner. string optional

Request body example

The following is a request body example:

{
    "city": "Amsterdam",
    "company_name": "Giovanni hotels",
    "country": "nl",
    "legal_contact_email": "don.giovanni@hotel.com",
    "legal_contact_name": "Don Giovanni",
    "legal_contact_phone_number": "+1234567890",
    "legal_name": "Giovanni hotels BV",
    "preferred_language": "xu",
    "street": "Streetstreet",
    "total_number_of_properties": 2,
    "zipcode": "1000AB",
    "website": "https://www.besthotel.com"
   }

Response body example

The following is a successful response body example:

{
    "meta": {
        "ruid": "UmFuZG9tSVYkc2RlIyh9YeobhK72bvPcV0nJP9QOSA+dzomZn9+s+9FQ9kgxfFX4ENvHYNN0LCnFNICpW0ciFwK1qAKX8jr7j4KTc3UQb3zqaliHlsArhQ=="
    },
    "errors": [],
    "data": {
        "legal_entity_id": 425500
    },
    "warnings": []
 }

Response body elements

The following table describes the response elements:

Element Description Type Notes
data Contains the response data. object
: legal_entity_id Specifies the unique legal entity id. integer
meta Contains the response meta data. object
: ruid Specifies the unique id of the request. string You can send this id to Booking.com customer support if you run into an issue. This can help to understand what went wrong.
warnings Contains potential warnings. These can help you improve your requests. array
errors Contains potential errors. These can help you understand what went wrong with your request. array
POST
https://supply-xml.booking.com/contracts-api/partners/legal-details

The POST /partners/legal-details request enables you to check whether the contract has been signed. You can also retrieve:

  • The Accommodation Partner's legal entity id.
  • The Accommodation Partner's legal details.
  • (In case the contract is signed): A list of countries in which the Accommodation Partner has properties.

Body parameters

The following table describes what elements you must add as body parameters:

Element Description Type Required/Optional Notes
legal_contact_email Specifies the Accommodation Partner's legal contact email. string required The system sees this email as the unique identifier for the Accommodation Partner.

Request body example

The following is a request body example:

{
    "legal_contact_email": "don.giovanni@hotel.com"
   }

Response body example

The following is a successful response body example:

{
    "data": {
       "contract_countries": [
         "Netherlands",
         "Belgium"
        ],
      "legal_entity_id": 425500,
      "contract_signed": 1    
      },
    "meta": {
        "ruid": "UmFuZG9tSVYkc2RlIyh9YdNF88ZH3iWf3q3zRnxaG8Qon3uXbbWLbe1KHSW+/QZ9+IdWevm3MHqE92V/WSliV7hxcoarf/wcM8leBfq3p9YWXuAygzwxjg=="
    },
    "warnings": [],
    "errors": []
 }

Response body elements

The following table describes the response elements:

Element Description Type Notes
data Contains the response data. object
: contract_countries Contains the countries for which the Accommodation Partner has signed a contract. array You can only see this array when the contract is signed.
: legal_entity_id Specifies the unique legal entity id. integer
: contract_signed Indicates whether the contract is signed. boolean
: legal_contact_name Specifies the Accommodation Partner's legal contact name. string
: legal_contact_phone_number Specifies the Accommodation Partner's legal contact phone number. string Follows ITU E.164.
: company_name Specifies the commercial name of the Accommodation Partner company. string
: total_number_of_properties Specifies the amount of properties connected to the Accommodation Partner. string
: country Specifies the country of the Accommodation Partner. string
: city Specifies the city of the Accommodation Partner. string
meta Contains the response meta data. object
: ruid Specifies the unique id of the request. string You can send this id to Booking.com customer support if you run into an issue. This can help to understand what went wrong.
warnings Contains potential warnings. These can help you improve your requests. array
errors Contains potential errors. These can help you understand what went wrong with your request. array
POST
https://supply-xml.booking.com/contracts-api/partners/resend-invite

The POST /partners/resend-invite request enables you to resend the email to the Accommodation Partner with a link to the Booking.com contracting tool. The Accommodation Partner must sign the contract before you can set a property as open and bookable.

Body parameters

The following table describes what elements you must add as body parameters:

Element Description Type Required/Optional Notes
legal_contact_email Specifies the Accommodation Partner's legal contact email. string required The system sees this email as the unique identifier for the Accommodation Partner.

Request body example

The following is a request body example:

{
    "legal_contact_email": "don.giovanni@hotel.com"
   }

Response body example

The following is a successful response body example:

{
    "data": {
        "success": 1,
        "status": "Invitation sent to Partner!"
    },
    "errors": [],
    "warnings": [],
    "meta": {
        "ruid": "UmFuZG9tSVYkc2RlIyh9YeobhK72bvPcGuKpIGBV43CLA0/7JFJASBu0RvfbcDMZPMJ2upJzzPiWPpgrz8CqgrYuylZFVYdIxxxjTysIR2C7iIMdzNV9aw=="
    }
 }

Response body elements

The following table describes the response elements:

Element Description Type Notes
data Contains the response data. object
: success Indicates the success of the operation . boolean
: status Specifies the status of the operation. string
meta Contains the response meta data. object
: ruid Specifies the unique id of the request. string You can send this id to Booking.com customer support if you run into an issue. This can help to understand what went wrong.
warnings Contains potential warnings. These can help you improve your requests. array
errors Contains potential errors. These can help you understand what went wrong with your request. array