Product List
This endpoint allows you to fetch a list of hotel products, including details about room types, rate plans, value-added services, policies, and more.
Endpoint
POST
Header
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)
Specifies the hotel ID for the property.
channel_hotel_id string (Required)
Specifies the channel-specific hotel ID for the property.
policy_override_start_date string (Optional)
Start date for overriding policies.
policy_override_end_date string (Optional)
End date for overriding policies. Example:
NOTE
The
policy_override_start_dateandpolicy_override_end_datekeys are utilized when retrieving product list data that includes override policy content. It is mandatory to provide values for bothpolicy_override_start_dateandpolicy_override_end_datein such cases. See the fields above.
Sample Request
Response
Sample Success Response
Success Response Body Elements
Status string
Indicates the result of the API call.
Message string
A message describing the outcome.
Ruid string
A unique request identifier.
Data object
Contains the actual response data.
hotel_products object
Contains information about the hotel products.
channel_hotel_id integer
The unique identifier for the hotel in the channel's system.
hotel_product array
A list of hotel products available.
hotel_product object
Contains information for the first hotel product.
room_types object
Specifies the details about room types.
room_type object
Details for the room type in the product.
channel_room_id integer
The unique identifier for the room type.
max_occupancy integer
The maximum occupancy allowed for the room.
rate_plans object
Describes the rate plans available for the room type.
rate_plan object
Details of a specific rate plan associated with the room type.
channel_rate_id integer
The unique identifier for the rate plan.
value_add_inclusions object
Describes the additional inclusions in the rate plan.
meal_plan object
Information about meal plans included in the booking.
mealplan_code integer
The code for the meal plan included.
policy_info object
Information related to the policies that apply to the hotel product.
booking_rules object
Describes any booking rules.
booking_rule object
This object contains specific rules regarding the booking conditions for a particular hotel product.
min_advanced_booking_offset string
Defines the minimum number of days a customer must book the room in advance.
Example: "P2D" means the customer must book at least 2 days before check-in.
max_advanced_booking_offset string
Defines the maximum number of days a customer can book the room in advance.
If empty, no limit is specified.
release_time_of_day_start string
Specifies the time of day when the room may be released if the booking isn't confirmed (if applicable). Empty means no specific time is set.
release_time_of_day_end string
Specifies the cut-off time by which the room must be booked.
Empty means no specific end time is defined.
cancel_policy object
Specifies the cancellation policy details.
cancel_penalty object
Describes the penalty for cancellation.
policy_code integer
The code for the cancellation policy.
policy_id integer
The unique identifier for the cancellation policy.
policy_name string
The name of the cancellation policy.
guarantee_payment_policy object
Details about the guarantee payment policy.
guarantee_payment object
This is the main object containing details about the guarantee payment policy for the hotel room or booking.
effective_from string
This parameter specifies when the guarantee payment policy becomes effective. It typically represents the date and/or time from which the payment guarantee rule applies.
pre_payment_required boolean
Whether pre-payment is required.
value_added_services object
Lists the value-added services included with the room product.
name string
Name of the value-added services package.
value_added_service array
A list of individual services offered as part of the package.
service_id integer
The unique identifier for the service.
amount string
The amount for the service.
percentage string
The percentage of the value-added service charge.
tpa_extensions object
Extensions for additional policy or pricing details.
pricing_type object
Describes the type of pricing for the hotel product.
value string
The pricing type.
price1 boolean
Indicates if the product follows the standard pricing rule.
hotel_product object
Contains information for the second hotel product.
child_rate boolean
Indicates whether there is a child rate available.
rate_relation object
Specifies any relations with other rates.
parent_rateplan_code string
The code of the parent rate plan from which this rate plan is derived.
percent string
Specifies the percentage difference compared to the parent rate plan.
hotel_product object
Contains information for the third hotel product.
booking_rules object
Describes any booking rules.
min_advanced_booking_offset string (date)
The minimum advanced booking offset.
override_policies object
Describes any override policies for specific date ranges.
policy_name string
Name of the override policy.
book_dates array
The list of date ranges when the override policy applies.
start string (date)
The start date of the bookable range.
end string (date)
The end date of the bookable range.
Errors
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.
Last updated
Was this helpful?