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
  • Response

Was this helpful?

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

Product Modify

PreviousProduct CreateNextProduct Remove

Last updated 3 months ago

Was this helpful?

This endpoint is used to modify the details of a hotel product in the channel’s system.


Endpoint

POST

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

action string (Required)

Specifies the action to be performed. In this case, it is "modify", meaning the request is to modify an existing hotel product or related information.

hotel_id string (Required)

The unique identifier of the hotel in the system. It associates the hotel product with a specific hotel.

channel_hotel_id string (Required)

The identifier of the hotel in the channel's system. This links the hotel product to the respective channel.

channel_room_id string (Required)

The identifier of the specific room type in the channel’s system. This identifies the exact room type being modified.

channel_rate_id string (Required)

The identifier of the rate plan for the specified room type in the channel’s system. It defines the pricing structure for the room.

mealplan_code string (Optional)

The code for the meal plan associated with the room. If not provided, a default meal plan may be used.

min_advanced_booking_offset string (Optional)

Defines the minimum advance booking time required for the room. "P2D" means 2 days in advance. The booking should be made at least 2 days before check-in.

max_advanced_booking_offset string (Optional)

Specifies the maximum time in advance that the room can be booked. "P3D" means bookings can be made up to 3 days before check-in.

cancellation_policy_id string (Optional)

The unique identifier for the cancellation policy. If not provided, it may either be left to the system's default or handled by an override policy.

override_policy object (Optional)

Defines any custom policies that should override the default policies for specific dates or conditions.

cancellation_policy_name string (Optional)

The name of the custom cancellation policy to be applied for the given dates.

book_dates array of objects (Optional)

A list of date ranges when the override policy should apply.

  • start_date: "2024-11-10"

  • end_date: "2024-11-15"

These date ranges define when the cancellation policy or other overrides will be active.

active_week_days array of strings (Optional)

A list of active weekdays when the override policy is applicable. This helps to restrict the policy to specific days of the week.

Possible values are: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, and Sunday.

value_added_services object (Optional)

Specifies any additional services or packages that are included with the hotel product.

name string (Optional)

The name of the value-added service package offered with the hotel product.

services array of objects (Optional)

A list of individual services that are part of the value-added package.

service_id integer

This ID refers to the specific service offered in the value-added package.


Sample Request

{
    "action": "modify",
    "hotel_id": "AWSTEST",
    "channel_hotel_id": "12962495",
    "channel_room_id": "1296249501",
    "channel_rate_id": "49681937",
    "mealplan_code": "19",
    "min_advanced_booking_offset": "P2D",
    "max_advanced_booking_offset": "P3D",
    "cancellation_policy_id": "",
    "override_policy": {
        "cancellation_policy_name": "PTT_BREAKFAST_INCLUDED",
        "book_dates": [
            {
                "start_date": "2024-11-10",
                "end_date": "2024-11-15"
            },
            {
                "start_date": "2024-11-20",
                "end_date": "2024-11-30"
            }
        ],
        "active_week_days": [
            "Monday",
            "Tuesday"
        ]
    },
    "value_added_serivces": {
        "name": "additional package",
        "services": [
            {
                "service_id": 1001
            }
        ]
    }
}

Response

Sample Success Response

{
    "Status": "Success",
    "Data": [],
    "Message": "Product Updated successfully",
    "Ruid": "UmFuZG9tSVYkc2RlIyh9Ye5eXmDmhbU/lJ3oZTYqKygl2YmmIvCZ7SsqWDRvnH9FWwZqTQRhyElUfNUBy9NrH7hKGo/SPIzE"
}

Success Response Body Elements

Status string

Indicates the result of the API call.

Will be "Success" for successful operations.


Data object

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


Message string

A message receives within the response body. This will generally be an empty string if no additional information is needed.


Ruid string

Specifies the unique request ID.

You can share this ID with Booking.com customer support when you run into an issue. This can help in understanding what went wrong.

Errors

Sample Error Response 1 - Validation Error Response

{
    "Status": "Fail",
    "Errors": [
        {
            "Code": "496",
            "ShortText": "action attribute is required"
        },
        {
            "Code": "400",
            "ShortText": "hotel_id: Invalid HotelCode ('')"
        },
        {
            "Code": "572",
            "ShortText": "channel_hotel_id - is invalid or not found!"
        },
        {
            "Code": "849",
            "ShortText": "channel_room_id - is invalid or not found!"
        },
        {
            "Code": "850",
            "ShortText": "channel_rate_id - is invalid or not found!"
        }
    ],
    "Message": "",
    "Ruid": "",
    "Type": ""
}

Sample Error Response 2 - Booking.com Error Response

{
    "Status": "Fail",
    "Errors": [],
    "Message": "MinAdvancedBookingOffset: Value is not a ota_duration (String representing OTA duration: P5D3H), found '2D', MaxAdvancedBookingOffset: Value is not a ota_duration (String representing OTA duration: P5D3H), found '3D', MealPlanCode: Value should be one of [ 0, 1, 10, 11, 12, 14, 15, 16, 17, 18, 19, 2, 20, 21, 22, 23, 24, 3, 4, 5, 6, 7, 8, 9 ], found '1954464'",
    "Ruid": "UmFuZG9tSVYkc2RlIyh9Ye5eXmDmhbU/ykdNJBjpywM7XEdM6xKcMfE5VTNSC8OOTER4+X35eObe8bKJbTGWrcFolLHc80gr"
}

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.