Get started

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 and propertyID: Used to identify the property for room mapping
  • parameters.createGroups: Must be set to true to enable room grouping
  • parameters.outputAggregation: Specifies which attributes to use for grouping
  • supplierList: 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

  1. 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
  2. Debug Mode
    • Set debug: true to see all extracted entities
    • Unextracted values show as "none" in debug mode
  3. Language Support
    • Currently only English is supported

Best Practices

  1. Provide descriptive room names with key characteristics
  2. Include known room attributes as optional fields to improve grouping accuracy
  3. Use debug mode during integration
  4. Store groupCode if you need to reference specific groups
  5. Always include the recommended outputAggregation parameters for optimal results

To experiment with this API, use the sandbox key:
e2R4t6Y8u0i3O5p7A9s1D3f5G7h9J2k4

Language
Credentials
Header
Click Try It! to start a request and see the response here!