Contracting API

Resend contract details

Contracting API (1.0.0)

Use the Contracting API to invite a new partner on Booking.com, check whether a partner has signed the contract, resend invitation mail and retrieve the legal entity of the partner.

Authentication

The Contracting API supports token-based authentication. Each request must have an Authorization header containing a JWT token. Manage your machine accounts in the Connectivity Portal. See also the Authentication page of the documentation.

Message formats

The Contracting API accepts and returns JSON.

Documentation

Read the Contracting API documentation for more details about working with this API.

Download OpenAPI description

contracting-api-specificaion.json

contracting-api-specificaion.yaml

Servers

Test static response

https://developers.booking.com/_mock/connectivity/docs/openapispecs/contracting-api/contracting-api-specificaion/

Test using live endpoint

https://supply-xml.booking.com/contracts-api/

Manage contracts

Create, update or resend contract details.

Operations

Update an existing contract

Request

Use this endpoint to send addendum to the partner to add more countries where properties can be listed, only if partner has already a signed contract with Booking.com.

Headers

Authorizationstring

Bodyapplication/json

additional_countriesArray of stringsrequired

List of country codes where partner has properties for which addendum should be signed.

is_teststring

Flag to filter in/out test partner cards. Setting it to 1 will look for test partners only, 0 will look for non-test partners only.

Enum"0""1"

le_idinteger(int32)

Legal entity ID of the partner. This is treated as the unique identifier for the partner.

legal_contact_emailstring

Contract contact email ID of the partner. This is treated as the unique identifier for the partner.

curl -i -X POST \
  https://developers.booking.com/_mock/connectivity/docs/openapispecs/contracting-api/contracting-api-specificaion/partners/addendum \
  -H 'Authorization: string' \
  -H 'Content-Type: application/json' \
  -d '{
    "additional_countries": [
      "be"
    ],
    "le_id": 14379109
  }'

Responses

Bodyapplication/json

dataobject(AddendumObject)required

data.statusstringrequired

Status message indicating whether the addendum email was sent successfully.

Example: "Addendum invitation sent to Partner."

data.successinteger(int32)required

A flag that indicates if the operation finished successfully.

Example: 1

errorsArray of objects(DiagnosisList)

metaobjectrequired

meta.ruidstringrequired

Response Unique Identifier. Refer to this when talking to Booking.com Connectivity Support.

Example: "UmFuZG9tSVYkc2Rl...="

warningsArray of objects(DiagnosisList)

Response

application/json

Response when adding countries to a partner with a signed contract. Addendum invitation is successfully sent to the partner.

{
  "data": {
    "success": 1,
    "status": "Addendum invitation sent to Partner."
  },
  "errors": [],
  "warnings": [],
  "meta": {
    "ruid": "UlPrZG9tSVYkc2RlIyh9YeobhK72bvPcGuKpIGBV43CLA0/ew3f32vvfbcDMZPMJ2upJzzPiWPpwqgrzqgrYuylZFVYodyywjTysIR2C7iIMdzNV3jh=="
  }
}

Resend contract details

Request

Use this endpoint to resend the invitation email to the partner's registered contract email address.

Bodyapplication/json

is_testinteger

Flag to filter in/out test partner cards. Setting it to 1 will look for test partners only, 0 will look for non-test partners only.

Enum01

legal_contact_emailstringrequired

Contract contact email id of the partner. This is treated as the unique identifier for the partner.

curl -i -X POST \
  https://developers.booking.com/_mock/connectivity/docs/openapispecs/contracting-api/contracting-api-specificaion/partners/resend-invite \
  -H 'Content-Type: application/json' \
  -d '{
    "legal_contact_email": "peter.park+test01@besthotelxyz.abc"
  }'

Responses

Bodyapplication/json

dataobject(ReInviteObject)required

data.statusstringrequired

Status message indicating whether the invitation email was resent successfully.

Example: "Invitation sent to Partner."

data.successinteger(int32)required

A flag that indicates if the operation finished successfully.

Example: 1

errorsArray of objects(DiagnosisList)

metaobjectrequired

meta.ruidstringrequired

Response Unique Identifier. Refer to this when talking to Booking.com Connectivity Support.

Example: "UmFuZG9tSVYkc2Rl...="

warningsArray of objects(DiagnosisList)

Response

application/json

{
  "meta": {
    "ruid": "UmFuZG9tSVYkc2RlIyh9Ya+pg/21ggUOrSQsocNZo8+onmuF/0Np5bNl9bXkIHOzcL5xe4+2Q5m5Yz4XU6LD/TrgwjmmpchX1cKrgLwhK4o="
  },
  "data": {
    "status": "Invitation sent to Partner.",
    "success": 1
  },
  "warnings": [],
  "errors": []
}

Resend updated contract

Request

Use this endpoint to resend addendum to the partner to add more countries where properties can be listed, only if partner has already a signed contract with Booking.com.

Bodyapplication/json

is_teststring

Flag to filter in/out test partner cards. Setting it to 1 will look for test partners only, 0 will look for non-test partners only.

Enum"0""1"

le_idinteger(int32)

Legal entity ID of the partner. This is treated as the unique identifier for the partner.

legal_contact_emailstring

Contract contact email ID of the partner. This is treated as the unique identifier for the partner.

curl -i -X POST \
  https://developers.booking.com/_mock/connectivity/docs/openapispecs/contracting-api/contracting-api-specificaion/partners/resend-addendum \
  -H 'Content-Type: application/json' \
  -d '{
    "le_id": 14379109
  }'

Responses

Bodyapplication/json

dataobject(AddendumObject)required

data.statusstringrequired

Status message indicating whether the addendum email was sent successfully.

Example: "Addendum invitation sent to Partner."

data.successinteger(int32)required

A flag that indicates if the operation finished successfully.

Example: 1

errorsArray of objects(DiagnosisList)

metaobjectrequired

meta.ruidstringrequired

Response Unique Identifier. Refer to this when talking to Booking.com Connectivity Support.

Example: "UmFuZG9tSVYkc2Rl...="

warningsArray of objects(DiagnosisList)

Response

application/json

{
  "errors": [],
  "data": {
    "success": 1,
    "status": "Addendum invitation resent to Partner."
  },
  "warnings": [],
  "meta": {
    "ruid": "UmFuZG9tSVYkc2RlIyh9YUNOyFG1G7yZ4N4g32GjUq4m7gLy4mLHvgfKCKKcaShQJ1ARh2IeVOWB/7DRTmDzp3Eh6SJyAq2mtqfDc16BxoY="
  }
}

Check legal details

Check legal details of Partner using email or entity ID.

Operations

Request access

Request access to existing partner.

Operations

About Try it

Learn how to effectively use the Try it feature in the Contracting API documentation.

Use the Try it feature to send test request examples to the API endpoints directly from the developer portal and depending on the selected environment either see static, pre-built responses or dynamic responses from a test property.