Managing room amenities
The OTA_HotelInvNotif (HIN) endpoint was deprecated for Home providers in December 2024. We will sunset this endpoint for Home providers on December 31, 2026. For more information on the deprecation and sunsetting timeline, see OTA_HotelInvNotif (HIN) endpoint in Content API.
We strongly encourage Home providers to implement the Rooms API and the Facilities API (the room facilities and bathroom endpoints) at their earliest convenience.
To learn more about our new modular APIs, see our guide on Making property onboarding easier.
In addition to creating room types (Room type and rate plan API), you can also use the /ota/OTA_HotelInvNotif endpoint to add, update, retrieve, or remove a property's room amenities for one or more existing room types.
What are room amenities?
Room amenities are predefined labels that you can use to list features or facilities available in a physical room of a given property. Booking.com provides a list of supported room amenities each identified using an amenity type code, including bed types room amenities which you can use to specify the types of beds in the room.
→ For a list of all the possible Booking.com room amenities, see room amenity type code. To see a list of all bed types, see bed type codes.
What falls under managing room amenities?
Managing room amenities involves the following actions:
Adding and updating room amenities
POST https://supply-xml.booking.com/hotels/ota/OTA_HotelInvNotifThe POST /ota/OTA_HotelInvNotif request enables you to add and update room amenities of one or more existing room types per property.
To update room amenities:
Set
InvNotifTypetoOverlay.Include
InvCode, which is the Booking.com ID referring to an existing room type. You do not need to add theRoomTypeagain.Change the
Amenitieselements you want to update and include all the existing room information.→ To retrieve a property's room amenities details, see retrieving room amenities.
→ To add room amenities when creating a room type, set the
InvNotifTypetoNew. For more information, see creating a room type.
Overlay exception while updating bed-type amenities
In general, when overlaying details of an existing property, room type, or other object, the body of your current request replaces the existing information. Therefore, existing information may get deleted if you do not include it in your request. To update an object without deleting existing information, your request must contain both the updates and the existing information.
However, there is an exception to this overlay behaviour while updating bed-type room amenities. Updating only bed-type room amenities does not overlay existing room amenities. For example, when you add or update bed types, it does not affect existing non-bed type room amenities. Similarly, updating only non-bed type room amenities does not overlay existing bed-type amenities.
Adding bed types for rooms that support multiple bedrooms
To add bed types for rooms that support multiple bedrooms (such as Apartment or Suite), you must use the Amenities element under SubRooms.
For example, see room amenities and bed types in a multi-bedroom room type.
Requirements for adding or updating room amenities
To add or update room amenities of a room type on Booking.com, the following elements are required:
- Property ID
- Booking.com room type ID
- Room amenity type code
Please note that you will now be able to set any occupancy, the limitation of max 4 children is no longer in place.
Body parameters
The following table describes the elements to add in the request body:
| Element | Attribute | Description | Type | Migration strategy |
|---|---|---|---|---|
OTA_HotelInvNotifRQ | [Required] Contains the SellableProducts array. | object | ||
> SellableProducts | [Required] Contains the SellableProduct object. | array | ||
HotelCode | [Required] Specifies the unique ID of the property you update room amenities for. | integer | Use Rooms API. Specify as part of the URL. | |
>> SellableProduct | [Required] Contains a GuestRoom object. | object | ||
InvNotifType | [Required] Indicates whether the request is to add room amenities when you create a room type (New) or to modify room amenities of an existing room type (Overlay). Possible values are New and Overlay. | enum | Use Rooms API. Use the relevant HTTP method. | |
InvCode | [Required if InvNotifType="Overlay"] Specifies the ID generated by Booking.com when you created the room type. Not applicable when creating a new room type. Use the value in the ResponseInvCode found in the response body to modify a specific room type. | integer | Use Rooms API. Specify as part of the URL. | |
>>> GuestRoom | [Required] Contains a GuestRoom object. | object | ||
>>>> Description | [Optional] Contains the room type name object. | object | ||
>>>>> Text | [Optional] Specifies the name of the room type. To see a list of the available room type names, see retrieving room type names. | string | Use Rooms API's configuration.unit_name_id parameter. To get the list of available room type names in supported languages (to support translations), use the Rooms meta endpoint. | |
>>>> Occupancy | [Optional] Specifies the occupancies of the room type. | object | ||
MaxOccupancy | [Optional] Specifies the maximum number of guests allowed to stay in the room type. The value for MaxOccupancy cannot be higher than the sum of the values for MaxAdultOccupancy and MaxChildOccupancy. | integer | Use Rooms API's occupancy_details.max_guests parameter. | |
MaxAdultOccupancy | [Optional] Specifies the maximum number of adult guests allowed to stay in the room type. | integer | Use Rooms API's occupancy_details.max_adults parameter. | |
MaxChildOccupancy | [Optional] Specifies the maximum number of children physically allowed to stay in the room type. The value for MaxChildOccupancy must always be lower than that for MaxOccupancy, because you cannot have a room with only children. If this value is set to 0 for all room types, then the AcceptedGuestType element is set to AdultOnly and all children policy rules are deleted. | integer | Use Rooms API's occupancy_details.max_children parameter. Rooms API also introduces the occupancy_details.max_infants parameter and occupancy_details.max_infants_on_top parameters. | |
>>>> TPA_Extensions | [Optional] Contains the room type's additional child occupancy details. | object | ||
>>>>> Occupancy | [Optional] Specifies the children rate eligibility. | object | ||
MaxChildPayableOccupancy | [Optional] Specifies the maximum number of children that are eligible for the children rate. The value for MaxChildPayableOccupancy cannot be higher than the value of MaxChildOccupancy. Booking.com system sees any additional children under the adult rate. | integer | Use Rooms API's max_children_that_pay_children_rate parameter. | |
>>>>> SubRooms | [Optional] Specifies the subroom details. You can create subrooms only for rooms with the following room types (RoomType): - Apartment - Suite - Chalet - Bungalow - Holiday home - Villa - Mobile home Or, apartment_room_capacity is > 0. | object | ||
>>>>>> SubRoom | [Optional] Specifies individual subroom details. | object | - | |
MaxGuests | - | |||
Number | [Optional] Specifies the number of subrooms of the specified type. Only available for Bathroom or Living room | integer | Use configuration.rooms[].type specification as many times you need a specific subroom. | |
PrivateBathroom | [Optional] Specifies whether the subroom has a private bathroom (1) or not (0). Accepts: 0, 1 | boolean | - | |
RoomType | [Required] Specifies the type of subroom. Accepts: Bedroom, Living room, Bathroom | enumerated string | Use Rooms API's configuration.rooms[].type parameter. | |
>>>>>>> Amenities | [Optional] Specifies the subroom amenities. | array of Amenity | Amenities in subrooms can only be beds. | |
>>>>>>>> Amenity | [Optional] Specifies individual subroom amenity details. | object | - | |
RoomAmenityCode | [Optional] Specifies the bed type code. Optional if AmenityCode is specified. For rooms that support multiple bedrooms (such as Apartment, Suite), you must add bed types using this attribute. For a list of supported bed type codes, see OTA bed types. | enumerated string | Use Rooms API's configuration.rooms[].bed_configurations[].beds[].bed_type_id parameter. | |
AmenityCode | [Optional] Optional if RoomAmenityCode is specified. Specifies the bed type code. Same as RoomAmenityCode. Amenities in subrooms can only be beds. Introduced for compatibility with OTA_HotelInvNotifRQ. For a list of supported bed type codes, see OTA bed types. | object | Use Rooms API's configuration.rooms[].bed_configurations[].beds[].bed_type_id parameter. | |
Value | [Required for some amenities] Specifies the number of bed-type room amenities in the room. This attribute is required for some room amenities and is case sensitive. Introduced for compatibility with OTA_HotelInvNotifRQ. | integer | Use Rooms API's configuration.rooms[].bed_configurations[].beds[].bed_count parameter. | |
Quantity | [Optional] Specifies the available number of amenities of this type. Same as Value. | integer | Use Rooms API's configuration.rooms[].bed_configurations[].beds[].bed_count parameter. | |
Configuration | [Optional] Specifies whether the amenity is available in the standard or alternative room arrangement. Accepted only when RoomAmenityCode is a bed type. Possible values are: 1 (standard arrangement), 2 (alternative arrangement). This option is not available for multi-room rooms. Introduced for compatibility with OTA_HotelInvNotifRQ. | enumerated string | Use Rooms API's configuration.rooms[].bed_configurations[].is_default_configuration parameter. | |
>>>> Room | Specifies the basic room type information. Required if InvNotifType="New" | object | ||
RoomID | [Optional] Specifies the room type ID you use in your system. You can use this field to map room types across interfaces. | integer | Not supported. | |
RoomType | Specifies the room type. When specifying a room type that supports multiple bedrooms (such as Apartment, Suite), make sure to add bed types using TPA_Extensions > Subrooms > Amenities. See also creating a multi-bedroom roomtype.Required if InvNotifType="New" To see a list of all available room types, see room type codes. Apartment (PCT code 3) , Aparthotel (PCT code 5000) and Condominium (PCT code 8) require a kitchen or kitchenette in the room types to become open and bookable. For Holiday home (PCT code 5006), Holiday park (PCT code 5009), Lodge (PCT code 22) and Villa (PCT code 35) a kitchen or kitchenette is highly recommended. For more information, see Property Class Type Codes. | string or integer | Use Rooms API's unit_name_id parameter. | |
SizeMeasurement | [Optional] Specifies the numeric size of the room type. | integer | Use Rooms API's size.value parameter. | |
SizeMeasurementUnit | [Optional] Specifies the system of measurement. Possible values are sqm (metric) and sqft (imperial). The default value is sqm. | string | Use Rooms API's size.unit parameter. | |
NonSmoking | [Optional] Indicates whether smoking is allowed in the room type. 1 indicates non-smoking, 0 indicates smoking is allowed, 2 indicates both smoking and non-smoking are allowed. If you do not add this attribute, the default value is set to unknown. | boolean | Use Rooms API's smoking_policy parameter. | |
Quantity | [Optional] Specifies the number of units of a room type. | integer | Use Rooms API's number_of_units parameter. | |
>>>> Quantities | [Optional] Contains the crib and extra bed details. | object | ||
MaximumAdditionalGuests | [Optional] Specifies the maximum number of additional guests allowed to stay in the room in cribs or extra beds (rollaways). | integer | Use Rooms API's extra_beds_configuration.is_crib_and_extra_bed_allowed parameter to specify whether both extra cribs and extra beds are allowed or just one of them. | |
MaxCribs | [Optional] Specifies the maximum number of cribs in the room. | integer | Use Rooms API's extra_beds_configuration.cribs parameter. | |
MaxRollaways | [Optional] Specifies the maximum number of extra beds in the room. | integer | Use Rooms API's extra_beds_configuration.extra_beds parameter. | |
>>>> Amenities | [Optional] Specifies the property-level amenity details. | object | ||
>>>>> Amenity | [Optional] Specifies the room amenities and bed type details of the room type. For rooms with multi-bedroom support, you must add bed types under SubRooms > Amenities and not here. | object | ||
RoomAmenityCode | [Optional if AmenityCode is specified] Specifies the Room Amenity Type Code. For a list of supported amenity codes, see RMA. | enumerated string | Use Facilities API and specify an appropriate room_facility_id to create a room facility. Use Facilities API's meta endpoint to get the list of supported room amenity codes. | |
AmenityCode | [Optional if RoomAmenityCode is specified ] Specifies the room amenities and bed type. Same as RoomAmenityCode. Introduced for compatibility with OTA_HotelInvNotifRQ. For a list of supported amenity codes, see RMA. | enumerated string | Use Facilities API and specify an appropriate room_facility_id to create a room facility. Use Facilities API's meta endpoint to get the list of supported room amenity codes. | |
Value | Specifies the available number of amenities of this type. Required for some amenities. Introduced for compatibility with OTA_HotelInvNotifRQ. This attribute is required for some of the room amenities and is case sensitive. | enumerated string | For specific facilities that support multiple instances, speciy as many room_facility_instances parameters. | |
Quantity | [Optional] Specifies the available number of amenities of this type. Same as Value. This attribute is required for some room amenities and is case sensitive. | integer | For specific facilities that support multiple instances, speciy as many room_facility_instances parameters. | |
Configuration | [Optional] Indicates whether the amenity is available in the standard or alternative room arrangement. Accepted only for bed types. Possible values are: 1 (standard arrangement) 2 (alternative arrangement) | enumerated string | - |
Request body example: Room amenities
The following request body sets a kitchenette, a desk and a minibar in the room type:
<OTA_HotelInvNotifRQ>
<SellableProducts HotelCode="6314570">
<SellableProduct InvNotifType="Overlay" InvCode="631457019">
<GuestRoom>
<Amenities>
<Amenity AmenityCode="61"/>
<Amenity AmenityCode="28"/>
<Amenity AmenityCode="69" Value="1"/>
</Amenities>
</GuestRoom>
</SellableProduct>
</SellableProducts>
</OTA_HotelInvNotifRQ>
Request body example: Bed types
The following request body sets two single beds available in the standard room arrangement in the room type:
<OTA_HotelInvNotifRQ>
<SellableProducts HotelCode="6314570">
<SellableProduct InvNotifType="Overlay" InvCode="631457019">
<GuestRoom>
<Amenities>
<Amenity AmenityCode="203" Value="2" Configuration="1"/>
</Amenities>
</GuestRoom>
</SellableProduct>
</SellableProducts>
</OTA_HotelInvNotifRQ>
Request body example: Room amenities and bed types in a multi-bedroom room type
The following request body sets a desk, a refrigerator and free toiletries in the room type Apartment. In addition, it sets one double bed in the subroom Bedroom and one sofa bed in the subroom Living room:
<OTA_HotelInvNotifRQ>
<SellableProducts HotelCode="6314570">
<SellableProduct InvNotifType="Overlay" InvCode="631457019">
<GuestRoom>
<Amenities>
<Amenity AmenityCode="28" />
<Amenity AmenityCode="88" />
<Amenity AmenityCode="11" />
</Amenities>
<TPA_Extensions>
<SubRooms>
<SubRoom RoomType='Bedroom' PrivateBathroom="0">
<Amenities>
<Amenity AmenityCode="249" Value="1" />
</Amenities>
</SubRoom>
<SubRoom RoomType="Living room">
<Amenities>
<Amenity AmenityCode="102" Value="1" />
</Amenities>
</SubRoom>
</SubRooms>
</TPA_Extensions>
</GuestRoom>
</SellableProduct>
</SellableProducts>
</OTA_HotelInvNotifRQ>Response body example
The following is a successful response body example:
<OTA_HotelInvNotifRS >
<Success />
</OTA_HotelInvNotifRS>
<!-- RUID: [UmFuZG9tSVYkc2RlIyh9YU4iplNAF3/GEVjlG+mTXmB9OwspcIGa+KqcbMzyiykpi6Yx5oKzRKEMxDhfrI] -->
Response body parameters
The following table describes the response elements:
| Element | Description | Type | Notes |
|---|---|---|---|
OTA_HotelInvNotifRS | Contains the response data. | object | |
> warnings | Contains potential warnings. These can help you improve your requests. | array | |
> errors | Contains potential errors. These can help you understand what went wrong with your request. | array | |
> 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 room amenities
POST https://supply-xml.booking.com/hotels/ota/OTA_HotelDescriptiveInfoThe POST /ota/OTA_HotelDescriptiveInfo request enables you to retrieve room amenities of all the active room types of a property.
→ To retrieve room amenities of both deactivated and active room types, you must retrieve the property details and filter on GuestRooms.
Body parameters
The following table describes the elements you must add in the request body:
| Element | Attribute | Description | Type | Required/Optional | Notes |
|---|---|---|---|---|---|
request | Contains the request information. | object | required | ||
> hotel_id | Specifies the unique ID of the property you want to retrieve the active room types for. | integer | required |
Request body example
The following is a request body example:
<OTA_HotelDescriptiveInfoRQ>
<HotelDescriptiveInfos>
<HotelDescriptiveInfo HotelCode="6314570"></HotelDescriptiveInfo>
</HotelDescriptiveInfos>
</OTA_HotelDescriptiveInfoRQ>
Response body example
The following shows the relevant information of a successful response body example:
<OTA_HotelDescriptiveInfoRS>
...
<GuestRooms>
<GuestRoom ID="631457019" Active="1" RoomTypeName="Double" NonSmoking="Unknown">
<Amenity RoomAmenityCode="28" AmenityCode="28"/>
<Amenity RoomAmenityCode="61" AmenityCode="61"/>
<Amenity RoomAmenityCode="69" AmenityCode="69"/>
<Amenity RoomAmenityCode="203" Quantity="2" AmenityCode="203" Value="2" Configuration="1"/>
<DescriptiveText>Deluxe Double Room with Mountain View</DescriptiveText>
<Occupancy MaxOccupancy="2" MaxAdultOccupancy="2" MaxChildOccupancy="1"/>
<Quantities MaxCribs="0" MaxRollaways="0"/>
<TPA_Extensions>
<Occupancy MaxChildPayableOccupancy="1" />
</TPA_Extensions>
</GuestRoom>
</GuestRooms>
...
</OTA_HotelDescriptiveInfoRS>
<!-- RUID: [UmFuZG9tSVYkc2RlIyh9YZvDaUET+NMaXKN+9zcX6t7ygxdUDjvU4TNDD8JwtXxnIZuaEi] -->
Response body parameters
The following table describes the response elements:
| Element | Attribute | Description | Type | Notes |
|---|---|---|---|---|
OTA_HotelDescriptiveInfoRS | Contains the response data. | object | ||
> GuestRooms | Contains the guestroom objects. | object | ||
>> GuestRoom | Contains the guestroom information. | object | ||
ID | Specifies the unique Booking.com ID of the room type. | integer | ||
Active | Specifies if the room type is active or inactive. | boolean | In this case, 1 means active and 0 means inactive. | |
RoomTypeName | Specifies the name of the room type. | string | To see a list of the available room type names, see retrieving room type names. | |
NonSmoking | Indicates whether smoking is allowed in the room type. | boolean | In this case, 1 means non-smoking and 0 means smoking is allowed. | |
>>> Amenity | Contains the Amenity information. | object | ||
RoomAmenityCode | The Room Amenity Type Code. | enum | ||
AmenityCode | The Room Amenity Type Code. | enum | Same as @RoomAmenityCode, introduced for compatibility with OTA_HotelInvNotifRQ. | |
Quantity | The available number of amenities of this type. | integer | ||
Value | The available number of amenities of this type. | integer | Same as @Quantity, introduced for compatibility with OTA_HotelInvNotifRQ. | |
Configuration | Specifies whether the amenity is available in the standard or alternative room arrangement. | enum | Accepted only when [amenity type code] RMA is a bed type. Possible values: 1 (standard arrangement), 2 (alternative arrangement). Introduced for compatibility with OTA_HotelInvNotifRQ. | |
>>> DescriptiveText | Specifies the name of the room type. | object | To see a list of the available room type names, see retrieving room type names. | |
>>> Occupancy | Specifies the occupancies of the room type. | object | ||
MaxOccupancy | Specifies the maximum number of guests allowed to stay in the room type. | integer | ||
MaxAdultOccupancy | Specifies the maximum number of adult guests allowed to stay in the room type. | integer | ||
MaxChildOccupancy | Specifies the maximum number of children physically allowed to stay in the room type. | integer | The value for MaxChildOccupancy must always be lower than that for MaxOccupancy, because you cannot have a room with only children. | |
>>> Quantity | Specifies the number of units of a room type. | integer | ||
MaximumAdditionalGuests | Specifies the maximum number of additional guests allowed to stay in the room in cribs or extra beds (rollaways). | integer | ||
MaxCribs | Specifies the maximum number of cribs in the room. | integer | ||
MaxRollaways | Specifies the maximum number of extra beds in the room. | integer | ||
> warnings | Contains potential warnings. These can help you improve your requests. | array | ||
> errors | Contains potential errors. These can help you understand what went wrong with your request. | array | ||
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 room amenities
POST https://supply-xml.booking.com/hotels/ota/OTA_HotelInvNotifThe POST /ota/OTA_HotelInvNotif request enables you to remove room amenities of one or more existing room types for your property.
To remove one or more room amenities:
Set
InvNotifTypetoOverlay.Include
InvCode, which is the Booking.com ID referring to an existing room type. You do not need to add theRoomTypeagain.Include all the other existing room information and change the
Amenitieselements you want to update.Specify “0” in attribute
Valuefor the room amenities and bed types you want to remove.→ To retrieve information on your property's room amenities, see retrieving room amenities.
Overlay exception while removing bed-type amenities
Similar with updating bed-type amenities, there is also an exception to the overlay behaviour while removing bed-type room amenities. Removing only bed-type room amenities does not overlay existing room amenities. For example, when you remove bed types, it does not affect existing non-bed type room amenities. Similarly, removing only non-bed type room amenities does not overlay existing bed-type amenities.
Requirements for removing room amenities
To remove room amenities of a room type on Booking.com, you only need the following elements:
- Property ID
- Booking.com room type ID
- Room amenity type code
Body parameters
The following table describes the elements to add in the request body:
| Element | Attribute | Description | Type | Migration strategy |
|---|---|---|---|---|
OTA_HotelInvNotifRQ | [Required] Contains the SellableProducts array. | object | ||
> SellableProducts | [Required] Contains the SellableProduct object. | array | ||
HotelCode | [Required] Specifies the unique ID of the property you update room amenities for. | integer | Use Rooms API. Specify as part of the URL. | |
>> SellableProduct | [Required] Contains a GuestRoom object. | object | ||
InvNotifType | [Required] Indicates whether the request is to add room amenities when you create a room type (New) or to modify room amenities of an existing room type (Overlay). Possible values are New and Overlay. | enum | Use Rooms API. Use the relevant HTTP method. | |
InvCode | [Required if InvNotifType="Overlay"] Specifies the ID generated by Booking.com when you created the room type. Not applicable when creating a new room type. Use the value in the ResponseInvCode found in the response body to modify a specific room type. | integer | Use Rooms API. Specify as part of the URL. | |
>>> GuestRoom | [Required] Contains a GuestRoom object. | object | ||
>>>> Description | [Optional] Contains the room type name object. | object | ||
>>>>> Text | [Optional] Specifies the name of the room type. To see a list of the available room type names, see retrieving room type names. | string | Use Rooms API's configuration.unit_name_id parameter. To get the list of available room type names in supported languages (to support translations), use the Rooms meta endpoint. | |
>>>> Occupancy | [Optional] Specifies the occupancies of the room type. | object | ||
MaxOccupancy | [Optional] Specifies the maximum number of guests allowed to stay in the room type. The value for MaxOccupancy cannot be higher than the sum of the values for MaxAdultOccupancy and MaxChildOccupancy. | integer | Use Rooms API's occupancy_details.max_guests parameter. | |
MaxAdultOccupancy | [Optional] Specifies the maximum number of adult guests allowed to stay in the room type. | integer | Use Rooms API's occupancy_details.max_adults parameter. | |
MaxChildOccupancy | [Optional] Specifies the maximum number of children physically allowed to stay in the room type. The value for MaxChildOccupancy must always be lower than that for MaxOccupancy, because you cannot have a room with only children. If this value is set to 0 for all room types, then the AcceptedGuestType element is set to AdultOnly and all children policy rules are deleted. | integer | Use Rooms API's occupancy_details.max_children parameter. Rooms API also introduces the occupancy_details.max_infants parameter and occupancy_details.max_infants_on_top parameters. | |
>>>> TPA_Extensions | [Optional] Contains the room type's additional child occupancy details. | object | ||
>>>>> Occupancy | [Optional] Specifies the children rate eligibility. | object | ||
MaxChildPayableOccupancy | [Optional] Specifies the maximum number of children that are eligible for the children rate. The value for MaxChildPayableOccupancy cannot be higher than the value of MaxChildOccupancy. Booking.com system sees any additional children under the adult rate. | integer | Use Rooms API's max_children_that_pay_children_rate parameter. | |
>>>>> SubRooms | [Optional] Specifies the subroom details. You can create subrooms only for rooms with the following room types (RoomType): - Apartment - Suite - Chalet - Bungalow - Holiday home - Villa - Mobile home Or, apartment_room_capacity is > 0. | object | ||
>>>>>> SubRoom | [Optional] Specifies individual subroom details. | object | - | |
MaxGuests | - | |||
Number | [Optional] Specifies the number of subrooms of the specified type. Only available for Bathroom or Living room | integer | Use configuration.rooms[].type specification as many times you need a specific subroom. | |
PrivateBathroom | [Optional] Specifies whether the subroom has a private bathroom (1) or not (0). Accepts: 0, 1 | boolean | - | |
RoomType | [Required] Specifies the type of subroom. Accepts: Bedroom, Living room, Bathroom | enumerated string | Use Rooms API's configuration.rooms[].type parameter. | |
>>>>>>> Amenities | [Optional] Specifies the subroom amenities. | array of Amenity | Amenities in subrooms can only be beds. | |
>>>>>>>> Amenity | [Optional] Specifies individual subroom amenity details. | object | - | |
RoomAmenityCode | [Optional] Specifies the bed type code. Optional if AmenityCode is specified. For rooms that support multiple bedrooms (such as Apartment, Suite), you must add bed types using this attribute. For a list of supported bed type codes, see OTA bed types. | enumerated string | Use Rooms API's configuration.rooms[].bed_configurations[].beds[].bed_type_id parameter. | |
AmenityCode | [Optional] Optional if RoomAmenityCode is specified. Specifies the bed type code. Same as RoomAmenityCode. Amenities in subrooms can only be beds. Introduced for compatibility with OTA_HotelInvNotifRQ. For a list of supported bed type codes, see OTA bed types. | object | Use Rooms API's configuration.rooms[].bed_configurations[].beds[].bed_type_id parameter. | |
Value | [Required for some amenities] Specifies the number of bed-type room amenities in the room. This attribute is required for some room amenities and is case sensitive. Introduced for compatibility with OTA_HotelInvNotifRQ. | integer | Use Rooms API's configuration.rooms[].bed_configurations[].beds[].bed_count parameter. | |
Quantity | [Optional] Specifies the available number of amenities of this type. Same as Value. | integer | Use Rooms API's configuration.rooms[].bed_configurations[].beds[].bed_count parameter. | |
Configuration | [Optional] Specifies whether the amenity is available in the standard or alternative room arrangement. Accepted only when RoomAmenityCode is a bed type. Possible values are: 1 (standard arrangement), 2 (alternative arrangement). This option is not available for multi-room rooms. Introduced for compatibility with OTA_HotelInvNotifRQ. | enumerated string | Use Rooms API's configuration.rooms[].bed_configurations[].is_default_configuration parameter. | |
>>>> Room | Specifies the basic room type information. Required if InvNotifType="New" | object | ||
RoomID | [Optional] Specifies the room type ID you use in your system. You can use this field to map room types across interfaces. | integer | Not supported. | |
RoomType | Specifies the room type. When specifying a room type that supports multiple bedrooms (such as Apartment, Suite), make sure to add bed types using TPA_Extensions > Subrooms > Amenities. See also creating a multi-bedroom roomtype.Required if InvNotifType="New" To see a list of all available room types, see room type codes. Apartment (PCT code 3) , Aparthotel (PCT code 5000) and Condominium (PCT code 8) require a kitchen or kitchenette in the room types to become open and bookable. For Holiday home (PCT code 5006), Holiday park (PCT code 5009), Lodge (PCT code 22) and Villa (PCT code 35) a kitchen or kitchenette is highly recommended. For more information, see Property Class Type Codes. | string or integer | Use Rooms API's unit_name_id parameter. | |
SizeMeasurement | [Optional] Specifies the numeric size of the room type. | integer | Use Rooms API's size.value parameter. | |
SizeMeasurementUnit | [Optional] Specifies the system of measurement. Possible values are sqm (metric) and sqft (imperial). The default value is sqm. | string | Use Rooms API's size.unit parameter. | |
NonSmoking | [Optional] Indicates whether smoking is allowed in the room type. 1 indicates non-smoking, 0 indicates smoking is allowed, 2 indicates both smoking and non-smoking are allowed. If you do not add this attribute, the default value is set to unknown. | boolean | Use Rooms API's smoking_policy parameter. | |
Quantity | [Optional] Specifies the number of units of a room type. | integer | Use Rooms API's number_of_units parameter. | |
>>>> Quantities | [Optional] Contains the crib and extra bed details. | object | ||
MaximumAdditionalGuests | [Optional] Specifies the maximum number of additional guests allowed to stay in the room in cribs or extra beds (rollaways). | integer | Use Rooms API's extra_beds_configuration.is_crib_and_extra_bed_allowed parameter to specify whether both extra cribs and extra beds are allowed or just one of them. | |
MaxCribs | [Optional] Specifies the maximum number of cribs in the room. | integer | Use Rooms API's extra_beds_configuration.cribs parameter. | |
MaxRollaways | [Optional] Specifies the maximum number of extra beds in the room. | integer | Use Rooms API's extra_beds_configuration.extra_beds parameter. | |
>>>> Amenities | [Optional] Specifies the property-level amenity details. | object | ||
>>>>> Amenity | [Optional] Specifies the room amenities and bed type details of the room type. For rooms with multi-bedroom support, you must add bed types under SubRooms > Amenities and not here. | object | ||
RoomAmenityCode | [Optional if AmenityCode is specified] Specifies the Room Amenity Type Code. For a list of supported amenity codes, see RMA. | enumerated string | Use Facilities API and specify an appropriate room_facility_id to create a room facility. Use Facilities API's meta endpoint to get the list of supported room amenity codes. | |
AmenityCode | [Optional if RoomAmenityCode is specified ] Specifies the room amenities and bed type. Same as RoomAmenityCode. Introduced for compatibility with OTA_HotelInvNotifRQ. For a list of supported amenity codes, see RMA. | enumerated string | Use Facilities API and specify an appropriate room_facility_id to create a room facility. Use Facilities API's meta endpoint to get the list of supported room amenity codes. | |
Value | Specifies the available number of amenities of this type. Required for some amenities. Introduced for compatibility with OTA_HotelInvNotifRQ. This attribute is required for some of the room amenities and is case sensitive. | enumerated string | For specific facilities that support multiple instances, speciy as many room_facility_instances parameters. | |
Quantity | [Optional] Specifies the available number of amenities of this type. Same as Value. This attribute is required for some room amenities and is case sensitive. | integer | For specific facilities that support multiple instances, speciy as many room_facility_instances parameters. | |
Configuration | [Optional] Indicates whether the amenity is available in the standard or alternative room arrangement. Accepted only for bed types. Possible values are: 1 (standard arrangement) 2 (alternative arrangement) | enumerated string | - |
Request body example: Room amenities
The following request body removes the Kitchenette, the desk and the minibar in the room type:
<OTA_HotelInvNotifRQ>
<SellableProducts HotelCode="6314570">
<SellableProduct InvNotifType="Overlay" InvCode="631457019">
<GuestRoom>
<Amenities>
<Amenity AmenityCode="61" Value="0"/>
<Amenity AmenityCode="28" Value="0"/>
<Amenity AmenityCode="69" Value="0"/>
</Amenities>
</GuestRoom>
</SellableProduct>
</SellableProducts>
</OTA_HotelInvNotifRQ>
Request body example: Bed types
The following request body removes the single bed (which is available in the standard room arrangement) in the room type:
<OTA_HotelInvNotifRQ>
<SellableProducts HotelCode="6314570">
<SellableProduct InvNotifType="Overlay" InvCode="631457019">
<GuestRoom>
<Amenities>
<Amenity AmenityCode="203" Value="0" Configuration="1"/>
</Amenities>
</GuestRoom>
</SellableProduct>
</SellableProducts>
</OTA_HotelInvNotifRQ>
Response body example
The following is a successful response body example:
<OTA_HotelInvNotifRS >
<Success />
</OTA_HotelInvNotifRS>
<!-- RUID: [UmFuZG9tSVYkc2RlIyh9YU4iplNAF3/GEVjlG+mTXmB9OwspcIGa+KqcbMzyiykpi6Yx5oKzRKEMxDhfrI] -->
Response body parameters
The following table describes the response elements:
| Element | Description | Type | Notes |
|---|---|---|---|
OTA_HotelInvNotifRS | Contains the response data. | object | |
> warnings | Contains potential warnings. These can help you improve your requests. | array | |
> errors | Contains potential errors. These can help you understand what went wrong with your request. | array | |
> 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. |