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

https://connect-sandbox.su-api.com/SUAPI/jservice/bdc/property/settings/retrieve

Header

-app-id: YOUR_APP_ID
Authorization: YOUR_API_KEY
Content-Type:application/json

Header	Type	Required	Description
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

{
   "hotel_id": "AWSTEST",
   "channel_hotel_id": "12837615"
}

---

Response

Sample Success Response

{
  "Status": "Success",
  "Message": "Successfully fetch details",
  "Warnings": "",
  "Ruid": "e527c45a-f23a-4ee4-beb2-7d21f7699b1b",
  "data": {
    "property_settings": {
      "require_cvc": false,
      "require_booker_address": false,
      "require_booker_contact_number": false,
      "auto_replenish": true,
      "replenish_closed_rooms": true,
      "long_stay": {
        "enabled": true,
        "max_length_of_stay": 45
      },
      "pricing_type": "Standard",
      "allow_smoking": true,
      "view_cc_details": false
    },
    "pets": {
      "pets_allowed": "PETS_ALLOWED_ON_REQUEST",
      "pets_price_type": "CHARGES_MAY_APPLY"
    },
    "damage_policy": {
      "amount": 0,
      "policy_type": "NONE",
      "damage_programme_terms_agreed": false
    },
    "standard_phrases": [],
    "accepted_payment_types": {
      "codes": [
        1,
        2,
        3,
        4
      ]
    },
    "children_policies": {
      "allow_children": true,
      "min_age": 0,
      "policy_rules": [
        {
          "rule_type": "EXTRA_BED",
          "from_age": 4,
          "to_age": 255,
          "price_type": "FIXED",
          "price_mode": "PER_NIGHT",
          "price": 70
        }
      ]
    },
    "invoice_settings": {
      "legal_name": "Sahdev Gohil",
      "contact_person": "Sahdev Gohil",
      "address": "No 370, Block No 328, TP 14, RS, Pal - Umra Bridge, beside Sumerru Business Corner, Adajan Gam, Adajan, Surat",
      "notification_channel": "EMAIL",
      "country_code": "IN",
      "city": "Surat",
      "postal_code": "395009"
    },
    "booking_model": {
      "type": "IB"
    }
  }
}

Success Response Body Elements

Status string

Indicates the overall status of the request.

In this case, "Success" means the operation was completed successfully.

---

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.

Can be one of the values: 45, 60, 75, 90.

pricing_type string

Specifies the property's pricing type.

Can be Standard, LOS or OBP.

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.

Possible values are: - PETS_ALLOWED, - PETS_NOT_ALLOWED and - PETS_ALLOWED_ON_REQUEST.

pets_price_type string

Specifies pets price type option for the property.

Possible values are: - FREE - CHARGES_MAY_APPLY.

---

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.

Possible values are: - NONE, - HANDLED_BY_PROPERTY and - HANDLED_BY_BOOKING_COM.

damage_programme_terms_agreed boolean

Specifies if you agree to the terms for the damage programme.

To view damage deposit terms, you can view Retrieve Property Settings 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.

You can specify the following: the minimum age the children are welcome and additional rules for existing/extra bed or crib.

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.

Possible values are: - EXISTING_BED - EXTRA_BED - CRIB - EXTRA_BED_FOR_ADULTS.

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.

Can be PER_NIGHT or PER_STAY.

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.

Can be one of: POSTAL_MAIL or EMAIL.

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

{
   "Errors": [
       {
           "Code": "400",
           "ShortText": "HotelCode: Invalid HotelCode ('AWSTEST')"
       }
   ],
   "Status": "Fail"
}

Sample Error Response 2

{
   "Errors": [
       {
           "Code": "573",
           "ShortText": "channel-mapping not found for this property!"
       }
   ],
   "Status": "Fail"
}

Sample Error Response 3

{
   "Status": "Fail",
   "Errors": [],
   "Message": "Data not found: Not found",
   "Ruid": "485dfd5b-9fed-4f4b-9362-6bc7c9071b8e",
   "Data": {}
}

---

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.

For example: "400" indicates a bad request.

ShortText string

A short description of the error.

---

Message string

A message providing more information about the error.