Hotel Search Modifiers

Additional modifiers can be added to a Hotel Search request to narrow the search results. See also Hotel Search Location Modifiers for search options specific to a hotel property location.

If Hotel Search modifiers are used, they are prioritized based on a default order, unless an alternate search priority is specified.

Important: HotelSearchModifiers must be sent in the sequence in which they are listed in the schema or else an out of sequence error is returned. For example, PermittedChains must be sent before HotelRating modifiers.

/HotelSearchModifiers

Description

@NumberOfAdults

The number of adult travelers in the booking in the NumberOfAdults attribute. If no number is input, the default number of travelers is one Adult.

@NumberOfRooms

Requests hotel availability based on the number of rooms required for the itinerary.

@MaxProperties

The maximum number of properties returned in a Hotel Search response.

@IsRelaxed

If "false", the response includes only properties that meet the specific search modifiers in the request. If "true", the response may be relaxed to include other properties that do not meet all of the requested search modifiers.

@PreferredCurrency

Indicates a preferred currency in the Search request. This applies to all providers that support Hotel segments; however, the response attributes returned vary by carrier.

@AvailableHotelsOnly

Search only for available hotels.
@NumOfRatePlans

Specifies the number of rate plans (if available) to be returned for the requested property.

  • If zero or not defined, it will default to 20
  • It increases in increments of 20, up to 99. For example, if the number is between 21 and 40 (like 33), it will return 40.
  • If more than 80, the response will return 99.

  • If the Hotel Provider has even more rates than what was returned via Hotel Super Shopper, a ‘GetMore’ token is also returned so that the Client user can issue a follow on request to receive More Rates.

This attribute is currently supported only for Hotel Super Shopper.

 
@ReturnAmenities

Indicates if amenities for a hotel property, such as pool, restaurant, and high-speed internet, are returned for all properties in Hotel Search responses. Galileo, Apollo, and Worldspan only.

/Permitted Hotel Chain

/Prohibited Hotel Chain

Permits (includes) or prohibits (excludes) properties owned by specified hotel chains in the response.
/PermittedProviders

Limits the request to responses only from the specified providers. If providers are not specified, responses from all providers provisioned for the Target Branch (Work Area Branch) may be returned.
/LoyaltyCard

Includes the traveler's Loyalty Program (Frequent Guest) for a specific hotel chain.

/HotelName

Request a hotel property using all or part of the property name.

/CorporateDiscountID

Includes a Corporate Discounts and/or Negotiated Rates between an organization and a vendor. Corporate Discount IDs and Negotiated Rate codes can be created for corporations or other organizations that offered discounts with preferred suppliers. The ID/code identifies discounts, properties, and rates that apply to a specific organization.
/RateCategory

Searches hotels by rate categories, which define the general room rate, such as standard, corporate, government, and weekend rates.

/HotelRating

Searches by a hotel property rating or range of ratings.
/SearchPriority

Hotel properties are returned in a random sequence, unless modifiers are added to the request. If Hotel Search modifiers are used, they are prioritized based on a default order, unless SearchPriority is used to specify an alternate priority order.
/HotelBedding

Search by bed type for an initial hotel search (Worldspan only). Not supported for Galileo and Apollo in an initial property search.

/Amenities Request specific amenities, such as pool, restaurant, and high-speed internet, for a hotel property.
/NumberOfChildren

Indicate the number of child travelers in the booking.

/HotelTransportation

Request a specific Transportation Type in the Hotel Search request. Hotels that support the requested Transportation Type are returned in the response.

 

Prioritizing Search Modifiers

Hotel properties are returned in a random sequence, unless modifiers are added to the request. Universal API supports prioritization for the following modifiers (in default order of priority):

  1. Corporate Discounts and Negotiated Rates
  2. Hotel Chain
  3. Property Name
  4. Distance and Direction
  5. Rate Category
  6. Rating
  7. Transportation

HotelModifiers/SearchPriority/Criteria can be used to modify the default prioritization. The Order attribute indicates the priority, while the Type attribute indicates the specific modifier.

Priority processing can be applied when multiple modifiers are included in a request, depending on the supplier. In cases where multiple values are allowed for same search modifier (e.g., chain codes), the priority is in ascending order: If HY and HI are sent as chain codes, HY is priority 2 and HI is priority 3. 

An error is returned if duplicate priority/order is sent in the request.