Property Details API (1.0)

Create and update charges that apply at the property and room level, and setup up different configurations for different dates.

Languages
Servers
https://supply-xml.booking.com/

Property Details API

Description of the Property Details API.

Operations

Property Settings API

Description of the Property Settings API.

Operations

Read property settings

Request

Path
propertyIdinteger(int32)required
curl -i -X GET \
  'https://supply-xml.booking.com/properties/{propertyId}/settings'

Responses

default response

Bodyapplication/json
dataobject(PropertySettingsReadOutputData)
warningsArray of objects(ApiError)
errorsArray of objects(ApiError)
metaobject(ResponseMeta)
Response
application/json
{ "data": { "property_settings": {}, "pets": {}, "damage_policy": {}, "standard_phrases": [], "quiet_hours": {}, "renovation": {}, "bed_linen_policy": {}, "accepted_payment_types": {}, "french_tax_details": {}, "cancellation_exceptions": {}, "age_buckets": [], "children_policies": {}, "invoice_settings": {}, "booking_model": {} }, "warnings": [ {} ], "errors": [ {} ], "meta": { "ruid": "string" } }

Create property settings

Request

Path
propertyIdinteger(int32)required
Bodyapplication/json
property_settingsobject(property_settings)

Contains multiple various settings related to the property

petsobject(pets)

Contains settings related to the pets allowance

damage_policyobject(damage_policy)
standard_phrasesArray of objects(StandardPhraseData)
quiet_hoursobject(quiet_hours)
renovationobject(renovation)
bed_linen_policyobject(hotel_chain_bed_linen)
accepted_payment_typesobject(accepted_payment_types)

List of payment methods. Please check for full list of payment codes: https://connect.booking.com/user_guide/site/en-US/codes-bcpt/

french_tax_detailsobject(french_tax_details)
cancellation_exceptionsobject(cancellation_exceptions)
age_bucketsArray of objects(AgeBucketData)

An age bucket is a category for children prices that specifies the age range to which the eventual price applies to. You must at least create one, but can create up to three age buckets per property. Each age bucket exists of a minimum and maximum age, where the maximum age is inclusive.

children_policiesobject(children_policies)

You can indicate whether a property accepts children and specify: price, occupancy and what age children are welcome

booking_modelobject(booking_model)

Specify if properties have request to book option enabled. Currently available only for: fr, au, us, it, de, gb, es

invoice_settingsobject(invoice_settings)
curl -i -X POST \
  'https://supply-xml.booking.com/properties/{propertyId}/settings' \
  -H 'Content-Type: application/json' \
  -d '{
    "property_settings": {
      "require_cvc": true,
      "curfew": {
        "enabled": true,
        "start": "string",
        "end": "string"
      },
      "require_booker_address": true,
      "require_booker_contact_number": true,
      "age_restriction": {
        "enabled": true,
        "min": 0,
        "max": 0
      },
      "auto_replenish": true,
      "replenish_closed_rooms": true,
      "long_stay": {
        "enabled": true,
        "max_length_of_stay": 0
      },
      "pricing_type": "STANDARD",
      "allow_smoking": true,
      "view_cc_details": true
    },
    "pets": {
      "pets_allowed": "PETS_NOT_ALLOWED",
      "pets_price_type": "FREE"
    },
    "damage_policy": {
      "amount": 0.1,
      "currency": "string",
      "policy_type": "NONE",
      "damage_programme_terms_agreed": true,
      "collection_mode": "CASH",
      "collection_when": "ON_ARRIVAL",
      "return_mode": "CASH",
      "return_when": "ON_CHECKOUT"
    },
    "standard_phrases": [
      {
        "name": "GuestIdentification",
        "enabled": true
      }
    ],
    "quiet_hours": {
      "enabled": true,
      "start": "string",
      "end": "string"
    },
    "renovation": {
      "enabled": true,
      "start": "string",
      "end": "string"
    },
    "bed_linen_policy": {
      "enabled": true,
      "amount": 0.1
    },
    "accepted_payment_types": {
      "codes": [
        0
      ]
    },
    "french_tax_details": {
      "category_id": "string",
      "nature_id": "string",
      "declare_revenue": true,
      "has_vat": true,
      "registered_in_rcs": true
    },
    "cancellation_exceptions": {
      "grace_period": {
        "enabled": true,
        "after_booking": "HOURS_1"
      },
      "advance_cancellation": {
        "enabled": true,
        "before_check_in": "WEEKS_4"
      }
    },
    "age_buckets": [
      {
        "min_age": 17,
        "max_age": 17
      }
    ],
    "children_policies": {
      "allow_children": true,
      "min_age": 0,
      "policy_rules": [
        {
          "rule_type": "EXISTING_BED",
          "from_age": 0,
          "to_age": 0,
          "price_type": "FIXED",
          "price_mode": "PER_STAY",
          "price": 0.1
        }
      ]
    },
    "booking_model": {
      "type": "IB"
    },
    "invoice_settings": {
      "legal_name": "string",
      "contact_person": "string",
      "address": "string",
      "country_code": "string",
      "city": "string",
      "postal_code": "string",
      "state": "st",
      "notification_channel": "POSTAL_MAIL",
      "brazil_tax_details": {
        "tax_payer_number_type": "CNPJ",
        "tax_payer_number": "string",
        "city_hall_id": "string",
        "email": "string"
      }
    }
  }'

Responses

default response

Bodyapplication/json
dataobject
warningsArray of objects(ApiError)
errorsArray of objects(ApiError)
metaobject(ResponseMeta)
Response
application/json
{ "data": { "property1": {}, "property2": {} }, "warnings": [ {} ], "errors": [ {} ], "meta": { "ruid": "string" } }

Get Damage Programme Terms

Request

Query
language_codestringrequired

Accepts Booking Language Code: https://developers.booking.com/connectivity/docs/codes-bcl/

curl -i -X GET \
  'https://supply-xml.booking.com/legal/damage-programme/terms?language_code=string'

Responses

default response

Bodyapplication/json
dataobject(DamageProgrammeTerms)
warningsArray of objects(ApiError)
errorsArray of objects(ApiError)
metaobject(ResponseMeta)
Response
application/json
{ "data": { "raw_full_text": "string" }, "warnings": [ {} ], "errors": [ {} ], "meta": { "ruid": "string" } }