Use Cases
Basic Search Parameters
Basic parameters are used in all searches and are the foundation with which additional use cases can be added.
- Unqualified searches: Occur when only general availability products are part of the request.
- To request generally available products: Only minimum required inputs are required.
| Parameter | Description |
|---|---|
| adults | Number of adults staying in the room. Type: Integer Required |
| children | Number of children staying in the room. Type: Integer |
| childrenAge | Ages of children Type: Integer |
| chainId | Unique ID that identifies hotel chain or management group in SynXis Type: Integer Required |
| primaryChannel | SynXis CR booking channel code (use for content customization) Type: String Required |
| secondaryChannel | SynXis CR booking channel code (use for content customization) Type: String Required |
| hotelId | ID that uniquely identifies a single hotel property in SynXis CR Type: Integer |
| numRooms | Number of rooms requested Type: Integer Required |
| startDate | Start date for requesting availability Type: String Format: yyyy-mm-dd Required |
| endDate | End date for requesting availability Type: String Format: yyyy-mm-dd Required |
Qualified Search
A qualified search is a Hotel Availability request with additional search criteria to find protected or otherwise private rates, exclude rates/rooms or limit the products.
Use @onlyCheckRequested=true to limit the response to only include products that match the qualified search criteria.
If this value is false or is not included in the request, then the response evaluates the requested products and publicly available products.