Retrieve Booking Settings

This endpoint retrieves the Airbnb booking settings for a specified hotel and listing.

Endpoint

POST

https://connect-sandbox.su-api.com/SUAPI/jservice/airbnb/bookingsetting/retrieve

---

Header

-app-id: App Id
Authorization: Basic Authorization
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. Required for authentication.
Content-Type	string	Yes	Must be set to application/json.

---

Attributes

hotelid alphanumeric (Required)

Specifies the required node hotelid contains the IT provider's hotel id for which the provider wishes to add mapping information.

---

channelhotelid alphanumeric (Required)

Specifies the unique hotel ID used in the external distribution channel or PMS (Property Management System).

---

listingid numeric (Required)

listing id of the property allocated by airbnb.

---

Request

{
  "hotelid": "SUTEST01",
  "channelhotelid": "511039958",
  "listingid": "1541919118065328804"
}

---

Response

---

Success Response

{
  "Status": "Success",
  "Data": {
    "booking_setting": {
      "guest_controls": {
        "allows_events_as_host": false,
        "allows_infants_as_host": true,
        "allows_pets_as_host": false,
        "allows_children_as_host": true,
        "pet_capacity": 0,
        "allows_smoking_as_host": false
      },
      "listing_id": "1541919118065328804",
      "instant_book_welcome_message": "Welcome to our Beautiful resort",
      "check_in_time_end": "FLEXIBLE",
      "check_in_time_start": "15",
      "listing_expectations_for_guests": [
        {
          "type": "requires_stairs"
        },
        {
          "type": "limited_parking"
        }
      ],
      "instant_booking_allowed_category": "everyone",
      "cancellation_policy_settings": {
        "lts_cancellation_policy_id": "CANCEL_LONG_TERM_WITH_GRACE_PERIOD",
        "eligible_cancellation_policies": [
          "flexible",
          "firm_14",
          "better_strict_with_grace_period",
          "super_strict_30",
          "super_strict_60",
          "moderate"
        ],
        "cancellation_policy_category": "flexible"
      },
      "check_out_time": 11
    }
  },
  "Message": "Booking setting retrieved successfully"
}

---

Success Response - Body Elements

---

Data object

Contains the booking setting information returned by the API.

---

booking_setting object

Holds all booking-related configuration for the listing.

---

guest_controls object

Defines rules for which guests or activities are allowed.

---

allows_events_as_host boolean

Indicates if events are allowed at the property.

---

allows_infants_as_host boolean Indicates if infants are allowed.

---

allows_pets_as_host boolean

Indicates if pets are allowed.

---

allows_children_as_host boolean

Indicates if children are allowed.

---

pet_capacity integer

Maximum number of pets allowed.

---

allows_smoking_as_host boolean

Indicates if smoking is allowed at the property.

---

listing_id string

Listing ID of the property.

---

instant_book_welcome_message string

Welcome message sent to guests for instant bookings.

---

check_in_time_end string

Indicates the end of the check-in time window.

---

check_in_time_start string

Indicates the start of the check-in time window.

---

listing_expectations_for_guests array

List of expectations that guests must follow.

---

type string

Specifies the type of guest expectation.

---

instant_booking_allowed_category string

Indicates who is allowed to instantly book the listing.

---

cancellation_policy_settings object

Contains cancellation policy configuration details.

---

lts_cancellation_policy_id string

Long-term stay cancellation policy identifier.

---

eligible_cancellation_policies array

List of available cancellation policies that can be applied.

---

cancellation_policy_category string

The selected cancellation policy category.

---

check_out_time integer

The designated check-out time for guests.

---

Message string

The message in the response.

---

Error Response

Error 1

{
  "Status": "Fail",
  "Errors": [
    {
      "Code": "981",
      "ShortText": "channelhotelid is not defined or invalid value"
    }
  ]
}

Error 2

---

Error Response - Body Elements

Status string

Indicates the result of the API call.

Will be always "Fail" in case of an error response.

---

Errors object

The response error, the root element.

---

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

The message in the response.