Property API (1.0)

Use the Property API to create or update a property and its settings; check and update property status; as well as create or update property description.

Languages
Servers
Test static response
https://developers.booking.com/_mock/connectivity/docs/openapispecs/property-details-api/property-details-api-specification/
Test using live endpoint
https://supply-xml.booking.com/property-api/

Property Details API

Create, update and retrieve property details

Operations

Create property

Request

Headers
Accept-Versionstring
Bodyapplication/jsonrequired
translationsArray of objects(Translation)
positionobject(Position)required
position.​latitudenumber(double)[ -90 .. 90 ]required

Property's latitude. Validation: Must be between -90 and 90

position.​longitudenumber(double)[ -180 .. 180 ]required

Property's longitude. Validation: Must be between -180 and 180

check_inobject(TimeRange)required
check_in.​fromstring^(?:[01]\d|2[0-3]):[03]0$

Validation: Specified via the format HH:MM, where HH can be 00 to 24 and MM can be 00 or 30 Required for check-in, optional for check-out 24-hour check-in/check-out can be specified using 00:00 as both from and to

check_in.​untilstring^(?:[01]\d|2[0-3]):[03]0$

Validation: Specified via the format HH:MM, where HH can be 00 to 24 and MM can be 00 or 30 Optional for check-in. If check-out passed, required. 24-hour check-in/check-out can be specified using 00:00 as both from and to

check_outobject(TimeRange)
property_namestring[ 3 .. 255 ] charactersrequired

Specifies the name of the property on Booking.com. Validation: We do not allow CJK Unified Ideographs. Should be shorter than 255 characters. Must have at least 3 letters, one of which must be lower case. Must not have more than 5 numbers. Can't include punctuation, asterisks or symbols. Current Documentation DataMapping: HotelName

property_categoryinteger(int32)
booking_property_categoryinteger(int32)

The Booking.com code for property_category. Utilize the meta endpoint for valid values and their OTA mappings. Validation: During creation, either property_category or booking_property_category are required.

primary_languagestring

Specifies the language in which the property wants their Booking.com extranet content and communication (emails, notifications, ...) etc. Validation: One of Booking.com Language Code Default: en-gb Current Documentation DataMapping: LanguageCode

languages_spokenArray of strings
room_countinteger(int32)>= 0required

The number of sellable units the property offers. DataMapping: GuestRoomInfo->Quantity

floor_countinteger(int32)[ 0 .. 200 ]

Total number of floors the building has (excl. underground floors). Validation: Max value of 200 DataMapping: TotalNumberOfFloors->Number

provider_property_idstring[ 0 .. 16 ] characters

An external id to be associated with the property (e.g. the providers internal id) Validation: Maximum length of 16 characters DataMapping: HotelInfo-ID

currency_codestring[ 0 .. 3 ] characters

Booking.com defines the currency for each property. In most cases this should not be passed as only one currency is allowed per country. Retrieve a list of all currency codes with /xml/currencies Validation: Must be allowed for property's country Current Documentation Data Mapping: currencyCode

starsstring^0(\.0)?|[1-4](\.[05])?|5(\.0)?$

The number of stars a property has. Validation: String with values 0 through 5, optionally may include half stars for values 1 or greater (i.e. 0, 1, 1.5, 2, 2.5 ... 4, 4.5, 5) Default: 0 DataMapping: AffiliationInfo->Awards->Award

targetstringrequired

Specifies whether the request is to create a test property or a real property. Validation: String value of production or test DataMapping: Target

Enum"test""production"
physical_addressobject(Address)required
physical_address.​city_namestringrequired

The name of the city, town, or village. Validation: We do not allow CJK Unified Ideographs Current Documentation: CityName DataMapping: ContactInfo/Addresses/CityName

physical_address.​country_codestringrequired
physical_address.​postal_codestring
physical_address.​address_linestring[ 1 .. 255 ] charactersrequired

The full street name and number. Validations: Minimum 1 at most 255 characters. We also do not allow CJK Unified Ideographs. Should not contain abbreviations (such as "Rd." for "Road") and should not exceed 255 characters. Current Documentation: AddressLine DataMapping: ContactInfo/Addresses/AddressLine

physical_address.​display_addressboolean
legal_entity_idinteger(int64)required

The leid for the property. Current Documentation DataMapping: HotelInfo/OwnershipManagementInfos/OwnershipManagementInfo/CompanyName/Code

curl -i -X POST \
  https://developers.booking.com/_mock/connectivity/docs/openapispecs/property-details-api/property-details-api-specification/properties \
  -H 'Accept-Version: string' \
  -H 'Content-Type: application/json' \
  -d '{
    "translations": [
      {
        "city_name": "string",
        "address_line": "string",
        "language_code": "string",
        "property_name": "string"
      }
    ],
    "position": {
      "latitude": -90,
      "longitude": -180
    },
    "check_in": {
      "from": "string",
      "until": "string"
    },
    "check_out": {
      "from": "string",
      "until": "string"
    },
    "property_name": "string",
    "property_category": 0,
    "booking_property_category": 0,
    "primary_language": "string",
    "languages_spoken": [
      "string"
    ],
    "room_count": 0,
    "floor_count": 200,
    "provider_property_id": "string",
    "currency_code": "str",
    "stars": "string",
    "target": "test",
    "physical_address": {
      "city_name": "string",
      "country_code": "string",
      "postal_code": "string",
      "address_line": "string",
      "display_address": true
    },
    "legal_entity_id": 0
  }'

Responses

default response

Bodyapplication/json
dataobject(PropertyId)
warningsArray of objects(ApiErrorOTA)
errorsArray of objects(ApiErrorOTA)
metaobject(ResponseMeta)
Response
application/json
{ "data": { "property_id": 0 }, "warnings": [ {} ], "errors": [ {} ], "meta": { "ruid": "string" } }

Read property

Request

Path
propertyIdinteger(int32)required
Headers
Accept-Versionstring
curl -i -X GET \
  'https://developers.booking.com/_mock/connectivity/docs/openapispecs/property-details-api/property-details-api-specification/properties/{propertyId}' \
  -H 'Accept-Version: string'

Responses

default response

Bodyapplication/json
dataobject(PropertyInfoRead)
warningsArray of objects(ApiErrorOTA)
errorsArray of objects(ApiErrorOTA)
metaobject(ResponseMeta)
Response
application/json
{ "data": { "translations": [], "position": {}, "check_in": {}, "check_out": {}, "property_name": "string", "property_category": 0, "booking_property_category": 0, "primary_language": "string", "languages_spoken": [], "room_count": 0, "floor_count": 200, "provider_property_id": "string", "currency_code": "str", "stars": "string", "target": "test", "property_id": 0, "status": "string", "url": "string", "physical_address": {}, "legal_entity_id": 0 }, "warnings": [ {} ], "errors": [ {} ], "meta": { "ruid": "string" } }

Partial update property info

Request

Path
propertyIdinteger(int32)required
Headers
Accept-Versionstring
Bodyapplication/json
translationsArray of objects(Translation)
positionobject(Position)required
position.​latitudenumber(double)[ -90 .. 90 ]required

Property's latitude. Validation: Must be between -90 and 90

position.​longitudenumber(double)[ -180 .. 180 ]required

Property's longitude. Validation: Must be between -180 and 180

check_inobject(TimeRange)required
check_in.​fromstring^(?:[01]\d|2[0-3]):[03]0$

Validation: Specified via the format HH:MM, where HH can be 00 to 24 and MM can be 00 or 30 Required for check-in, optional for check-out 24-hour check-in/check-out can be specified using 00:00 as both from and to

check_in.​untilstring^(?:[01]\d|2[0-3]):[03]0$

Validation: Specified via the format HH:MM, where HH can be 00 to 24 and MM can be 00 or 30 Optional for check-in. If check-out passed, required. 24-hour check-in/check-out can be specified using 00:00 as both from and to

check_outobject(TimeRange)
property_namestring[ 3 .. 255 ] charactersrequired

Specifies the name of the property on Booking.com. Validation: We do not allow CJK Unified Ideographs. Should be shorter than 255 characters. Must have at least 3 letters, one of which must be lower case. Must not have more than 5 numbers. Can't include punctuation, asterisks or symbols. Current Documentation DataMapping: HotelName

property_categoryinteger(int32)
booking_property_categoryinteger(int32)

The Booking.com code for property_category. Utilize the meta endpoint for valid values and their OTA mappings. Validation: During creation, either property_category or booking_property_category are required.

primary_languagestring

Specifies the language in which the property wants their Booking.com extranet content and communication (emails, notifications, ...) etc. Validation: One of Booking.com Language Code Default: en-gb Current Documentation DataMapping: LanguageCode

languages_spokenArray of strings
room_countinteger(int32)>= 0required

The number of sellable units the property offers. DataMapping: GuestRoomInfo->Quantity

floor_countinteger(int32)[ 0 .. 200 ]

Total number of floors the building has (excl. underground floors). Validation: Max value of 200 DataMapping: TotalNumberOfFloors->Number

provider_property_idstring[ 0 .. 16 ] characters

An external id to be associated with the property (e.g. the providers internal id) Validation: Maximum length of 16 characters DataMapping: HotelInfo-ID

currency_codestring[ 0 .. 3 ] characters

Booking.com defines the currency for each property. In most cases this should not be passed as only one currency is allowed per country. Retrieve a list of all currency codes with /xml/currencies Validation: Must be allowed for property's country Current Documentation Data Mapping: currencyCode

starsstring^0(\.0)?|[1-4](\.[05])?|5(\.0)?$

The number of stars a property has. Validation: String with values 0 through 5, optionally may include half stars for values 1 or greater (i.e. 0, 1, 1.5, 2, 2.5 ... 4, 4.5, 5) Default: 0 DataMapping: AffiliationInfo->Awards->Award

physical_addressobject(Address)required
physical_address.​city_namestringrequired

The name of the city, town, or village. Validation: We do not allow CJK Unified Ideographs Current Documentation: CityName DataMapping: ContactInfo/Addresses/CityName

physical_address.​country_codestringrequired
physical_address.​postal_codestring
physical_address.​address_linestring[ 1 .. 255 ] charactersrequired

The full street name and number. Validations: Minimum 1 at most 255 characters. We also do not allow CJK Unified Ideographs. Should not contain abbreviations (such as "Rd." for "Road") and should not exceed 255 characters. Current Documentation: AddressLine DataMapping: ContactInfo/Addresses/AddressLine

physical_address.​display_addressboolean
curl -i -X PATCH \
  'https://developers.booking.com/_mock/connectivity/docs/openapispecs/property-details-api/property-details-api-specification/properties/{propertyId}' \
  -H 'Accept-Version: string' \
  -H 'Content-Type: application/json' \
  -d '{
    "translations": [
      {
        "city_name": "string",
        "address_line": "string",
        "language_code": "string",
        "property_name": "string"
      }
    ],
    "position": {
      "latitude": -90,
      "longitude": -180
    },
    "check_in": {
      "from": "string",
      "until": "string"
    },
    "check_out": {
      "from": "string",
      "until": "string"
    },
    "property_name": "string",
    "property_category": 0,
    "booking_property_category": 0,
    "primary_language": "string",
    "languages_spoken": [
      "string"
    ],
    "room_count": 0,
    "floor_count": 200,
    "provider_property_id": "string",
    "currency_code": "str",
    "stars": "string",
    "physical_address": {
      "city_name": "string",
      "country_code": "string",
      "postal_code": "string",
      "address_line": "string",
      "display_address": true
    }
  }'

Responses

default response

Bodyapplication/json
dataobject(PropertyId)
warningsArray of objects(ApiErrorOTA)
errorsArray of objects(ApiErrorOTA)
metaobject(ResponseMeta)
Response
application/json
{ "data": { "property_id": 0 }, "warnings": [ {} ], "errors": [ {} ], "meta": { "ruid": "string" } }

Property Settings API

Add, update or retrieve property settings

Operations

Property Status API

Check if a property is ready to open; open or close a property

Operations

Property Description API

Create, update and retrieve property description

Operations

About Try it

Learn how to effectively use the Try it feature in the Property 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.