Su API Documentation
  • Su Overview
    • Su API Introduction
  • Su Channel Manager
    • Getting Started
      • Certification
      • Authentication
    • Content
      • Property
      • Room Type
      • Rate Plan
      • Listing
        • Property Listing
        • Room Type Listing
        • Rate Plan Listing
        • Delete Property Listing
      • Image API
        • Create Images
        • Retrieve Images
        • Associate Images
    • Booking.com Content API
      • Booking.com
        • Contract - Introduction
          • Create Contract
          • Link/Retrieve Contract
          • Update Contract
          • Resend Contract
        • Property Management
          • Property Statuses
          • Property Detail
            • Create Property
            • Retrieve Property
            • Update Property
          • Contact Details
            • Set Contact
            • Retrieve Contact
            • Contact Profile Types
          • Property Settings
            • Retrieve Property Settings
            • Retrieve Property Settings Damage Programme
            • Retrieve City Tax Category For Property Settings
            • Create / Update Property Settings
            • Create / Update Property Settings - Specific Setting
          • Property Profile
            • Set Profile
            • Retrieve Property Profile
            • Set Hotelier Message
            • Retrieve Hotelier Message
            • Remove Hotelier-Message
          • Booking.com Property Status
            • Property Status Check
            • Property Status Open
            • Property Status Closed
          • Property Key Collection
            • Set CheckIn Methods
            • Retrieve CheckIn Method
            • Retrieve All Stream Variation
        • Images
          • Create Image
          • Retrieve All Images
          • Update Image Tags
          • Delete Image
          • Retrieve Associate Images
          • Associate Image
          • Unassociate Image
          • Ordering Image
          • Smart Ordering Image
          • Show Image
          • Retrieve Property Pending Photos based on photo-batch-id
          • Retrieve Image Tags
        • Facilities
          • Create/Update Facility
          • Retrieve Set Facility of Property and Room
          • Retrieve Supported Facilities
        • Property/Room Charges
          • Retrieve Property Charge Meta
          • Retrieve Property Charges
          • Retrieve Room Charges
          • Create Property Charges
        • Rate Plan
          • Set Rateplan
          • Retrieve Rateplan
      • Room API
        • Room Meta API
        • Room Set (Create/Update) API
        • Room Retrieve API
        • Room Deactivate API
      • Policies API
        • Create/Update Policies
        • Retrieve Policies
      • Bathroom API
        • Set Bathroom (Create and Update)
        • Remove/Disable Bathroom
        • Retrieve Bathroom
      • Product API
        • Product Meta
        • Product List
        • Product Create
        • Product Modify
        • Product Remove
        • Product Map Create (Room Based)
        • Product Map Modify (Room Based)
        • Product Map Create (Occupancy Based)
        • Product Map Modify (Occupancy Based)
        • Product Unmap
      • Property and Room License
        • Property License Retrieve All Rule (Without property id)
        • Property License Retrieve Rule (With property id)
        • Sending License Information of Property
        • Retrieve License Information of Property
        • Sending License Information of Room
        • Retrieve License Information of Room
      • BCIO (Booking.com Check-In / Check-Out Times)
      • PCT (Property Class Type Codes)
      • BCJT (Booking.com Job Titles)
      • PTT (Phone Technology Type Codes)
      • BCL (Booking.com Language Codes)
      • Currency Codes/Names
      • Country Codes/Names
      • BCPT (Booking.com Payment Type Codes)
    • Rates and Availability
    • Inventory Control
    • Reservations
      • New/Modified/Requested/Cancelled Retrievals
        • Request for Reservation Information
        • Response of Reservation Information
      • Reservation Using Push API
        • Reservations Notification Push
        • PUSH API Method
      • Reservation Notification
      • Request Booking
        • Accept/Confirm Request Booking
        • Deny/Cancel Request Booking
      • Booking Repull
        • List of Bookings
        • Refetch Booking
    • Logs
      • Update Logs
      • Failed Channel Logs
      • Rates & Inventory Logs (Future Date)
      • Bulk Rates & Inventory Logs (Future Date)
      • Resync OTA Updates (Failed)
      • OTA Rateplan Pull API
    • Users
      • Global Users
      • Chain Users
    • Channel Mapping Widget API
      • Generate a Token
      • Mapping Script
    • Reviews
    • Messaging
    • Reporting
      • Reporting - No Show (Booking.com & Goibibo)
      • Reporting - Invalid CC (Booking.com)
      • Reporting - Cancellation Due to Invalid CC (Booking.com)
      • Bulk ARI Update
      • Marketing Insight API - Booking.com
    • AirBnB
      • Cancel Reservation
        • Retrieve AirBnB Cancel Reservation Details API
        • Final AirBnB Cancel Reservation API
      • Notification
      • Trip Issue
    • My Booking Site
      • Confirm Reservation
      • Cancel Reservation
  • Su Token
    • Su Token - Introduction
    • Su Token - Authentication
    • Partner
    • Card
      • Card API
      • Card View API
      • Charge API
      • Card Collection
        • Get CC Collection (Generate Link)
        • Check Status of CC Collection
      • WIDGET
        • CC Collection Using Widget
  • Codes
    • Room Type Codes
    • Language Codes
    • Country Codes
    • Phone Technology Type Codes
    • Meal Plan Codes
    • Currency Codes
    • Channel or OTA Codes
    • Credit Card Type Codes
    • Time Zones
    • Error Codes
  • Versioning
  • Glossary of Terms
Powered by GitBook

STAAH Limited. 2024 © All Rights Reserved.

On this page
  • Endpoint
  • Sample Request
  • Examples
  • Response

Was this helpful?

Export as PDF
  1. Su Channel Manager
  2. Booking.com Content API
  3. Booking.com
  4. Facilities

Create/Update Facility

PreviousFacilitiesNextRetrieve Set Facility of Property and Room

Last updated 3 months ago

Was this helpful?

This endpoint allows you to create or update the facilities of a property or a specific room within a property. You can specify the availability and additional details such as parking information, restaurant details, internet connectivity, and more. The request body accepts various facility details, and in case of updates, you can provide an instance_id to modify an existing instance.


Endpoint

POST

https://connect-sandbox.su-api.com/SUAPI/jservice/bdc/facilities/set

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. Required for authentication.

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.


channel_room_id string (Optional)

If you are setting up the facility for the particular room then it's required otherwise this field is optional.

A unique identifier for the room within the specific channel (for example, a property management system or booking platform). This ID allows the system to identify and update the facilities for a particular room in the hotel.


facilities array (Required)

An array of objects, each representing a facility for the property (or individual rooms). The array defines the available facilities and their details such as availability, instances, and configuration.

facility_id string (Required)

The unique identifier for a facility type (e.g., parking, restaurant, pool, etc.).

is_available boolean (Required)

Indicates whether this facility is available.

instances array (Optional)

A list of instances under this facility type. Each instance may have specific configurations.

instance_id string (Optional)

The unique identifier for a particular instance (used for updates).

This is the unique ID for a specific instance of the parking facility that can be updated.


Parking Facilities

parking_details object (Required for parking facilities)

Details about the parking setup.

name string (Optional)

The name of the parking lot.

For example, "Basement Parking"

parking_location enum (Optional)

The location of the parking facility.

Possible values are:

  • NEARBY

  • ON_SITE

  • UNKNOWN_LOCATION

parking_access enum (Optional)

Indicates access restrictions. For example, "ONLY_GUESTS" means that only hotel guests can use the parking.

parking_reservation enum (Optional)

Specifies if reservation is needed for parking.

Possible values are:

  • NOT_NEEDED

  • REQUIRED

payment_details object (Optional)

Defines the payment mode for the parking service.

charge_mode enum (Optional)

The charge mode for the facility, such as "FREE" or "PAID".


Temporarily Closed Facilities

temporarily_closed_details object (Required for Temporary Closed Facilities)

Contains a list of periods when this facility is closed.

closed array

An array of closed periods.

start_date epoch_seconds

The start of the closed period (in Unix timestamp format).

end_date epoch_seconds

The end of the closed period (in Unix timestamp format).


Other Facility Types

indicates that this facility is available.


Surcharge Details

surcharge_details object (Optional)

Specifies surcharge details for this facility.

surcharge_type string

Defines the type of surcharge applied. For example, "DEFAULT" might be the standard surcharge for this facility.


Facility Not Available

Indicates that this facility is currently not available.


Scheduled Availability

schedule_details object

Defines the operating schedule for this facility.

schedule object

A list of schedule periods.

from object

The start time of the schedule period.

to object

The end time of the schedule period.

day_of_week enum

The day of the week on which this schedule applies.

For example, SUNDAY

Possible values are:

  • MONDAY

  • TUESDAY

  • WEDNESDAY

  • THURSDAY

  • FRIDAY

  • SATURDAY

  • SUNDAY


On-site Details

on_site_details object

Specifies whether the facility is on-site or off-site.

onsite_type enum

Defines whether the facility is "ON_SITE" or "OFFSITE".

Possible values are:

  • ON_SITE

  • OFFSITE


Restaurant Details

restaurant_details object

Contains details about the restaurant.

name string

The name of the restaurant.

meal_types_list array

A list of meal types provided, such as HALAL or VEGETARIAN.

cuisines_list array

A list of cuisines offered.

For example, AUSTRALIAN, GERMAN, INTERNATIONAL, etc.


Swimming Pool Details

swimming_pool_details object

Contains information about the swimming pool.

name string

The name of the pool.

swimming_pool_type enum

Defines the type of the swimming pool.

Possible values are:

  • INDOOR

  • OUTDOOR

  • INDOOR_AND_OUTDOOR


Internet Details

internet_details object

Contains details about internet availability.

area enum

Specifies the area where internet is available.

Possible values are:

  • ENTIRE_PROPERTY

  • ROOM_ONLY

  • SPECIFIED_AREAS

type enum

Specifies the type of internet service.

Possible values are:

  • WIFI

  • LAN


Sample Request

Request Body to Set Property Facility

{
   "hotel_id": "new1",
   "channel_hotel_id": "12915674",
   "facilities": [
       {
           "facility_id": "2",
           "is_available": true,
           "instances": [
               {
                   "instance_id": 95498498,
                   "parking_details": {
                       "name": "Basement Parking",
                       "parking_location": "NEARBY",
                       "parking_access": "ONLY_GUESTS",
                       "parking_reservation": "NOT_NEEDED"
                   },
                   "payment_details": {
                       "charge_mode": "FREE"
                   }
               },
               {
                   "parking_details": {
                       "name": "Basement2 Parking",
                       "parking_location": "ON_SITE",
                       "parking_access": "ONLY_GUESTS",
                       "parking_reservation": "NOT_NEEDED"
                   },
                   "payment_details": {
                       "charge_mode": "FREE"
                   }
               }
           ]
       },
       {
           "facility_id": "7",
           "is_available": true,
           "instances": [
               {
                   "temporarily_closed_details": {
                       "closed": [
                           {
                               "start_date": {
                                   "epoch_seconds": 123648588
                               },
                               "end_date": {
                                   "epoch_seconds": 123648588
                               }
                           },
                           {
                               "start_date": {
                                   "epoch_seconds": 223648588
                               },
                               "end_date": {
                                   "epoch_seconds": 223648588
                               }
                           }
                       ]
                   }
               }
           ]
       },
       {
           "facility_id": "8",
           "is_available": true
       },
       {
           "facility_id": "9",
           "is_available": true,
           "instances": [
               {
                   "surcharge_details": {
                       "surcharge_type": "DEFAULT"
                   }
               }
           ]
       },
       {
           "facility_id": "10",
           "is_available": false
       },
       {
           "facility_id": "11",
           "is_available": true,
           "instances": [
               {
                   "schedule_details": {
                       "schedule": [
                           {
                               "from": {
                                   "hours": 23,
                                   "minutes": 58
                               },
                               "to": {
                                   "hours": 23,
                                   "minutes": 59
                               },
                               "day_of_week": "SUNDAY"
                           }
                       ]
                   }
               }
           ]
       },
       {
           "facility_id": "70",
           "is_available": true,
           "instances": [
               {
                   "on_site_details": {
                       "onsite_type": "OFFSITE"
                   }
               }
           ]
       },
       {
           "facility_id": "3",
           "is_available": true,
           "instances": [
               {
                   "restaurant_details": {
                       "name": "jfjk",
                       "meal_types_list": [
                           "HALAL"
                       ],
                       "cuisines_list": [
                           "AUSTRALIAN",
                           "GERMAN",
                           "RUSSIAN",
                           "LOCAL",
                           "ASIAN",
                           "INTERNATIONAL"
                       ]
                   }
               }
           ]
       },
       {
           "facility_id": "433",
           "is_available": true,
           "instances": [
               {
                   "swimming_pool_details": {
                       "name": "labela",
                       "swimming_pool_type": "INDOOR_AND_OUTDOOR"
                   }
               },
               {
                   "swimming_pool_details": {
                       "name": "updatedlabela",
                       "swimming_pool_type": "INDOOR_AND_OUTDOOR"
                   }
               }
           ]
       },
       {
           "facility_id": "47",
           "is_available": true,
           "instances": [
               {
                   "internet_details": {
                       "area": "ENTIRE_PROPERTY",
                       "type": "WIFI",
                       "wifi_info": {
                           "network_name": "Hathway",
                           "speed_download": "50.25",
                           "speed_upload": "60.25"
                       }
                   }
               }
           ]
       }
   ]
}

Request Body to Set Room Facility

{
   "hotel_id": "new1",
   "channel_hotel_id": "12915674",
   "channel_room_id": "111111",
   "facilities": [
       {
           "facility_id": "8",
           "is_available": true
       },
       {
           "facility_id": "10",
           "is_available": false
       }
   ]
}

Examples

Use the below sample codes to add the provided facilities:

Parking Facilities

{
   "hotel_id": "new1",
   "channel_hotel_id": "12915674",
   "facilities": [
       {
           "facility_id": "2",
           "is_available": true,
           "instances": [
               {
                   "instance_id": 95498498,
                   "parking_details": {
                       "name": "Basement Parking",
                       "parking_location": "ON_SITE",
                       "parking_access": "ONLY_GUESTS",
                       "parking_reservation": "NOT_NEEDED"
                   },
                   "payment_details": {
                       "charge_mode": "FREE"
                   }
               }
           ]
       }
   ]
}

Attributes

parking_details object (Required for parking facilities)

Details about the parking setup.

name string (Optional)

The name of the parking lot.

For example, "Basement Parking"

parking_location enum (Optional)

The location of the parking facility.

Possible values are:

  • NEARBY

  • ON_SITE

  • UNKNOWN_LOCATION

parking_access enum (Optional)

Indicates access restrictions. For example, "ONLY_GUESTS" means that only hotel guests can use the parking.

parking_reservation enum (Optional)

Specifies if reservation is needed for parking.

Possible values are:

  • NOT_NEEDED

  • REQUIRED

payment_details object (Optional)

Defines the payment mode for the parking service.

charge_mode enum (Optional)

The charge mode for the facility, such as "FREE" or "PAID".


Temporarily Closed Facilities

{
   "hotel_id": "new1",
   "channel_hotel_id": "12915674",
   "facilities": [
       {
           "facility_id": "7",
           "is_available": true,
           "instances": [
               {
                   "temporarily_closed_details": {
                       "closed": [
                           {
                               "start_date": {
                                   "epoch_seconds": 123648588
                               },
                               "end_date": {
                                   "epoch_seconds": 123648588
                               }
                           }
                       ]
                   }
               }
           ]
       }
   ]
}

Attributes

temporarily_closed_details object (Required for Temporary Closed Facilities)

Contains a list of periods when this facility is closed.

closed array

An array of closed periods.

start_date epoch_seconds

The start of the closed period (in Unix timestamp format).

end_date epoch_seconds

The end of the closed period (in Unix timestamp format).


Other Facility Types

{
   "hotel_id": "new1",
   "channel_hotel_id": "12915674",
   "facilities": [
       {
           "facility_id": "8",
           "is_available": true
       }
   ]
}

Attributes

indicates that this facility is available.


Surcharge Details

{
   "hotel_id": "new1",
   "channel_hotel_id": "12915674",
   "facilities": [
       {
           "facility_id": "9",
           "is_available": true,
           "instances": [
               {
                   "surcharge_details": {
                       "surcharge_type": "DEFAULT"
                   }
               }
           ]
       }
   ]
}

Attributes

surcharge_details object (Optional)

Specifies surcharge details for this facility.

surcharge_type string

Defines the type of surcharge applied. For example, "DEFAULT" might be the standard surcharge for this facility.


Facility Not Available

{
   "hotel_id": "new1",
   "channel_hotel_id": "12915674",
   "facilities": [
       {
           "facility_id": "10",
           "is_available": false
       }
   ]
}

Attributes

Indicates that this facility is currently not available.


Scheduled Availability

{
   "hotel_id": "new1",
   "channel_hotel_id": "12915674",
   "facilities": [
       {
           "facility_id": "11",
           "is_available": true,
           "instances": [
               {
                   "schedule_details": {
                       "schedule": [
                           {
                               "from": {
                                   "hours": 23,
                                   "minutes": 58
                               },
                               "to": {
                                   "hours": 23,
                                   "minutes": 59
                               },
                               "day_of_week": "SUNDAY"
                           }
                       ]
                   }
               }
           ]
       }
   ]
}

Attributes

schedule_details object

Defines the operating schedule for this facility.

schedule object

A list of schedule periods.

from object

The start time of the schedule period.

to object

The end time of the schedule period.

day_of_week enum

The day of the week on which this schedule applies.

For example, SUNDAY

Possible values are:

  • MONDAY

  • TUESDAY

  • WEDNESDAY

  • THURSDAY

  • FRIDAY

  • SATURDAY

  • SUNDAY


On-site Details

{
   "hotel_id": "new1",
   "channel_hotel_id": "12915674",
   "facilities": [
       {
           "facility_id": "70",
           "is_available": true,
           "instances": [
               {
                   "on_site_details": {
                       "onsite_type": "OFFSITE"
                   }
               }
           ]
       }
   ]
}

Attributes

on_site_details object

Specifies whether the facility is on-site or off-site.

onsite_type enum

Defines whether the facility is "ON_SITE" or "OFFSITE".

Possible values are:

  • ON_SITE

  • OFFSITE


Restaurant Details

{
   "hotel_id": "new1",
   "channel_hotel_id": "12915674",
   "facilities": [
       {
           "facility_id": "3",
           "is_available": true,
           "instances": [
               {
                   "restaurant_details": {
                       "name": "Ocean View Restaurant",
                       "meal_types_list": [
                           "HALAL",
                           "VEGETARIAN"
                       ],
                       "cuisines_list": [
                           "INTERNATIONAL",
                           "ITALIAN",
                           "INDIAN"
                       ]
                   }
               }
           ]
       }
   ]
}

Attributes

restaurant_details object

Contains details about the restaurant.

name string

The name of the restaurant.

meal_types_list array

A list of meal types provided, such as HALAL or VEGETARIAN.

cuisines_list array

A list of cuisines offered.

For example, AUSTRALIAN, GERMAN, INTERNATIONAL, etc.


Swimming Pool Details

{
   "hotel_id": "new1",
   "channel_hotel_id": "12915674",
   "facilities": [
       {
           "facility_id": "433",
           "is_available": true,
           "instances": [
               {
                   "swimming_pool_details": {
                       "name": "Indoor Outdoor Pool",
                       "swimming_pool_type": "INDOOR_AND_OUTDOOR"
                   }
               }
           ]
       }
   ]
}

Attributes

swimming_pool_details object

Contains information about the swimming pool.

name string

The name of the pool.

swimming_pool_type enum

Defines the type of the swimming pool.

Possible values are:

  • INDOOR

  • OUTDOOR

  • INDOOR_AND_OUTDOOR


Internet Details

{
   "hotel_id": "new1",
   "channel_hotel_id": "12915674",
   "facilities": [
       {
           "facility_id": "47",
           "is_available": true,
           "instances": [
               {
                   "internet_details": {
                       "area": "ENTIRE_PROPERTY",
                       "type": "WIFI",
                       "wifi_info": {
                           "network_name": "Hathway",
                           "speed_download": "50.25",
                           "speed_upload": "60.25"
                       }
                   }
               }
           ]
       }
   ]
}

Attributes

internet_details object

Contains details about internet availability.

area enum

Specifies the area where internet is available.

Possible values are:

  • ENTIRE_PROPERTY

  • ROOM_ONLY

  • SPECIFIED_AREAS

type enum

Specifies the type of internet service.

Possible values are:

  • WIFI

  • LAN


Response

Sample Success Response

{
   "Status": "Success",
   "Data": [],
   "Message": "Property Facility Set Successfully",
   "Ruid": "3fab8b18-e0b9-4fd8-8235-ccc39a9d33f8"
}

Success Response Body Elements

Indicates the result of the API call.

Will be "Success" for successful operations.


Data array

An array containing data related to the successful image creation. This typically includes identifiers for the created images.


Message string

Provides a brief message about the outcome. Here, it states "Successfully fetch details," confirming that the requested information was retrieved.


Ruid string

A unique identifier for tracking the request.


Errors

Sample Error Response 1

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

Sample Error Response 2

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

Sample Error Response 3

{
   "Status": "Fail",
   "Errors": [],
   "Message": "Invalid value - [\"instances.parking_details.parking_location\"] - Cannot deserialize value of type `com.booking.accommodation_data.model.facilities.ParkingDetails$Location` from String \"joj\": not one of the values accepted for Enum class: [UNKNOWN_LOCATION, ON_SITE, NEARBY]"
}

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.


Ruid string

A unique identifier for tracking the request.