Retrieve Property Settings
This endpoint allows partners to retrieve the current property settings for their accommodations on the Booking.com platform. It provides detailed information about various configurations, including guest requirements, pricing models, pet policies, and damage policies. This enables partners to effectively manage their properties and ensure compliance with their chosen operational guidelines.
Endpoint
POST
Header
app-id
string
Yes
Your application ID. Required for authentication.
Authorization
string
Yes
Your API key for authorization.
Content-Type
string
Yes
Must be set to application/json.
Attributes
hotel_id string (Required)
The unique property ID as assigned by the provider upon creation of the property.
channel_hotel_id string (Required)
The unique id for the hotel on the specific channel.
Sample Request
Response
Sample Success Response
Success Response Body Elements
Status string
Indicates the overall status of the request.
Message string
Provides a brief message about the outcome. Here, it states "Successfully done," confirming that the request was processed without issues.
data object
Contains detailed results of the various settings processed in the request.
property_settings object
Contains multiple various settings related to the property.
require_cvc boolean
Specifies whether the guest needs to provide CVC details for the booking.
require_booker_address boolean
Specifies whether the guests must provide a contact address.
require_booker_contact_number boolean
Specifies whether the guests must provide a contact telephone number.
auto_replenish boolean
Specifies if property is enabled to auto-replenish and is used to make a room available to sell again after a cancellation.
replenish_closed_rooms boolean
Specifies whether to reopen closed rooms after a cancellation. This will open a closed room after a cancellation is received.
long_stay object
Contains whether property accepts a stay longer than 30 nights.
enabled boolean
Specifies whether the property has a long stay option enabled.
max_length_of_stay integer
Specifies the maximum number of days allowed to stay at the property.
pricing_type string
Specifies the property's pricing type.
allow_smoking boolean
Specifies whether the property allows smoking.
view_cc_details boolean
Specifies whether a trusted property can view the guest's credit card details on Extranet.
pets object
Contains settings related to pets policy.
pets_allowed string
Specifies whether pets are allowed at the property.
pets_price_type string
Specifies pets price type option for the property.
damage_policy object
Contains settings related to damage policy.
amount integer
Specifies the amount on which the damage deposit or programme is applicable for
policy_type string
Specifies the policy that is applicable.
damage_programme_terms_agreed boolean
Specifies if you agree to the terms for the damage programme.
standard_phrases array of strings
Contains settings related to standard phrases. You can send 1 or multiple standard phrases that you want to enable or remove.
accepted_payment_types object
Contains settings related to payment methods.
codes array of integers
Specifies the list of supported payment methods.
children_policies object
Contains whether a property accepts children.
allow_children boolean
Specifies whether the property admits adults and children, or only adults.
min_age integer
Specifies the minimum age of children allowed to stay at the property.
policy_rules array of objects
You can specify a different price and rules for children staying in EXISTING_BED and specify a price for children staying in CRIB or EXTRA_BED.
rule_type string
Specifies the rule type for which this rule applies.
from_age integer
Specifies the minimum age for the children policy to apply. In combination with to_age it becomes an age range.
to_age integer
Specifies the maximum age for the children policy to apply.
price_type string
Specifies if the rule is FREE, ADULT_PERCENTAGE, or FIXED price.
price_mode string
Specifies the unit of time on which the charge is calculated.
price integer
If price_type is Fixed, specifies a fixed amount charged in the country's local currency.
If price_type is ADULT_PERCENTAGE, specifies a percentage of adult price to charge as child price.
invoice_settings object
Specifies the details of the company that owns/manages the property.
legal_name string
Specifies the legal name of the company.
contact_person string
Specifies the full name of the contact person.
address string
Specifies the company address.
notification_channel string
Specifies the channel that the company prefers to be notified for invoice related information.
country_code string
Specifies the country Code.
Should be valid ISO code.
city string
Specifies the city name.
postal_code string
Specifies the postal/Zip code.
booking_model object
Contains whether the property can have request to book option.
type string
Specifies the booking model type of the property. Can be RTB (request to Book) or IB (instant booking).
Errors
Sample Error Response 1
Sample Error Response 2
Sample Error Response 3
Error Response Body Elements
Status string
Indicates the result of the API call, which will be always "Fail" in case of an error response.
Error array
Array that contains details about any errors that occurred during the API call. Each object in the Errors array contains the following properties:
Code string
Specific error code that helps identify the type of error.
ShortText string
A short description of the error.
Message string
A message providing more information about the error.
Last updated
Was this helpful?