Managing property details

Use the Property Details API (property-api) to create, update and retrieve property details.

Creating property details

POST
https://supply-xml.booking.com/property-api/properties

Use the property-api endpoint to create a property by specifying the property details such as name, property category, physical location, check in/out time and few others. After successfully processing the request, the endpoint returns a property ID.

API validations

In addition to the validations mentioned in the Request body parameters table below, here are some additional validations to be aware of:

• The latitude and longitude values must correspond to the country specified under physical_address ... >... country_code. Otherwise, the API returns Cannot create a hotel because UFI country (countryCode) is different from property country (countryCode).
• Make sure the property is not a duplicate of an existing non-test property. Property Details API defines a duplicate as having an exact match on: property name, address line, position.latitude, and position.longitude.
  • If the API finds a duplicate property AND the property is associated with your account or the provided LEID then the API returns the existing properties’ ID so that you can add more room types or quantity or ask the property owner to update the existing property. For more information, see the OTA Error Code 850.
  • In the case that you still wish to create the property, you can avoid the duplicate block by ensuring that the property name or address line is unique.
  • Note that the duplicate check is applied on all creation requests, both production and test. However, only existing production properties are searched when considering potential duplicates. This is a departure how from duplicate check is applied in OTA_HotelDescriptiveContentNotif. If you wish to test the duplicate check behaviour when creating a test property, it must match an existing production property.
• The postcode/zip code must be correct for the city.
• The postcode/zip code must be correct for the country.
• Add a valid phone number with +country code (rather than just the local number).

Property naming convention

When naming a property, ensure that the name:

• Has a length between 3 and 255 characters.
• Does not contain a phone number (or no more than five consecutive numbers).
• Name does not include emojis or some special characters including " | > <"
• Is not all in uppercase.
• Does not support CJK Unified Ideographs.

Header parameter

The following table describes the elements you can add in the header:

Request body parameters

The following table describes the elements you can add in the request body:

Request body

The following is a request body example:

{
  "position": {
    "latitude": 52.388418,
    "longitude": 4.619941
  },
  "check_in": {
    "from": "12:30"
  },
  "check_out": {
    "from": "10:00",
    "until": "10:30"
  },
  "property_name": "Floating hotel",
  "property_category": 30,
  "primary_language": "en-gb",
  "languages_spoken": [
    "en-gb",
    "nl",
    "ms"
  ],
  "room_count": 8,
  "floor_count": 1,
  "provider_property_id": "flotella003",
  "stars": "4",
  "target": "test",
  "physical_address": {
    "city_name": "Overveen",
    "country_code": "NL",
    "postal_code": "2051",
    "address_line": "Zandvoort",
    "display_address": true
  },
  "translations": [
    {
      "city_name": "Overveen",
      "address_line": "Zandvoort",
      "language_code": "es",
      "property_name": "Floating hotel"
    }
  ],
  "legal_entity_id": "78775"
}

Response body

The following is a response body example:

{
  "data": {
    "property_id": 10664256
  },
  "warnings": [],
  "meta": {
    "ruid": "08240512-21g4-4575-p94g-e76me888fwq4"
  }
}

Response body elements

The following table describes the response elements:

Updating property details

PATCH
https://supply-xml.booking.com/property-api/properties/{propertyID}

Use the PATCH property-api endpoint along with the property ID as a path parameter to update the property details. All request parameters are optional. You can specify only the parameters that you want to change. Several request parameters can be unset by passing null as the value. This is reiterated in the respective parameter's description.

API validations

In addition to the validations mentioned in the Request body parameters table below, here are some additional validations to be aware of:

• Cannot update a property if it is in one of the following statuses:
  • XML: Ready to check
  • XML: Ready to open
  • Closed Post Legal
  • Closed forever
  • XML: Hotel is Duplicate
• Can update the following fields only if the property is in Test Hotel or XML: Being built status.
  • currency_code
  • primary_language
  • physical_address
    • address_line
    • city_name
    • country_code
    • postal_code
    • primary_language

Header parameter

The following table describes the elements you can add in the header:

Path parameter

The following table describes the elements you can add in the path:

Request body parameters

The following table describes the elements you can add in the request body:

Request body

The following is a request body example:

{
  "check_in": {
    "from": "12:00"
  },
  "check_out": {
    "from": "09:30"
  },
  "languages_spoken": [
    "en-gb",
    "nl",
    "ms",
    "de",
    "fr",
    "pl"
  ]
}

Response body

{
  "data": {
    "property_id": 10664256
  },
  "warnings": [],
  "meta": {
    "ruid": "1c9bff15-h4742-9l08-2ew3-df4fd1f1166b"
  }
}

Response body elements

The following table describes the response elements:

Retrieving property details

GET
https://supply-xml.booking.com/property-api/properties/{propertyID}

Use the GET property-api endpoint along with the property ID to retrieve the property details.

Header parameter

The following table describes the elements you can add in the header:

Path parameter

The following table describes the elements you can add in the path:

Response body

{
  "data": {
    "position": {
      "latitude": 52.388418,
      "longitude": 4.619941
    },
    "check_in": {
      "from": "12:00"
    },
    "check_out": {
      "from": "09:30",
      "until": "10:30"
    },
    "property_name": "Floating hotel",
    "property_category": 30,
    "primary_language": "en-gb",
    "languages_spoken": [
      "en-gb",
      "ms",
      "nl"
    ],
    "room_count": 8,
    "floor_count": 1,
    "provider_property_id": "flotella003",
    "stars": "4",
    "target": "test",
    "currency_code": "EUR",
    "property_id": 10664256,
    "status": "Test Hotel",
    "physical_address": {
      "city_name": "Overveen",
      "country_code": "nl",
      "postal_code": "2051",
      "address_line": "Zandvoort",
      "display_address": true
    },
    "translations": [
      {
        "city_name": "Overveen",
        "address_line": "Zandvoort",
        "language_code": "es",
        "property_name": "Floating hotel"
      }
    ],
    "legal_entity_id": "78775"
  },
  "meta": {
    "ruid": "2ccea0cc-9a0b-4179-9c20-9436e50cc070"
  }
}

Response body elements

The following table describes the response elements:

Quick Actions

→ To learn more about the Property API use cases, see [Property API implementation use cases.][property-api-usecases-ga]
→ To troubleshoot Property API errors, see [Troubleshooting Property API error responses.][troubleshooting-property-api-ga]
→ To create and manage property contacts, see [Contacts API.][managing-contact-details-ga]