Class: HotelFilter

HotelFilter

Hotel filter criteria


new HotelFilter()

Properties:
Name Type Argument Description
city City <optional>

City

iataCode string <optional>

IATA airport code

  • https://www.nationsonline.org/oneworld/IATA_Codes/airport_code_list.htm
geospatial object <optional>

Geospatial information, WGS-84 coordinates

Properties
Name Type Argument Description
latitude number <optional>

Latitude. E.g. 31.22

longitude number <optional>

Longitude. E.g. 121.46

distance number <optional>

Distance, empty means same city. Unit in km, maximum 80. E.g. 20

search string <optional>

Search keyword. E.g. "The Bund"

chains Array.<HotelChain> <optional>

Hotel chains (deprecated, use brands instead)

brands Array.<Brand> <optional>

Hotel brands, filtered by _id. E.g. [{_id: "6160646466cc9148978763b4"}]

hotels Array.<Hotel> <optional>

Hotels, filtered by _id. E.g. [{_id: "5b0c35b5f5ae601a24771727"}]

benefits Array.<HotelBenefit> <optional>

Benefits

highCommission boolean <optional>

Return only hotels whose high commission sample matches the requested stay. Only true enables this filter; a sample match does not guarantee the commission at booking time.

minBasePriceRange Array.<number>

Minimum base price range (per night), in merchant currency. Real-time pricing queries will significantly impact performance.

  • 0 Minimum price (inclusive), undefined means no limit. E.g. 100
  • 1 Maximum price (inclusive), undefined means no limit. E.g. 1000
Since:
  • 1.0.0