post https://room-match.cupid.travel/room_map
The Room Map API consolidates and groups similar rooms from multiple suppliers for a given property. It analyzes room information and groups rooms with similar characteristics together.
Key Parameters
propertyName
andpropertyID
: Used to identify the property for room mappingparameters.createGroups
: Must be set totrue
to enable room groupingparameters.outputAggregation
: Specifies which attributes to use for groupingsupplierList
: List of suppliers - for each supplier you can have multiple rooms
Recommended Output Aggregation Parameters
For optimal grouping results, include at least these parameters:
- roomClass
- roomType
- bedType
- roomView
Key Features
- Room Grouping
- Rooms with similar characteristics are grouped automatically
- Same room can appear in multiple groups
- Each group has a unique
groupCode
- Empty room names appear in
unmapped
array
- Debug Mode
- Set
debug: true
to see all extracted entities - Unextracted values show as "none" in debug mode
- Set
- Language Support
- Currently only English is supported
Best Practices
- Provide descriptive room names with key characteristics
- Include known room attributes as optional fields to improve grouping accuracy
- Use debug mode during integration
- Store groupCode if you need to reference specific groups
- Always include the recommended outputAggregation parameters for optimal results
To experiment with this API, use the sandbox key:
e2R4t6Y8u0i3O5p7A9s1D3f5G7h9J2k4