Create / Update Property Settings - Specific Setting

When a user changes the pricing type (for example, from room-based to OBP or vice versa), the system should update both the property settings and all associated rate plans accordingly, ensuring that the pricing structure reflects the new type, either by pricing based on rooms or occupancy, across all rooms and platforms.


Endpoint

POST

https://connect-sandbox.su-api.com-/SUAPI/jservice/bdc/property/settings/set
-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.


property_settings object (Optional)

Contains multiple various settings related to the property.

pricing_type enum (Optional)

Specifies the property's pricing type. Can be Standard or OBP.

Here, pricing_type is OBP.


Sample Request

{
   "hotel_id": "AWSTEST",
   "channel_hotel_id": "12837615",
   "property_settings": {
       "pricing_type": "OBP"
   }
}

Response

Sample Success Response

{
  "Status": "Success",
  "Message": "Successfully done",
  "Warnings": "",
  "Ruid": "e527c45a-f23a-4ee4-beb2-7d21f7699b1b",
  "data": {
    "property_settings": {
      "success": true
    }
  }
}

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

Indicates whether the property settings were successfully updated. Here, it is true.

success boolean

Indicates whether the property settings are created/modified successfully.

Possible values:

true - Success

false - Fail


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

{
   "Errors": [
       {
           "Code": "611",
           "ShortText": "property_settings - pricing_type is invalid or not found!"
       }
   ],
   "Status": "Fail"
}

Sample Error Response 4

{
   "Status": "Fail",
   "Errors": [],
   "Message": "Invalid value: pricing_type settings",
   "Ruid": "909864b8-5509-4a4e-98d2-6a52dfef7466",
   "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.

Last updated

Was this helpful?