Product Modify
Last updated
Was this helpful?
Last updated
Was this helpful?
This endpoint is used to modify the details of a hotel product in the channel’s system.
POST
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
.
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.
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.
Status
string
Indicates the result of the API call.
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.
Sample Error Response 1 - Validation Error Response
Sample Error Response 2 - Booking.com Error Response
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.
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.