Skip to content
Last updated

Room types objects

Details about room types are stored in a GuestRoom element. This page describes the elements and attributes in the GuestRoom descendants tree.

Sample XML

The sample below is an excerpt and not a valid API request.

<GuestRoom>                
  <Occupancy MaxOccupancy="2" MaxAdultOccupancy="2" MaxChildOccupancy="1"/>
  <Quantities MaximumAdditionalGuests="1" MaxCribs="1" MaxRollaways="0">
  <Room RoomID="123444"
    Quantity="2"
    NonSmoking="1"
    RoomType="Double"
    SizeMeasurement="16"
    SizeMeasurementUnit="sqm"
    LicenseNumber="AB-CD-1234"/>
  <Amenities>
    <Amenity AmenityCode="28" />                  
    <Amenity AmenityCode="69"
      Value="5" />                
    <Amenity AmenityCode="33"
      Value="1"
      Configuration="1"/>
  </Amenities>
  <Description>                    
    <Text>Deluxe Double Room with Sea View</Text>                    
  </Description>
  <TPA_Extensions>                     
    <SubRooms>
      <SubRoom RoomType="Bedroom"
        PrivateBathroom="1"
        MaxGuests="2">                         
        <Amenities>
          <Amenity AmenityCode="200"
            Value="3" />
          </Amenities>
      </SubRoom>
      <SubRoom RoomType="Living room"
        MaxGuests="2">  
        <Amenities>
          <Amenity AmenityCode="33"
            Value="2" />
          </Amenities>
        </SubRoom>
      <SubRoom RoomType="Bathroom"
        Number="2" />
    </SubRooms>
    <Occupancy MaxChildPayableOccupancy="4" />
  </TPA_Extensions>
</GuestRoom>

GuestRoom

Contains information about a single room type.

FieldDescriptionTypeRequiredNotes
OccupancyContains the room type occupancy details.object1..1-
Occupancy/
@MaxOccupancy
Specifies the maximum number of guests allowed to stay in the room type.int0..1You cannot specify Occupancy for subrooms.
Occupancy/
@MaxAdultOccupancy
Specifies the maximum number of adult guests allowed to stay in the room type.int0..1
Occupancy/
@MaxChildOccupancy
Specifies the maximum number of children allowed to stay in the room type physically.int0..1The value for @MaxChildOccupancy is always lower than that for @MaxAdultOccupancy, because you cannot have a room with only children.
QuantitiesContains the crib and extra bed details.object1..1-
Quantities/
@MaximumAdditionalGuests
Specifies the maximum number of additional guests allowed to stay in the room.int0..1
Quantities/
@MaxCribs
Specifies the maximum number of cribs in the room.int0..1
Quantities/
@MaxRollaways
Specifies the maximum number of extra beds (rollaways) in the room.int0..1
Room[@RoomID]A custom room ID, assigned by the provider, for cross-referencing and mapping purposes.stringOptionalThe Booking.com room type ID is stored in SellableProduct[@InvCode].
Room[@RoomType]The number or name of the Booking.com Room Type Code.enumRequiredAccepts the numbers and names listed under BCRT.
Room[@Quantity]The number of rooms of this type the property has.integerOptional-
Room[@NonSmoking]Specifies whether the property allows smoking in the room.extended_booleanOptionalAccepts: 1 (non-smoking), 0 (smoking allowed). Default: empty
NOTE: In Extranet, an empty value is displayed as "unknown".
Room[@SizeMeasurement]The size of the room.floatOptionalThe default measurement unit is square metres. Use Room[@SizeMeasurementUnit] to specify another unit.
Room[@SizeMeasurementUnit]The measurement unit for Room[@SizeMeasurement].enumOptionalAccepts: sqm (square metres), sqft (square feet). Default: sqm
Room[@LicenseNumber]The licence number of the room, mandatory for certain regions.stringOptionalRequired in certain countries and cities in the world. Your account manager can tell you more.
Amenities-array of AmenityOptional-
DescriptionSee Description.objectRequired-
TPA_ExtensionsSee TPA_Extensions.objectOptional-

Amenity

Contains details of a room amenity. Child of Amenities.

FieldDescriptionTypeRequiredNotes
Amenity[@AmenityCode]The Room Amenity Type Code.enumRequiredAccepts the values under RMA.
NOTE: Amenities in subrooms can only be beds.
Amenity[@Value]The type of charge for the amenity.enumOptionalRequired and only allowed when RMA code type is not boolean. Accepts: 3 (not specified), 4 (free of charge), 5 (surcharge).
Amenity[@Configuration]Specifies whether this amenity is available in the standard or the alternative room arrangement.enumOptionalRequired and only allowed when RMA code is a bed type. Accepts: 1 (standard arrangement), 2 (alternative arrangement).

Description

Contains the descriptive text for the room that appear on Booking.com. Child of GuestRoom.

FieldDescriptionTypeRequiredNotes
TextA custom, optional name for the room in English.stringOptionalIf empty, we assigned a default name based on Room[@RoomType].

TPA_Extensions

Our extensions to the OTA standard. Child of GuestRoom.

FieldDescriptionTypeRequiredNotes
SubRooms-array of SubRoomOptionalOnly allowed when Room[@RoomType] is one of the following: Apartment, Suite, Chalet, Bungalow, Holiday home, Villa, Mobile home.
Occupancy-Contains MaxChildPayableOccupancyOptional

SubRoom

Contains details of a subroom. Child of SubRooms. Use subrooms to define separate rooms within one bookable unit, as might be the case in an apartment or holiday home.

Limitations for subrooms

You can only define subrooms when Room[@RoomType] is one of the following: Apartment, Suite, Chalet, Bungalow, Holiday home, Villa, Mobile home. Also, the total number of beds in all subrooms must match the number of beds defined in Amenities. If the number does not match, [ota/OTA_HotelSummaryNotif][ota_hotelsummarynotif] will return an error when you try to open the property.

FieldDescriptionTypeRequiredNotes
SubRoom[@RoomType]The type of subroom.enumRequiredAccepts: Living room, Bedroom, Bathroom.
SubRoom[@PrivateBathroom]Specifies whether the subroom has a private bathroom.booleanOptionalOnly allowed when SubRoom[@RoomType] is Living room or Bedroom. Boolean expressed as integer. Accepts: 1 (has private bathroom), 0 (has no private bathroom). Default: 0
SubRoom[@MaxGuests]Specifies the number of guests that can stay in the room.integerRequiredOnly allowed when SubRoom[@RoomType] is Living room or Bedroom. Accepts: 120.
SubRoom[@Number]The total number of bathrooms in the bookable unit.integerOptionalOnly allowed when SubRoom[@RoomType="Bathroom"]. Accepts: 020.
Amenities-array of AmenityOptionalAmenities in subrooms can only be beds.

Occupancy

Contains details of Occupancy. Maximum number of children that are eligible for the children rate – any more children will be charged as adults.

MaxChildPayableOccupancy cannot be greater than MaxChildOccupancy

If a higher value is sent then the max value will be silently set for MaxChildPayableOccupancy

FieldDescriptionTypeRequiredNotes
Occupancy[@MaxChildPayableOccupancy]Specifies the maximum number of children allowed to stay in the room type that pay children ratesintegeroptionalThe value for MaxChildPayableOccupancy cannot be greater than MaxChildOccupancy.