Managing roomrates

A roomrate is a unique combination of room type, rate plan and conditions. Creating a roomrate helps in creating inventory (availability) and rates (prices) later.

Before creating a roomrate, make sure to create a room type using the OTA_HotelInvNotif endpoint and a rate plan using the OTA_HotelRatePlanNotif endpoint.

You can also specify conditions while creating a roomrate, such as:

Cancellation policy: A cancellation policy is a combination of payment rules, which consists of cancellation, prepayment (also known as guarantee payment) and/or no show rules that is enforced when guests make a reservation. Each payment rule defines how much (in percentage of the total booking price or in nights) and when a guest is charged in case of cancellation or no-show.
Override policy: A cancellation policy that you can set on certain dates to override the policy already assigned to a roomrate.
Booking restrictions: Restrictions such as how far in advance should guests book a reservation for the roomrate to be activated.
Meal plan: A meal plan that is assigned to the roomrate.

Specifying cancellation policy and restrictions

When creating a roomrate, you can specify a cancellation policy that is already created on the property level. If you do not specify a policy, the /ota/OTA_HotelProductNotif endpoint assigns the default policy to the roomrate.

To create and manage policies, use the Policies API. When assigning a policy to a roomrate, you must specify the policy ID.

Policies API is currently in Beta

Note that the Policies API is currently in beta. Make sure to direct any questions during the beta phase to your Booking.com contact person via the appropriate channels.

What is an override policy?

An override policy is a regular cancellation policy that you can use to override the main policy of a roomrate for a specified date range.

Let's say a property uses a flexible policy for most of the year, but they want to use a non-refundable policy for their peak season. That would be a good use case for a policy override.

What are restrictions?

Restrictions enable you to specify when a roomrate with a specific policy is available to book. You can set the following restrictions:

MinAdvancedBookingOffset: Specify the closest available time (year, month, day, hours) until a guest can book a room type relative to their check-in time. In other words, this specifies the moment from when a guest can no longer book the roomrate. The search date is counted as one of the days in the restriction length. For example, if you specify P2D, then the guests cannot specify the next day as a check-in start date.
MaxAdvancedBookingOffset: Specify the maximum time (year, month, day, hours) available in advance to book a room type relative to the check-in time. In other words, this specifies the moment from when a guest can start booking the roomrate. The search date is counted as one of the days in the restriction length. For example, if you specify P2D, then the guests can only book for stays that occur 2 or fewer days relative to the search date.

You can also set the specific hours in which a roomrate is available per day, but this is not recommended.

What is the maximum number of roomrates the API supports?

You can create a maximum of 400 active roomrates for a property.

Creating a roomrate

POST https://supply-xml.booking.com/hotels/ota/OTA_HotelProductNotif

The POST /ota/OTA_HotelProductNotif request enables you to create roomrates for your property.

Creating or updating

To create a roomrate you set ProductNotifType to New. Whereas, to update a roomrate, you set ProductNotifType to Overlay.

Elements for creating a roomrate

Before creating a roomrate using the OTA_HotelProductNotif endpoint, you must have created the following resources.

Mandatory

Property ID
Room type ID - To create a room type using the OTA_HotelInvNotif endpoint, see [Creating room types.] Creating room types
Rate plan ID - To create a rate plan using the OTA_HotelRatePlanNotif endpoint, see [Creating rate plans.] Creating rate plans

Not mandatory but recommended to specify

Policy ID: Assign a policy (combination of cancellation and prepayment terms) to a roomrate. To create a cancellation policy for the property, use the Policies API.
Note: If you do not specify a cancellation policy, the property's default policy is assigned to the roomrate. To identify the default policy of the property, look for <Tags><Default/></Tags> in the GET /policies response.

Optional

Meal plan details: Indicate whether there is a meal plan and if so what that meal plan is.
Override policy
Booking rules

Assigning policies to roomrates

You can only assign existing policies using the /ota/OTA_HotelProductNotif endpoint. That is, policies that were already created for the property.

Specify Policy ID

When assigning a policy to a roomrate, you must specify the policy ID.

To create or update policies for a property, you must:

Use the Policies API, or
Request the property to use their property page on the Booking.com extranet to create a policy.

To assign a policy while creating a roomrate, follow these steps:

Retrieve the property's existing policies and choose a policy to assign to a roomrate. Make sure to note the policy ID for the relevant policy. You can assign the same policy to many roomrates.
[Optional] If the property does not contain a policy with a suitable cancellation penalty, you can create a policy for the property with an appropriate cancellation code. To know more about all the available cancellation codes, see the cancellation policy codes.
Assign the policy by specifying the policy ID.

Roomrate always has a policy assigned

Whenever you create a roomrate, you must either specify a policy to be assigned to the roomrate or the API assigns the default policy to the roomrate. You cannot unassign a policy. You must either reassign a different policy to the roomrate by updating the roomrate or change the policy details that is already assigned to the roomrate.

Assigning an override policy

Assigning an override policy is similar to assigning a policy to a roomrate.

To assign an override policy to a room rate, follow these steps:

Retrieve the property's existing policies and choose a policy to assign to a roomrate.
Assign the overriding policy by specifying the policy ID.

Default policy assignment

If the policy ID is not supplied while creating the room rate, the API assigns the default policy to the roomrate. To identify the default policy, check for the Default tag in the GET /policies response.

Body parameters

The following table describes the elements you must add in the request body:

Element	Attribute	Description	Type	Required/Optional	Notes
`OTA_HotelProductNotifRQ`		Contains the `HotelProducts` array.	object	required
> `HotelProducts`		Contains the `HotelProduct` objects.	array	required
	`HotelCode`	Specifies the unique ID of the property you create roomrates for.	integer	required
>> `HotelProduct`		Contains the roomrate information.	object	required
	`ProductNotifType`	Specifies whether the request is to create a roomrate (`New`) or modify an existing one (`Overlay`).	enum	required	Possible values are `New` and `Overlay`. You must use `New` to create a roomrate.
>>> `RoomTypes`		Contains a `RoomType` object.	object	required
>>>> `RoomType`		Contains the room type information.	object	required
	`RoomTypeCode`	Specifies the room type id.	integer	required
	`MaxOccupancy`	Specifies the maximum occupancy of the roomtype.	integer	optional	Note that specifying this value overrides the value set at the time of creating or updating the roomtype. Also, the pricing type of the roomrate is changed to RLO.
>>> `RatePlans`		Contains a `RatePlan` object.	object	required
>>>> `RatePlan`		Contains the rate plan information.	object	required
	`RatePlanCode`	Specifies the rate plan id.	integer	required
>>> `ValueAddInclusions`		Contains a `MealPlan` object.	object	optional
>>>> `MealPlan`		Contains the meal plan information.	object	optional	If you do not include this element, the default is no meal plan included.
	`MealPlanCode`	Specifies the meal plan id.	integer	optional	To see the list of meal plan codes at Booking.com, see meal plan codes.
>>>> `CancelPolicy`		Contains the `CancelPenalty` object.	object	optional
>>>>> `CancelPenalty`		Contains the policy information.	object	optional
	`PolicyId`	Specifies the policy ID to assign to the roomrate. The ID must belong to one of the policies created for the property. To get a list of all the policies created for a property, see get-policy-details.	integer	optional	If this parameter is not specified, the default policy is assigned to the roomrate. You can identify the default policy with the `<Tags><Default/></Tags>` in the GET /policies response.
>>>> `OverridePolicies`		Contains the `OverridePolicy` objects.	object	optional
>>>>> `OverridePolicy`		Contains the override policy information, which overwrites other policies set for this roomrate on the dates specified within the object.	object	optional
	`PolicyId`	Specifies the ID of the override policy.	integer	optional
>>>>>> `BookDates`		Contains the `BookDate` objects.	object	optional
>>>>>>> `BookDate`		Contains the book date information, which specify the dates when the override policy overwrites other policies.	object	optional
	`Start`	Specifies the start date of the override policy.	string	optional	Follows the format: `YYYY-MM-DD`.
	`End`	Specifies the end date of the override policy.	string	optional	Follows the format: `YYYY-MM-DD`.
>>>>>> `ActiveWeekdays`		Contains the `ActiveWeekDay` objects.	object	optional
>>>>>>> `ActiveWeekday`		Contains the active week day information, which specify the days when the override policy overwrites other policies.	object	optional
	`Day`	Specifies the name of the day of the week.	string	optional	Possible values are: `Monday`, `Tuesday`, `Wednesday`, `Thursday`, `Friday`, `Saturday`, and `Sunday`.
>>>> `BookingRules`		Contains the `BookingRule` objects.	object	optional
>>>>> `BookingRule`		Contains the booking policy information.	object	optional
	`MinimumAdvancedBookingOffset`	Specifies the minimum amount of time in which a room type must be booked relative to midnight (24:00 CE(S)T) of the check-in date start.	string	optional	This is the format used: `P[0-9]+(Y,M,D,H)`. An example is: P5H means the room must be booked before 19:00 on the day before the check-in date.
	`MaximumAdvancedBookingOffset`	Specifies the maximum amount of time in which a room type can be booked relative to midnight (24:00 CE(S)T) of the check-in date start.	string	optional	This is the format used: `P[0-9]+(Y,M,D,H)`. An example is: P14D means the room can be booked a maximum of 14 days before the check-in date.
	`ReleaseTimeOfDayStart`	Specifies the time of the day the room type can start being booked.	HH:MM	optional	This allows time intervals of 15 minutes starting at midnight. For example: 10:15.
	`ReleaseTimeOfDayEnd`	Specifies the time of the day the room type can no longer be booked.	HH:MM	optional	This allows time intervals of 15 minutes starting at midnight. For example: 18:00.

Request body example

The following is a request body example:

<OTA_HotelProductNotifRQ>
    <HotelProducts HotelCode="8011855">
        <HotelProduct ProductNotifType="New">
            <RoomTypes>
                <RoomType RoomTypeCode="801185502" />
            </RoomTypes>
            <RatePlans>
                <RatePlan RatePlanCode="12483478" />
            </RatePlans>
            <ValueAddInclusions>
                <MealPlan MealPlanCode="19" />
            </ValueAddInclusions>
            <PolicyInfo>
                <BookingRules>
                    <BookingRule MinAdvancedBookingOffset="P1D" />
                    <BookingRule MaxAdvancedBookingOffset="P14D" />
                </BookingRules>
                <CancelPolicy>
                    <CancelPenalty PolicyId="342546377"/>
                </CancelPolicy>
                <OverridePolicies>
                    <OverridePolicy  PolicyId="342546364">
                        <BookDates>
                            <BookDate Start="2022-06-06" End="2022-06-29"/>
                            <BookDate Start="2022-07-06" End="2022-07-29"/>
                        </BookDates>
                        <ActiveWeekdays>
                            <ActiveWeekday Day="Friday"/>
                            <ActiveWeekday Day="Saturday"/>
                            <ActiveWeekday Day="Sunday"/>
                        </ActiveWeekdays>
                    </OverridePolicy>
                </OverridePolicies>
            </PolicyInfo>
        </HotelProduct>
    </HotelProducts>
</OTA_HotelProductNotifRQ>

Response body example

The following is a successful response body example:

<OTA_HotelProductNotifRS>
  <Success />
</OTA_HotelProductNotifRS>
<!-- RUID: [UmFuZG9tSVYkc2RlIyh9YUedwgregreg3/GEVjlG+mTXmB9OkyhGlAKEMxDhfrI] -->

The following is a response body example when the limit of 400 roomrates is reached:

<OTA_HotelProductNotifRS>
    <Errors>
        <Error Type="10" Code="733" Status="NotProcessed" ShortText="Limit 400 of number of Room/Rate combinations has reached for hotel 64231."/>
    </Errors>
</OTA_HotelProductNotifRS>
<!-- RUID: [UmFuZG9tSVYkc2RlIyh9YUedwgregreg3/GEVjlG+mTXmB9OkyhGlAKEMxDhfrIcesvuhxkdje8uY] -->

Response body parameters

The following table describes the response elements:

Element	Description	Type	Notes
`OTA_HotelProductNotifRS`	Contains the response data.	object
> `success`	Indicates the success of the request.	object
`ruid`	Specifies the unique ID of the request.	string	You can send this ID to Booking.com customer support if you run into an issue. This can help to understand what went wrong.

Updating a roomrate

POST https://supply-xml.booking.com/hotels/ota/OTA_HotelProductNotif

The POST /ota/OTA_HotelProductNotif request enables you to update roomrates for your property.

When updating a roomrate, make sure to:

Set InvNotifType to Overlay.
Include all existing information: Make sure to specify all existing details of the roomrate. Your update request should look similar to the request you used to create the roomrate, except for the elements you want to update.

Policy overrides are full overlays

When editing policy overrides make sure to specify all existing overrides, including overrides for future dates, on every update.

→ To retrieve the roomrate information, see retrieving roomrates.

→ To retrieve the policy details, see Retrieve the property's existing policies.

Requirements for updating a roomrate

To update a roomrate on Booking.com, the following basic elements are required:

Property ID
Room type ID
Rate plan ID

Body parameters

The following table describes the elements you must add in the request body:

Element	Attribute	Description	Type	Required/Optional	Notes
`OTA_HotelProductNotifRQ`		Contains the `HotelProducts` array.	object	required
> `HotelProducts`		Contains the `HotelProduct` objects.	array	required
	`HotelCode`	Specifies the unique ID of the property you create roomrates for.	integer	required
>> `HotelProduct`		Contains the roomrate information.	object	required
	`ProductNotifType`	Specifies whether the request is to create a roomrate (`New`) or modify an existing one (`Overlay`).	enum	required	Possible values are `New` and `Overlay`. You must use `New` to create a roomrate.
>>> `RoomTypes`		Contains a `RoomType` object.	object	required
>>>> `RoomType`		Contains the room type information.	object	required
	`RoomTypeCode`	Specifies the room type id.	integer	required
	`MaxOccupancy`	Specifies the maximum occupancy of the roomtype.	integer	optional	Note that specifying this value overrides the value set at the time of creating or updating the roomtype. Also, the pricing type of the roomrate is changed to RLO.
>>> `RatePlans`		Contains a `RatePlan` object.	object	required
>>>> `RatePlan`		Contains the rate plan information.	object	required
	`RatePlanCode`	Specifies the rate plan id.	integer	required
>>> `ValueAddInclusions`		Contains a `MealPlan` object.	object	optional
>>>> `MealPlan`		Contains the meal plan information.	object	optional	If you do not include this element, the default is no meal plan included.
	`MealPlanCode`	Specifies the meal plan id.	integer	optional	To see the list of meal plan codes at Booking.com, see meal plan codes.
>>> `PolicyInfo`		Contains the cancellation policy details.	object	optional
>>>> `CancelPolicy`		Contains the `CancelPenalty` object.	object	optional
>>>>> `CancelPenalty`		Contains the policy information.	object	optional
	`PolicyId`	Specifies the policy ID to assign to the roomrate. The ID must belong to one of the policies created for the property. To get a list of all the policies created for a property, see get-policy-details.	integer	optional	If this parameter is not specified, the default policy is assigned to the roomrate. You can identify the default policy with the `<Tags><Default/></Tags>` in the GET /policies response.
>>>> `OverridePolicies`		Contains the `OverridePolicy` objects.	object	optional
>>>>> `OverridePolicy`		Contains the override policy information, which overwrites other policies set for this roomrate on the dates specified within the object.	object	optional
	`PolicyId`	Specifies the ID of the override policy.	integer	optional
>>>>>> `BookDates`		Contains the `BookDate` objects.	object	optional
>>>>>>> `BookDate`		Contains the book date information, which specify the dates when the override policy overwrites other policies.	object	optional
	`Start`	Specifies the start date of the override policy.	string	optional	Follows the format: `YYYY-MM-DD`.
	`End`	Specifies the end date of the override policy.	string	optional	Follows the format: `YYYY-MM-DD`.
>>>>>> `ActiveWeekdays`		Contains the `ActiveWeekDay` objects.	object	optional
>>>>>>> `ActiveWeekday`		Contains the active week day information, which specify the days when the override policy overwrites other policies.	object	optional
	`Day`	Specifies the name of the day of the week.	string	optional	Possible values are: `Monday`, `Tuesday`, `Wednesday`, `Thursday`, `Friday`, `Saturday`, and `Sunday`.
>>>> `BookingRules`		Contains the `BookingRule` objects.	object	optional
>>>>> `BookingRule`		Contains the booking policy information.	object	optional
	`MinimumAdvancedBookingOffset`	Specifies the minimum amount of time in which a room type must be booked relative to midnight (24:00 CE(S)T) of the check-in date start.	string	optional	This is the format used: `P[0-9]+(Y,M,D,H)`. An example is: P5H means the room must be booked before 19:00 on the day before the check-in date.
	`MaximumAdvancedBookingOffset`	Specifies the maximum amount of time in which a room type can be booked relative to midnight (24:00 CE(S)T) of the check-in date start.	string	optional	This is the format used: `P[0-9]+(Y,M,D,H)`. An example is: P14D means the room can be booked a maximum of 14 days before the check-in date.
	`ReleaseTimeOfDayStart`	Specifies the time of the day the room type can start being booked.	HH:MM	optional	This allows time intervals of 15 minutes starting at midnight. For example: 10:15.
	`ReleaseTimeOfDayEnd`	Specifies the time of the day the room type can no longer be booked.	HH:MM	optional	This allows time intervals of 15 minutes starting at midnight. For example: 18:00.

Request body example

The following is a request body example:

<OTA_HotelProductNotifRQ>
    <HotelProducts HotelCode="64231">
        <HotelProduct ProductNotifType="Overlay">
            <RoomTypes>
                <RoomType RoomTypeCode="6423112" />
            </RoomTypes>
            <RatePlans>
                <RatePlan RatePlanCode="12483478" />
            </RatePlans>
            <ValueAddInclusions>
                <MealPlan MealPlanCode="0" />
            </ValueAddInclusions>
            <PolicyInfo>
                <BookingRules>
                    <BookingRule MinAdvancedBookingOffset="P1D" />
                    <BookingRule MaxAdvancedBookingOffset="P14D" />
                </BookingRules>
                <CancelPolicy>
                    <CancelPenalty PolicyId="350338154" />
                </CancelPolicy>
                <OverridePolicies>
                    <OverridePolicy PolicyId="341337684">
                        <BookDates>
                            <BookDate Start="2021-06-06" End="2021-06-29"/>
                            <BookDate Start="2021-07-06" End="2021-07-29"/>
                        </BookDates>
                        <ActiveWeekdays>
                            <ActiveWeekday Day="Friday"/>
                            <ActiveWeekday Day="Saturday"/>
                        </ActiveWeekdays>
                    </OverridePolicy>
                </OverridePolicies>
            </PolicyInfo>
        </HotelProduct>
    </HotelProducts>
</OTA_HotelProductNotifRQ>

Response body example

The following is a successful response body example:

<OTA_HotelProductNotifRS>
  <Success />
</OTA_HotelProductNotifRS>
<!-- RUID: [UmFuZG9tSVYkc2RlIyh9YUedwgregreg3/GEVjlG+mTXmB9Owf2f+Kq=Mzyiykpi6Yx5oKzRKEMxDhfrI] -->

Response body parameters

The following table describes the response elements:

Element	Description	Type	Notes
`OTA_HotelProductNotifRS`	Contains the response data.	object
> `success`	Indicates the success of the request.	object
`ruid`	Specifies the unique ID of the request.	string	You can send this ID to Booking.com customer support if you run into an issue. This can help to understand what went wrong.

Removing roomrates

POST https://supply-xml.booking.com/hotels/ota/OTA_HotelProductNotif

The POST /ota/OTA_HotelProductNotif request enables you to remove a roomrate by disconnecting the room type and rate plan.

Requirements for removing a roomrate

To remove a roomrate from Booking.com, you only need the following elements:

Property id
Room type id
Rate plan id

You must also set ProductNotifType to Remove.

Body parameters

The following table describes the elements you must add in the request body:

Element	Attribute	Description	Type	Required/Optional	Notes
`OTA_HotelProductNotifRQ`		Contains the `HotelProducts` array.	object	required
> `HotelProducts`		Contains the `HotelProduct` objects.	array	required
	`HotelCode`	Specifies the unique ID of the property you create roomrates for.	integer	required
>> `HotelProduct`		Contains the roomrate information.	object	required
	`ProductNotifType`	Specifies whether the request is to remove a roomrate.	enum	required	Value to remove a roomrate is `remove`.
>>> `RoomTypes`		Contains a `RoomType` object.	object	required
>>>> `RoomType`		Contains the room type information.	object	required
	`RoomTypeCode`	Specifies the room type id.	integer	required
>>> `RatePlans`		Contains a `RatePlan` object.	object	required
>>>> `RatePlan`		Contains the rate plan information.	object	required
	`RatePlanCode`	Specifies the rate plan id.	integer	required

Request body example

The following is a request body example:

<OTA_HotelProductNotifRQ>
  <HotelProducts HotelCode="64231">
    <HotelProduct ProductNotifType="Remove">
      <RoomTypes>
        <RoomType RoomTypeCode="6423112" />
      </RoomTypes>
      <RatePlans>
        <RatePlan RatePlanCode="12483478" />
      </RatePlans>
    </HotelProduct>
  </HotelProducts>
</OTA_HotelProductNotifRQ>

Response body example

The following is a successful response body example:

<OTA_HotelProductNotifRS>
  <Success />
</OTA_HotelProductNotifRS>
<!-- RUID: [UmFuZG9tSVYkc2RlIyh9YUedwgregreg3/GcBkCkoW0/uhiPmwiL6pcbMzyiykpi6Yx5oKzRKEMxDhfrI] -->

Response body parameters

The following table describes the response elements:

Element	Description	Type	Notes
`OTA_HotelProductNotifRS`	Contains the response data.	object
> `success`	Indicates the success of the request.	object
`ruid`	Specifies the unique ID of the request.	string	You can send this ID to Booking.com customer support if you run into an issue. This can help to understand what went wrong.

Retrieving active roomrates

Booking.com provides two endpoints to retrieve roomrates details using two different specifications:

Using the OTA endpoint
Using the B.XML endpoint

Difference between implementing the OTA vs B.XML endpoints

Booking.com provides the B.XML endpoint to retrieve active roomrates details. Note that the endpoint doesn't return roomrates that specify deactivated room type or rate plan.

Schema difference between the OTA and B.XML endpoint's response

The following table captures the high-level difference between the two endpoints' responses. However, this is not an exhaustive list.

Elements	Description	Available in OTA	Available in B.XML
`NoShowPolicy`	No show policy details	Yes	No
`room > hotel_name`	Property name	No	Yes
`room > room_name`	Roomtype name	No	Yes
`rate > max_persons`	Roomtype's maximum occupancy count	No	Yes
`rate > policy`	Cancellation policy name	No	Yes
`rate > rate_name`	Rate plan name	No	Yes
Same value but in a different name		`HotelProduct > ChildRate`	`rate > is_child_rate`
Same value but in a different name		`RoomType > MaxOccupancy`	`rate > fixed_occupancy`
	Difference between the both	`GuaranteePayment > EffectiveFrom` shows effective from value	`guarantee_payment > policy_code` shows cancellation policy code

Using the OTA endpoint

GET
https://supply-xml.booking.com/hotels/ota/OTA_HotelProductNotif

The GET OTA_HotelProductNotif request enables you to retrieve active roomrates for a property. You can retrieve the relevant room type and rate plan IDs. Remember to use Booking.com IDs while creating availability and not your internal IDs.

You can also use this endpoint to retrieve policy override information for active roomrates.

Query parameters

The following table describes the elements you can add in the query:

Element	Description	Type	Required/Optional	Notes
`HotelCode`	Specifies the unique ID of the property you want to retrieve the active rate plans for.	integer	required
`OverridePolicyStart`	Specifies the start of the date range for which you want to retrieve policy override information.	string	optional	Follows the format (YYYY-MM-DD).
`OverridePolicyEnd`	Specifies the end of the date range for which you want to retrieve policy override information.	string	Required if `OverridePolicyStart` is specified	Follows the format (YYYY-MM-DD).
`IncludeReadOnly`	Include roomrates that are read-only from the API. You cannot modify the read-only roomrates using the API. You can edit them only by using the Booking.com Extranet.	boolean	optional	Specify: `1` - Include read-only roomrates, `0` - Exclude read-only roomrates (default)
`SupportRateRewrite`	If set, then the API skips rates that have been rewritten to another rate.	boolean	optional	Specify: `1` - Skip rewritten roomrates, `0` - Include rewritten roomrates (default)

Query parameter example

The following is a query parameter example:

https://supply-xml.booking.com/hotels/ota/OTA_HotelProductNotif?HotelCode=123&IncludeReadOnly=1&OverridePolicyStart=2023-03-01&OverridePolicyEnd=2023-04-01&SupportRateRewrite=0

Response body example

The following is a successful response body example:

<?xml version="1.0" encoding="UTF-8"?>
<OTA_HotelProductNotifRS>
    <HotelProducts HotelCode="1">
        <HotelProduct ReadOnly="true" ChildRate="true">
            <RoomTypes>
                <RoomType RoomTypeCode="2" MaxOccupancy="5" />
            </RoomTypes>
            <RatePlans>
                <RatePlan RatePlanCode="11" />
            </RatePlans>
            <ValueAddInclusions>
                <MealPlan MealPlanCode="0" />
            </ValueAddInclusions>
            <PolicyInfo>
                <BookingRules>
                    <BookingRule MinAdvancedBookingOffset="P10D" />
                    <BookingRule MaxAdvancedBookingOffset="P10D1H" />
                    <BookingRule ReleaseTimeOfDayStart="1" />
                    <BookingRule ReleaseTimeOfDayEnd="2" />
                </BookingRules>
                <CancelPolicy>
                    <CancelPenalty PolicyId="325235" PolicyName="general" PolicyCode="222" />
                    <TPA_Extensions>
                        <NoShowPolicy Penalty="default"/>
                    </TPA_Extensions>
                </CancelPolicy>
                <GuaranteePaymentPolicy>
                    <GuaranteePayment EffectiveFrom="after_cancellation_fee_begins" PrePaymentRequired="true" />
                </GuaranteePaymentPolicy>
                <OverridePolicies>
                    <OverridePolicy PolicyId="333" PolicyName="override1">
                        <BookDates>
                            <BookDate Start="2023-01-01" End="2023-01-02" />
                        </BookDates>
                    </OverridePolicy>
                    <OverridePolicy PolicyId="444" PolicyName="override2">
                        <BookDates>
                            <BookDate Start="2023-01-03" End="2023-01-04" />
                        </BookDates>
                    </OverridePolicy>
                </OverridePolicies>
            </PolicyInfo>
            <TPA_Extensions>
                <PricingType Value="RLO" Price1="false">
                    <Occupancy MaxAdultOccupancy="1" Round="true" Percent="25.9" />
                    <Occupancy MaxAdultOccupancy="2" Round="false" Amount="25.0" />
                </PricingType>
                <RateRelation FollowsRestrictions="true" Percent="55.2" FollowsPolicy="true" FollowsPrice="false" ParentRatePlanCode="12" FollowsClosed="2" />
            </TPA_Extensions>
            <AdditionalGuestAmounts>
                <AdditionalGuestAmount AdditionalGuestNumber="0" MinAge="0" AgeBucketID="1" Amount="10.0" MaxAge="3" AgeQualifyingCode="8" />
                <AdditionalGuestAmount AdditionalGuestNumber="1" MinAge="4" AgeBucketID="2" Percent="50.0" MaxAge="12" AgeQualifyingCode="8" />
            </AdditionalGuestAmounts>
        </HotelProduct>
    </HotelProducts>
</OTA_HotelProductNotifRS>
<!-- RUID: [Z104215yh9YeXU9U0vxS7qEshGUqEDsuqNgPguHj+W/wiXPORW30Rmu5Qyp2=] -->

Response body parameters

The following table describes the response elements:

Element	Attribute	Description	Type	Notes
`OTA_HotelProductNotifRS`		Contains the response data.	object
> `HotelProducts`		Contains the roomrates details for a property.	object
	`HotelCode`	Specifies the unique ID of the property.	integer
>> `HotelProduct`		Contains more information about the roomrate.	object
	`ReadOnly`	Specifies whether the rate plan is read only.	boolean	You can set the ReadOnly property only through the Extranet.
	`ChildRate`	Specifies whether the rate plan has a rate relation with a parent rate plan. If `true` then you will find a `RateRelation` element in the object.	boolean
>>> `RoomTypes`		Contains the roomtype information	object
	`RoomTypeCode`	Specifies the unique Booking.com ID of the room type.	integer
	`MaxOccupancy`	Specifies the maximum number of adults allowed in the room type.	integer
>>> `RatePlans`		Contains rate plan information	object
>>>> `RatePlan`		Contains individual rate plan information	object
	`RatePlanCode`	Specifies the unique Booking.com ID of the rate plan.	integer
>>> `ValueAddInclusions`		Contains meal plan details	object
>>>> `MealPlan`		Contains the meal plan information.	object
	`MealPlanCode`	Specifies the meal plan ID.	integer	To see the list of meal plan codes at Booking.com, see meal plan codes.
>>> `PolicyInfo`		Contains cancellation and prepayment policy details	object
>>>> `BookingRules`		Contains the `BookingRule` objects.	object
>>>>> `BookingRule`		Contains the booking policy information.	object
	`MinAdvancedBookingOffset`	Specifies the minimum amount of time in which a room type must be booked relative to midnight (24:00 CE(S)T) of the check-in date start.	string	This is the format used: `P[0-9]+(Y,M,D,H)`. An example is: P5H means the room must be booked before 19:00 on the day before the check-in date.
	`MaxAdvancedBookingOffset`	Specifies the maximum amount of time in which a room type can be booked relative to midnight (24:00 CE(S)T) of the check-in date start.	string	This is the format used: `P[0-9]+(Y,M,D,H)`. An example is: P14D means the room can be booked a maximum of 14 days before the check-in date.
	`ReleaseTimeOfDayStart`		string
	`ReleaseTimeOfDayEnd`		string
>>>> `CancelPenalty`		Contains individual cancellation and prepayment policy details	object
	`PolicyCode`	Specifies the cancellation penalty code.	integer
	`PolicyId`	Specifies the unique ID of the policy.	integer
	`PolicyName`	Specifies the name of the policy.	string
>>>>> `TPA_Extensions`		Contains the no show information.	object
>>>>>> `NoShowPolicy`		Contains the no show penalty details.	object
	`Penalty`	Specifies the penalty charged in case the guest does not turn up for the reservation.	enumerated string	Possible values are: - `default`: Use if you want the no show penalty to follow the cancellation fee. - `total_price`: Use if you want the no show penalty to equal the total reservation price.
>>>> `GuaranteePaymentPolicy`		Contains the guarantee payment details.	object
>>>>> `GuaranteePayment`		Contains the guarantee payment details.	object
	`EffectiveFrom`	Specifies when the guarantee payment is charged.	enumerated string	Possible values are: - `after_reservation_is_made` - Enforces guests to make a payment immediately after reservation. - `after_cancellation_fee_begins`: Enforces guests to make a payment after the free cancellation window has closed.
	`PrePaymentRequired`	Specifies whether a guarantee payment is mandatory.	boolean	Possible values are: - `true`: Guarantee payment required - `false`: Guarantee payment is not required
>>>> `OverridePolicies`		Contains the policy override elements.	object
>>>>> `OverridePolicy`		Contains a policy override element.	object
	`PolicyCode`	Specifies the cancellation policy (override) code.	integer	To see the list of cancellation and prepayment policy codes at Booking.com, see cancellation and prepayment policies.
>>>>>> `BookDates`		Contains the BookDate object.	object
>>>>>> `BookDate`		Contains the overriding date.	object
	`Start`	Specifies the start date of the override policy.	string	Follows the format: `YYYY-MM-DD`.
	`End`	Specifies the end date of the override policy.	string	Follows the format: `YYYY-MM-DD`.
>>> `TPA_Extensions`		Contains pricing type information.	object
>>>> `PricingType`		Contains the pricing and occupancy details.	object	Only available when you enable the feature: Include products extra info (`include_extra_info_room_rates`) using the Provider portal.
	`Value`	Specifies the pricing type.	enumerated string	Possible values are: - Standard - RLO - OBP - LOS
	`Price1`	Specifies whether the roomrate accepts a single occupancy price.	boolean	Possible values are: `true` - Accepts single occupancy price `false` - Does not support single occupancy price.
>>>>> `Occupancy`		Contains the maximum occupancy details specified while creating derived pricing.	object	For more information on how to set derived pricing, see [Create or update derived pricing rates.][b_xml-derivedprices]
	`MaxAdultOccupancy`	Specifies the maximum number of occupants allowed to stay for this rate.	integer
	`Percent`/`Amount`	Specifies the pricing as a percentage of the base price or as an additional amount from the base price.	integer	For example, if the base price is 200 and the price for 2 occupants is specified as a percentage = 95, then the price for 2 is 90. (95% of 200). Whereas, an `additional = -15`, means the price for 2 occupants is 185.
	`Round`	Specifies whether the pricing is rounded down to two digits. Possible values are: - 0 : not rounded down - 1: Rounded down to two digits	enumerated string
>>>> `RateRelation`		If the rate plan is a child of a parent rate plan, then this object contains information on the inherited rate attributes.	object
	`FollowsClosed`	Indicates whether the rate relation follows the status of the parent rate plan.	boolean	Possible values: - `0` : Never follows parent rate plan status, - `1` : Follows parent status when parent rate plan is open, - `2` : Follows parent status when parent rate plan is closed, and - `3` : Always follows parent rate plan status. Default: `3`.
	`FollowsRestrictions`	Indicates whether the rate relation follows the restrictions of the parent rate plan.	boolean	Possible values: `true` and `false` (Follows parent rate plan). Default: `true`
	`FollowsPolicy`	Indicates whether the rate relation follows the policies of the parent rate plan.	boolean	Possible values: `true` and `false` (Follows parent rate plan). Default: `true`
	`FollowsPrice`	Indicates whether the rate relation follows the price of the parent rate plan.	boolean	Possible values: `true` and `false` (Follows parent rate plan). Default: `true`
	`ParentRatePlanCode`	Specifies the rate plan ID of the parent rate plan	string
	`Percent`	Specifies the percentage in relation to the price connected to the parent rate plan.	integer	Minimum value: `1`. Maximum value: `200`. For example, `80` refers to a 20% discount, while `120` refers to a 20% surplus.
>>> `AdditionalGuestAmounts`		Contains the `AdditionalGuestAmount` elements.	array
>>>> `AdditionalGuestAmount`		Contains the children pricing details.	object
	`AgeQualifyingCode`	Specifies that the prices are for children.	integer	You must use `8` to signal that the prices are for children only. Note that you cannot set adult prices here, but only within the `BaseByGuestAmts` object (see example).
	`AgeBucketID`	Specifies the ID of the property-level age bucket.	integer	You must either use `AgeBucketID` or `MinAge` with `MaxAge`. However, the `MinAge` to `MaxAge` age range must match an existing age bucket age range.
	`MinAge`	Specifies the beginning of an age range.	integer	You must either use `AgeBucketID` or `MinAge` with `MaxAge`. However, the `MinAge` to `MaxAge` age range must match an existing age bucket age range.
	`MaxAge`	Specifies the end of an age range and is inclusive.	integer	You must either use `AgeBucketID` or `MinAge` with `MaxAge`. However, the `MinAge` to `MaxAge` age range must match an existing age bucket age range.
	`Amount`	Specifies the price for a child within a certain age bucket.	integer	The price cannot exceed the adult price for the roomrate. You must use either `Amount` and `DecimalPlaces`, or `Percent` alone.
	`DecimalPlaces`	Specifies the number of decimal places to apply to `Amount`.	integer	The default value is `0`, which means the value of `Amount` is without a decimal point.
	`Amount`	Specifies the price for a child within a certain age bucket.	integer	The price cannot exceed the adult price for the roomrate. You must use either `Amount` and `DecimalPlaces`, or `Percent` alone.
	`Percent`	Specifies the price for the child as a percentage of the adult price.	integer	Possible value between `0` and `100`. You must use either `Amount` and `DecimalPlaces`, or `Percent` alone.
	`AdditionalGuestNumber`	Specifies the order of prices within the same age bucket.	integer	This means that you can set different prices per child within the same age bucket age range. For example: Price for `1` (first child) is 5000, while the price for `2` (second child) is 2500, and `3` (third child) is free (`0`). Default value is `0`, meaning all prices are the same for children in the specified age bucket.
`RUID`		Specifies the unique ID of the request.	string	You can send this ID to Booking.com customer support if you run into an issue. This can help to understand what went wrong.

Using the B.XML endpoint

POST
https://supply-xml.booking.com/hotels/xml/roomrates

The POST /xml/roomrates request enables you to retrieve active roomrates for a property.

You can:

Retrieve the relevant room type and rate plan IDs.
Query roomrate details with or without rewritten rate details.
Retrieve additional response details like flexible children prices, if they are set.

You can also use this endpoint to retrieve policy override information for active roomrates. Remember to use Booking.com IDs while creating availability and not your internal IDs.

To resolve security issues and non-standard system behavior, the v1.1 roomrates endpoint supports the UTF-16 encoding algorithm.

Header parameter

Header	Description	Type	Required/ Optional	Notes
`Accept-Version`	Specify the version number to get the API functionality specific to that version.	string	optional	Currently supports the version 1.1 (default). Version 1.0 is deprecated. If used, the endpoint returns a `406 Not acceptable` error.

Body parameters

The following table describes the elements you can add in the request body:

Element	Description	Type	Required/Optional
`request`	Contains the request information.	object	required
> `hotel_id`	Specifies the unique ID of the property you want to retrieve the active rate plans for.	integer	required
> `policy_override_start`	Specifies the start of the date range for which you want to retrieve policy override information.	string	optional
> `policy_override_end`	Specifies the end of the date range for which you want to retrieve policy override information.	string	required if `policy_override_start` is specified

Request body example 1

The following is a request body example:

<request>
   <hotel_id>8011855</hotel_id>
</request>

Request body example 2

The following request body example retrieves roomrates that have policy overrides defined:

<request>
    <hotel_id>8011855</hotel_id>
    <policy_override_start_date>2024-01-12</policy_override_start_date>
    <policy_override_end_date>2024-02-29</policy_override_end_date>
</request>

Response body example

The following is a successful response body example:

<?xml version='1.0' encoding='UTF-8'?>
<roomrates>
    <rooms>
        <room id="801185509" hotel_id="8011855" hotel_name="HillTop Hotel" room_name="Penthouse Apartment">
            <rates>
                <rate id="25278032" max_persons="7" policy="General" policy_id="341337682" rate_name="summer rate" fixed_occupancy="2">
                    <meal_plan meal_plan_code="10"/>
                    <policies>
                        <booking_rules>
                            <booking_rule min_advanced_booking_offset="P1D"/>
                            <booking_rule max_advanced_booking_offset="P14D"/>
                        </booking_rules>
                        <cancel_policy>
                            <cancel_penalty policy_code="62"/>
                            <policy_overrides>
                                <policy_override start_date="2024-01-16" end_date="2024-02-23" policy_code="12"/>
                            </policy_overrides>
                        </cancel_policy>
                        <guarantee_payment_policy>
                            <guarantee_payment policy_code="1" effective_from="after_reservation_is_made" required="1"/>
                            <policy_overrides>
                                <policy_override start_date="2024-01-16" end_date="2024-02-23" policy_code="after_reservation_is_made"/>
                            </policy_overrides>
                        </guarantee_payment_policy>
                    </policies>
                    <pricing type="RLO">
                        <occupancy persons="3" percentage="125.0" round="1"/>
                        <occupancy persons="4" additional="10.0" round="0"/>
                        <additional_guests>
                            <price type="child" additional_guest_number="0" from_age="0" to_age="3" age_bucket_id="1" percentage="50.0"/>
                            <price type="child" additional_guest_number="0" from_age="4" to_age="12" age_bucket_id="2" percentage="30.0"/>
                            <price type="child" additional_guest_number="0" from_age="13" to_age="17" age_bucket_id="3" percentage="20.0"/>
                        </additional_guests>
                    </pricing>
                </rate>
            </rates>
        </room>
        <room id="801185512" hotel_id="8011855" hotel_name="HillTop Hotel" room_name="Villa">
            <rates>
                <rate id="33298392" max_persons="5" policy="Special Conditions 3" policy_id="342592279" rate_name="winter break rates" is_child_rate="1">
                    <meal_plan meal_plan_code="12"/>
                    <policies>
                        <booking_rules/>
                        <cancel_policy>
                            <cancel_penalty policy_code="166"/>
                        </cancel_policy>
                        <guarantee_payment_policy>
                            <guarantee_payment policy_code="166" effective_from="after_reservation_is_made" required="1"/>
                        </guarantee_payment_policy>
                    </policies>
                    <pricing type="Standard" price1="0"/>
                    <rate_relation follows_closed="3" follows_restrictions="1" follows_policygroup_id="1" follows_price="1" parent_rate_id="31105118" percentage="90.0"/>
                </rate>
            </rates>
        </room>
    </rooms>
</roomrates>
<!-- RUID: [f0020c39-f851-4e8d-cvd2q-98c9845a0940] -->

Response body parameters

The following table describes the response elements:

Element	Attribute	Description	Type	Notes
`roomrates`		Contains the response details of the roomrate.	object
`rooms`		Contains the `room` objects.	object
> `room`		Contains the room type information.	object
	`id`	Specifies the unique Booking.com ID of the room type.	integer
	`hotel_id`	Specifies the unique ID of the property.	integer
	`hotel_name`	Specifies the name of the property.	string
	`room_name`	Specifies the name of the room type.	string
>> `rates`		Contains the `rate` objects.	object
>>> `rate`		Contains the rate plan information.	object
	`id`	Specifies the unique Booking.com ID of the rate plan.	integer
	`is_child_rate`	Specifies whether the rate plan has a rate relation with a parent rate plan.	boolean	Possible value: `1` (Yes, rate plan is a child rate plan)
	`fixed_occupancy`	Only applicable for derived pricing types (RLO). Shows the maximum number of occupants specified when creating or updating a roomrate.	integer	This value can be different from the max_persons value set while creating the roomtype.
	`max_persons`	Specifies the maximum number of adults allowed in the room type.	integer
	`policy`	Specifies the name of the policy.	string
	`policy_id`	Specifies the unique ID of the policy.	integer
	`rate_name`	Specifies the name of the rate plan.	string
>>>> `occupancies`		Lists all occupancies from 1 to `max_persons` when pricing type is `OBP`.	object
>>>> `meal_plan`		Contains the meal plan information.	object
	`meal_plan_code`	Specifies the meal plan ID.	integer	To see the list of meal plan codes at Booking.com, see meal plan codes.
>>>> `policies`		Contains the cancellation policy details.	object
>>>>> `booking_rules`		Contains the `BookingRule` objects.	object
>>>>>> `booking_rule`		Contains the booking policy information.	object
	`min_advanced_booking_offset`	Specifies the minimum amount of time in which a room type must be booked relative to midnight (24:00 CE(S)T) of the check-in date start.	string	This is the format used: `P[0-9]+(Y,M,D,H)`. An example is: P5H means the room must be booked before 19:00 on the day before the check-in date.
	`max_advanced_booking_offset`	Specifies the maximum amount of time in which a room type can be booked relative to midnight (24:00 CE(S)T) of the check-in date start.	string	This is the format used: `P[0-9]+(Y,M,D,H)`. An example is: P14D means the room can be booked a maximum of 14 days before the check-in date.
>>>> `cancel_policy`		Contains the `CancelPenalty` object.	object
>>>>> `cancel_penalty`		Contains the policy information.	object
	`policy_code`	Specifies the cancellation policy code.	integer	For a full list of all the available cancellation codes, see the cancellation policy codes.
>>>>>>> `policy_overrides`		Contains the policy override elements.	object
>>>>>>>> `policy_override`		Contains a policy override element.	object
	`start_date`	Specifies the start date of the override policy.	string	Follows the format: `YYYY-MM-DD`.
	`end_date`	Specifies the end date of the override policy.	string	Follows the format: `YYYY-MM-DD`.
	`policy_code`	Specifies the cancellation policy (override) code.	integer	To see the list of cancellation and prepayment policy codes at Booking.com, see cancellation and prepayment policies.
>>>> `guarantee_payment_policy`		Contains the guarantee payment details.	object
>>>>> `guarantee_payment`		Contains the guarantee payment details.	object
	`policy_code`	Deprecated. Please ignore this field. `effective_from` and `required` indicate the guarantee payment policy	integer
	`effective_from`	Specifies when the guarantee payment is charged.	enumerated string	Possible values are: - `after_reservation_is_made` - Enforces guests to make a payment immediately after reservation. - `after_cancellation_fee_begins`: Enforces guests to make a payment after the free cancellation window has closed.
	`required`	Specifies whether a guarantee payment is mandatory.	boolean	Possible values are: - `1`: Guarantee payment required - `0`: Guarantee payment is not required
>>>> `pricing`		Contains the pricing details.	object	Only available when you enable the feature: Include products extra info (`include_extra_info_room_rates`) using the Provider portal.
	`type`	Specifies the pricing type.	enumerated string	Possible values are: - Standard - RLO - OBP - LOS
	`price1`	Specifies whether the roomrate accepts a single occupancy price.	boolean	Possible values are: 1 - Accepts single occupancy price 0 - Does not support single occupancy price.
>>>>> `additional_guests`		Contains the `price` elements for flexible child rate details (if they are already defined).	array
>>>>>> `price`		Contains the children pricing details.	object
	`type`	Specifies that the prices are for children.	string
	`additional_guest_number`	Specifies the order of prices within the same age bucket.	integer	For example: Price for `1` (first child) is 5000, while price for `2` (second child) is 2500, and `3` (third child) is free (`0`). Default value is `0`, meaning all prices are the same for children in the specified age bucket.
	`age_bucket_id`	Specifies the ID of the property-level age bucket.	integer
	`from_age`	Specifies the beginning of an age range.	integer
	`to_age`	Specifies the end of an age range and is inclusive.	integer
	`additional`	Specifies the fixed price for a child within a certain age bucket.	integer
	`percentage`	Specifies the price for the child as a percentage of the adult price.	integer	Possible value between `0` and `100`.
>>>> `rate_relation`		If the rate plan is a child of a parent rate plan, then this object contains information on the inherited rate attributes.	object
	`follows_closed`	Indicates whether the rate relation follows the status of the parent rate plan.	boolean	Possible values: - `0` : Never follows parent rate plan status, - `1` : Follows parent status when parent rate plan is open, - `2` : Follows parent status when parent rate plan is closed, and - `3` : Always follows parent rate plan status. Default: `3`.
	`follows_restrictions`	Indicates whether the rate relation follows the restrictions of the parent rate plan.	boolean	Possible values: `0` and `1` (Follows parent rate plan). Default: `1`
	`follows_policygroup_id`	Indicates whether the rate relation follows the policies of the parent rate plan.	boolean	Possible values: `0` and `1` (Follows parent rate plan). Default: `1`
	`follows_price`	Indicates whether the rate relation follows the price of the parent rate plan.	boolean	Possible values: `0` and `1` (Follows parent rate plan). Default: `1`
	`parent_rate_id`	Specifies the rate plan ID of the parent rate plan	string
	`percentage`	Specifies the percentage in relation to the price connected to the parent rate plan.	integer	Minimum value: `1`. Maximum value: `200`. For example, `80` refers to a 20% discount, while `120` refers to a 20% surplus.
>>>>> `occupancy`		Contains the occupancy details that you set using the derived pricing endpoint for multiple occupancies for a room type that has `RLO` pricing.
	`persons`	Specifies the number of occupants.	integer
	`percentage`/`additional`	Specifies the pricing as a percentage of the base price or as an additional amount from the base price.	integer	For example, if the base price is 200 and the price for 2 occupants is specified as a percentage = 95, then the price for 2 is 90. (95% of 200). Whereas, an `additional = -15`, means the price for 2 occupants is 185.
	`round`	Specifies whether the pricing is rounded down to two digits. Possible values are: - 0 : not rounded down - 1: Rounded down to two digits	enumerated string
`Ruid`		Specifies the unique ID of the request.	string	You can send this ID to Booking.com customer support if you run into an issue. This can help to understand what went wrong.