# 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.

***

### <mark style="color:yellow;">Endpoint</mark>

<mark style="color:green;background-color:green;">**`POST`**</mark>&#x20;

<div align="left"><figure><img src="https://958347541-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FM9bn2UcBkeqtqixkl5eF%2Fuploads%2FpsybX0n39kUB8Z8WOk4X%2FSandbox%20image.png?alt=media&#x26;token=4ae73d0f-0d1a-4d73-a4e2-673dbc081d6a" alt="" width="56"><figcaption></figcaption></figure></div>

{% code overflow="wrap" %}
```url
https://connect-sandbox.su-api.com/SUAPI/jservice/bdc/property/settings/retrieve
```
{% endcode %}

#### <mark style="color:yellow;">Header</mark>

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

<table><thead><tr><th width="185">Header</th><th width="85">Type</th><th width="101">Required</th><th>Description</th></tr></thead><tbody><tr><td><code>app-id</code></td><td>string</td><td>Yes</td><td>Your application ID. Required for authentication.</td></tr><tr><td><code>Authorization</code></td><td>string</td><td>Yes</td><td>Your API key for authorization. </td></tr><tr><td><code>Content-Type</code></td><td>string</td><td>Yes</td><td>Must be set to <code>application/json</code>.</td></tr></tbody></table>

***

<mark style="color:yellow;">**Attributes**</mark>

`hotel_id` <mark style="color:orange;">**string (Required)**</mark>

The unique property ID as assigned by the provider upon creation of the property.

***

`channel_hotel_id` <mark style="color:orange;">**string (Required)**</mark>

The unique id for the hotel on the specific channel.

***

## <mark style="color:yellow;">**Sample Request**</mark>

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

***

## <mark style="color:yellow;">Response</mark>

#### <mark style="color:green;">**Sample Success Response**</mark>

{% code overflow="wrap" %}
```json
{
  "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"
    }
  }
}
```
{% endcode %}

#### <mark style="color:yellow;">Success Response Body Elements</mark>

`Status` <mark style="color:orange;">**string**</mark>&#x20;

Indicates the overall status of the request.&#x20;

{% hint style="info" %}
In this case, "Success" means the operation was completed successfully.
{% endhint %}

***

`Message` <mark style="color:orange;">**string**</mark>

Provides a brief message about the outcome. Here, it states "Successfully done," confirming that the request was processed without issues.

***

`data` <mark style="color:orange;">**object**</mark>&#x20;

Contains detailed results of the various settings processed in the request.

`property_settings` <mark style="color:orange;">**object**</mark>

Contains multiple various settings related to the property.

`require_cvc` <mark style="color:orange;">**boolean**</mark>

Specifies whether the guest needs to provide CVC details for the booking.

`require_booker_address` <mark style="color:orange;">**boolean**</mark>

Specifies whether the guests must provide a contact address.

`require_booker_contact_number` <mark style="color:orange;">**boolean**</mark>

Specifies whether the guests must provide a contact telephone number.

`auto_replenish` <mark style="color:orange;">**boolean**</mark>

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` <mark style="color:orange;">**boolean**</mark>

Specifies whether to reopen closed rooms after a cancellation. This will open a closed room after a cancellation is received.

***

`long_stay` <mark style="color:orange;">**object**</mark>

Contains whether property accepts a stay longer than 30 nights.

`enabled` <mark style="color:orange;">**boolean**</mark>

Specifies whether the property has a long stay option enabled.

`max_length_of_stay` <mark style="color:orange;">**integer**</mark>

Specifies the maximum number of days allowed to stay at the property.&#x20;

{% hint style="info" %}
Can be one of the values: 45, 60, 75, 90.
{% endhint %}

`pricing_type` <mark style="color:orange;">**string**</mark>

Specifies the property's pricing type.&#x20;

{% hint style="info" %}
Can be `Standard`, `LOS` or `OBP`.&#x20;
{% endhint %}

`allow_smoking` <mark style="color:orange;">**boolean**</mark>

Specifies whether the property allows smoking.

`view_cc_details` <mark style="color:orange;">**boolean**</mark>

Specifies whether a trusted property can view the guest's credit card details on Extranet.

***

`pets` <mark style="color:orange;">**object**</mark>

Contains settings related to pets policy.

`pets_allowed`  <mark style="color:orange;">**string**</mark>

Specifies whether pets are allowed at the property.&#x20;

{% hint style="info" %}
Possible values are:\
\- `PETS_ALLOWED`,\
\- `PETS_NOT_ALLOWED` and\
\- `PETS_ALLOWED_ON_REQUEST`.
{% endhint %}

`pets_price_type` <mark style="color:orange;">**string**</mark>

Specifies pets price type option for the property.&#x20;

{% hint style="info" %}
Possible values are:\
\- `FREE`\
\- `CHARGES_MAY_APPLY`.
{% endhint %}

***

`damage_policy` <mark style="color:orange;">**object**</mark>

Contains settings related to damage policy.

`amount` <mark style="color:orange;">**integer**</mark>

Specifies the amount on which the damage deposit or programme is applicable for

`policy_type` <mark style="color:orange;">**string**</mark>

Specifies the policy that is applicable.&#x20;

{% hint style="info" %}
Possible values are:\
\- `NONE`,\
\- `HANDLED_BY_PROPERTY` and\
\- `HANDLED_BY_BOOKING_COM`.
{% endhint %}

`damage_programme_terms_agreed` <mark style="color:orange;">**boolean**</mark>

Specifies if you agree to the terms for the damage programme.&#x20;

{% hint style="info" %}
To view damage deposit terms, you can view [Retrieve Property Settings Damage Programme](broken-reference).
{% endhint %}

***

`standard_phrases` <mark style="color:orange;">**array of strings**</mark>

Contains settings related to standard phrases. You can send 1 or multiple standard phrases that you want to enable or remove.

***

`accepted_payment_types` <mark style="color:orange;">**object**</mark>

Contains settings related to payment methods.

`codes` <mark style="color:orange;">**array of integers**</mark>

Specifies the list of supported payment methods.

***

`children_policies` <mark style="color:orange;">**object**</mark>

Contains whether a property accepts children.&#x20;

{% hint style="info" %}
You can specify the following: the minimum age the children are welcome and additional rules for existing/extra bed or crib.
{% endhint %}

`allow_children` <mark style="color:orange;">**boolean**</mark>

Specifies whether the property admits adults and children, or only adults.

`min_age` <mark style="color:orange;">**integer**</mark>

Specifies the minimum age of children allowed to stay at the property.

`policy_rules` <mark style="color:orange;">**array of objects**</mark>

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` <mark style="color:orange;">**string**</mark>

Specifies the rule type for which this rule applies.&#x20;

{% hint style="info" %}
Possible values are:\
\- `EXISTING_BED`\
\- `EXTRA_BED`\
\- `CRIB`\
\- `EXTRA_BED_FOR_ADULTS`.
{% endhint %}

`from_age` <mark style="color:orange;">**integer**</mark>

Specifies the minimum age for the children policy to apply. In combination with `to_age` it becomes an age range.

`to_age` <mark style="color:orange;">**integer**</mark>

Specifies the maximum age for the children policy to apply.

`price_type` <mark style="color:orange;">**string**</mark>

Specifies if the rule is `FREE`, `ADULT_PERCENTAGE`, or `FIXED` price.

`price_mode` <mark style="color:orange;">**string**</mark>

Specifies the unit of time on which the charge is calculated.&#x20;

{% hint style="info" %}
Can be `PER_NIGHT` or `PER_STAY`.
{% endhint %}

`price` <mark style="color:orange;">**integer**</mark>

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` <mark style="color:orange;">**object**</mark>

Specifies the details of the company that owns/manages the property.

`legal_name` <mark style="color:orange;">**string**</mark>

Specifies the legal name of the company.

`contact_person` <mark style="color:orange;">**string**</mark>

Specifies the full name of the contact person.

`address` <mark style="color:orange;">**string**</mark>

Specifies the company address.

`notification_channel` <mark style="color:orange;">**string**</mark>

Specifies the channel that the company prefers to be notified for invoice related information.&#x20;

{% hint style="info" %}
Can be one of: POSTAL\_MAIL or EMAIL.
{% endhint %}

`country_code` <mark style="color:orange;">**string**</mark>

Specifies the country Code.&#x20;

Should be valid ISO code.

`city` <mark style="color:orange;">**string**</mark>

Specifies the city name.

`postal_code` <mark style="color:orange;">**string**</mark>

Specifies the postal/Zip code.

***

`booking_model` <mark style="color:orange;">**object**</mark>

Contains whether the property can have request to book option.

`type` <mark style="color:orange;">**string**</mark>

Specifies the booking model type of the property. Can be RTB (request to Book) or IB (instant booking).

***

#### <mark style="color:red;">Errors</mark>

<mark style="color:red;">**Sample Error Response 1**</mark>

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

<mark style="color:red;">**Sample Error Response 2**</mark>

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

<mark style="color:red;">**Sample Error Response 3**</mark>

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

***

<mark style="color:yellow;">**Error Response Body Elements**</mark>

`Status` <mark style="color:orange;">**string**</mark>

Indicates the result of the API call, which will be always `"Fail"` in case of an error response.

***

`Error` <mark style="color:orange;">**array**</mark>

Array that contains details about any errors that occurred during the API call. Each object in the `Errors` array contains the following properties:

`Code` <mark style="color:orange;">**string**</mark>

Specific error code that helps identify the type of error.

{% hint style="info" %}
For example: `"400"` indicates a bad request.
{% endhint %}

`ShortText` <mark style="color:orange;">**string**</mark>

A short description of the error.

***

`Message` <mark style="color:orange;">**string**</mark>

A message providing more information about the error.
