Field |
Type |
Description |
persistent_room_type_code |
string
|
This is optional. This code identifies unique room types. We expect that this code persists across future availability calls. The combination of persistent_room_type_code and partner_hotel_code must be unique.
|
name |
string |
The name of this room type. Room names must summarize 1-2 significant selling points for the room, ideally in less than 50 characters. For example, you can include the bed type configuration information and the room view in the name (e.g. “One Bedroom Suite, One King Bed”, “Courtyard King”, “Garden View Room, King”, “King Studio”); or simply match the room name to brand.com
If a room name consists of only numbers and symbols, or is shorter than 4 characters, it will be blocked from Instant Booking.
|
description |
string |
Provide when all flags below are true:
Longer room description. This will be displayed to end users, and should be in the language indicated by the lang parameter. Ideal room descriptions are 250-400 characters in length. They are written in third person voice and highlight selling point for the room. For example, "This one-bedroom suite has a king bed. This corner suite also features a separate living room with a sofa bed, a well-equipped kitchen with complimentary grocery delivery services, and Paul Mitchell bath products." Language specific requirements will be applied. For example, if a room description in English consists of only numbers and symbols, or is shorter than 4 characters, it may be blocked. See supported HTML tags.
|
photos |
Photo array |
Provide when all flags below are true:
List of photos of the room.
Image file type should be able to render on modern web browsers (JPG, PNG, GIF) (TIFF is not supported). Photos should support https.
|
room_amenities |
object |
Provide when all flags below are true:
Array of number codes. Each code corresponds to an amenity for the OpenTravel Hotel Amenity Code List. A map of the standard room amenities is listed under the Supported Amenities section. Hotel and room amenities are provided in separate parts of the response, and should not overlap. For example, amenities that have no bearing on the room (e.g. “free parking”) should not be included as a room amenity, but rather as a hotel amenity. We recommend rooms offer a minimum of 10 amenities.
The standard amenities will be returned as an integer array. If an amenity does not exist in the Supported Amenities list, then the Connectivity Partner may provide their own values. Return "custom":[ ] if no custom list exists.
Example: { "standard": [1 ,2, 5, 20, 60,], "custom": ["myamenity1", "myamenity2"] }
|
max_occupancy |
map of string:int |
Provide when all flags below are true:
Maximum number of guests permitted in the room. {"number_of_adults": <num_adult>, "number_of_children": <num_child>}.
Example: {"number_of_adults": 3, "number_of_children": 2 }.
|
room_size |
map of string:int |
Provide when all flags below are true:
Area of room in given units. If given, both value and unit are required.
|
bed_configurations |
object |
Provide when all flags below are true:
A list of one or more possible configurations.
In order for a bed configuration to be valid, at least one element must exist in either the standard array or custom array. Two or more configurations mean that the room could be configured to contain either (any) of these set ups.
For example, the following snippet illustrates how to represent two bed configurations, either one king bed OR two double beds:
"bed_configurations": [
{ "standard": [ { "count": 1, "code": 3 } ] },
{ "standard": [ { "count": 2, "code": 1 } ] }
]
The following snippet illustrates how to represent one bed configuration, with a crib AND a custom bunk bed:
"bed_configurations": [
{ "standard": [ { "count": 1, "code": 900302 } ],
"custom": [ { "count": 1, "name": "Bunk bed"} ] }
]
Specify the bed types for a room, and if needed multiple bed configurations available. The type of bed provided is based on OpenTravel BED code table:
1 |
Double |
2 |
Futon |
3 |
King |
4 |
Murphy Bed |
5 |
Queen |
6 |
Sofa Bed |
7 |
Tatami Mats |
8 |
Twin |
9 |
Single |
10 |
Full |
11 |
Run of the House |
12 |
Dorm Bed |
900301 |
Roll-Away Bed |
900302 |
Crib |
900303 |
Unspecified Bed |
|
extra_bed_configurations |
object |
Provide when all flags below are true:
A list of one or more possible extra bed configurations. Extra bed configurations are configurations of extra beds that can physically be added to the RoomType for the guest on request. This service may or may not be included in the price of this room.
In order for an extra bed configuration to be valid, at least one element must exist in either the standard array or custom array. Two or more configurations mean that the room could be configured to contain either (any) of these set ups.
For examples, see bed_configurations.
|
room_view_type |
object |
Provide when all flags below are true:
Choose from available OpenTravel codes for Room View Type when available:
1 |
Airport view |
2 |
Bay view |
3 |
City view |
4 |
Courtyard view |
5 |
Golf view |
6 |
Harbor view |
7 |
Intercoastal view |
8 |
Lake view |
9 |
Marina view |
10 |
Mountain view |
11 |
Ocean view |
12 |
Pool view |
13 |
River view |
14 |
Water view |
15 |
Beach view |
16 |
Garden view |
17 |
Park view |
18 |
Forest view |
19 |
Rain forest view |
20 |
Various views |
21 |
Limited view |
22 |
Slope view |
23 |
Strip view |
24 |
Countryside view |
25 |
Sea view |
The standard room_view_type will be returned as an integer array. If a room_view_type does not exist in the table above, then the Connectivity Partner may provide their own values in the "custom" field as a string array. Return "custom":[ ] if no custom list exists.
Example: { "standard": [1,2,25], "custom": ["my own view of the dunes"] }
Example: {"standard": [2, 25], "custom": [ ]}
|
accessibility_features |
object |
Provide when all flags below are true:
Choose from available codes for accessibility features below:
900501 |
ADA compliant |
900502 |
Compliant with local laws for disabled |
900503 |
Accessible |
900504 |
Mobility accessible |
900505 |
In-room accessibility |
900506 |
Accessible for blind |
900507 |
Hearing accessible |
900508 |
Roll-in shower |
900509 |
Grab bars in bathroom |
The standard accessibility features will be returned as an integer array. If an accessibility feature does not exist in the table above, then the Connectivity Partner may provide their own values in the "custom" field as a string array. Return "custom":[ ] if no custom list exists. We encourage you to avoid custom accesibility features, as this may hinder international rollout, and not allow display of standard accessibility icons for travelers.
Example: {"standard": [900504, 900505], "custom": [ ]}
|
room_smoking_policy |
string |
We also capture hotel_smoking_policy in HotelDetails. The options specified here should not invalidate information at the Hotel level. In the case of a mismatch, Tripadvisor will not display this information.
|