Introduction to Rooms API
Use the Rooms API to create listings, add rooms (also known as subrooms), add bed configuration, set occupancy limits among other tasks.
For example, you can create an Apartment type listing and add rooms to it. Adding listings to a property is an important step towards setting up availability. However, to complete the availability setup, you'll also need to define rate plans and room rates.
Understanding listing types
Creating listings based on different listing types offers guests a variety of accommodation options at a property. When managing these listings, you can define the room characteristics, bed configurations, occupancy details and so on for each type.
Considerations before creating listings
Certain listings are restricted to specific property types. You can only create listings of these specific listing types based on certain property types. To determine which property types support a specific listing type, refer to the Rooms API meta endpoint response. Look for the valid_property_ids list, which contains the IDs of property types that are compatible with each listing type.
Similarly, only some listing types support creating rooms (also known as subrooms) and multi-bed configurations. To identify these, look for listing types whose is_multi_room key is set to true in the Rooms API meta endpoint response.
Minimum required listing details
When creating a listing, make sure to include the following details:
- Listing type ID
- Listing name ID
- Bed configuration
Using partner reference name
To specify an internal name only for your reference purposes, use the partner_reference_name key and specify a name. Note that this is not available for guests. We do not perform any validations on this value.
Occupancy settings
When setting maximum occupancy limits for adults and children, note the following restrictions:
- The number of children should be less than the maximum number of guests.
- The total occupancy (sum of adults and children) must not exceed the listing's maximum occupancy limit.
- The number of children eligible for the child rate (specified by
max_children_that_pay_children_rate) cannot exceed the maximum child occupancy (max_children)
Following are the maximum occupancy limits:
- maxGuests - 50
- maxChildren - 49
- maxChildrenThatPayChildrenRate - 49
Introducing the Meta endpoint
Use the Meta endpoint to:
- Get the list of all supported listing types
- View the property category ID supported for each listing type
- View the details of the listing types such as the ID along with the supported listing names, listing name ID, and whether the listing type supports multiple rooms and beds, the occupancy limit and so on.
The open API specification contains details of all the actions supported by the Rooms API.
Inactive listing types to support backwards compatibility
The Meta endpoint returns some listing types that are inactive with the is_active key set to false. These listing types are supported only for backwards compatibility. You cannot create listings using these listing types.
Introducing the Rooms API endpoints
Use the Rooms API endpoints to: