SearchRequest

Properties

Name	Type	Description
filters	string[]	Optional. List of OData filters.
datasource	string[]	Optional. List of datasources to filter by (with OR condition).
project	string[]	Optional. List of projects to filter by (with OR condition).
sourcePartner	string[]	Optional. List of source partners acronyms to filter by (with OR condition).
award	string[]	Optional. List of award ids to filter by (with OR condition).
campaignTag	string[]	Optional. List of campaign tags to filter by (with OR condition).
profileTag	string[]	Optional. List of profile tags to filter by (with OR condition).
allTag	string[]	Optional. List of tags to filter by (with OR condition).
category	string[]	Optional. List of categories to filter by (with OR condition).
facets	FacetRequest[]	Optional. List of facets which will be in the response.
scoringTag	string[]	Optional. List of tags which will be used for scoring (Beta) of results in the response.
sourceId	string[]	Optional. List of source ids to filter by (with OR condition).
location	string[]	Optional. List of location ids to filter by (with OR condition).
hasGeoShape	string[]
productAvailability	ProductAvailabilityRequest[]	Optional. List of properties for searching product availabilities.
action	string[]	Optional. List of action to filter by (with OR condition). Possible values: OrderActionWeb, RegisterActionWeb and OrderActionDsMarket.
onlyWithAvailabilities	boolean	Results are filtered by availabilities (by default true if there is an availability-filter set) otherwise the information is only added to the search result. When it is true - facets won't be returned.
amenityFeature	string[]	Optional. List of amenity feature ids to filter by (with OR condition).
starRatingName	string[]	Optional. List of star ratings names to filter by (with OR condition).
starRatingValue	double[]	Optional. List of star ratings to filter by (with OR condition).
starRatingGarni	boolean[]	Optional. List of garni options (true/false) to filter by (with OR condition).
starRatingSuperior	boolean[]	Optional. List of superrior options (true/false) to filter by (with OR condition).
numberOfRooms	double[]	Optional. List of number of rooms to filter by (with OR condition).
numberOfBeds	integer[]	Optional. List of number of beds to filter by (with OR condition).
openingHoursSpecificationDayOfWeek	string[]	Optional. List of days of week to filter by (with OR condition).
priceRange	integer[]	Optional. List of price ranges to filter by (with OR condition).
standardPrice	double[]	Optional. List of standard price values to filter by (with OR condition).
categoryTree	string[]	Use property for filtering/facet-filtering by categoryTree.
suiCategoryTree	string[]	Use property for filtering/facet-filtering by suiCategoryTree.
tag	string[]	Use property for filtering/facet-filtering by tag.
containedInPlace	string[]	Use property for filtering/facet-filtering by containedInPlace/id.
addressLocality	string[]	Use property for filtering/facet-filtering by address/addressLocality.
addressPostalCode	string[]	Use property for filtering/facet-filtering by address/postalCode.
time	string[]	Use property for filtering/facet-filtering by time.
length	string[]	Use property for filtering/facet-filtering by length.
state	string[]	Use property for filtering/facet-filtering by state.
ratingCondition	string[]	Use property for filtering/facet-filtering by rating/condition.
ratingDifficulty	string[]	Use property for filtering/facet-filtering by rating/difficulty.
elevationAscent	string[]	Use property for filtering/facet-filtering by elevation/ascent.
elevationDescent	string[]	Use property for filtering/facet-filtering by elevation/descent.
elevationMinAltitude	string[]	Use property for filtering/facet-filtering by elevation/minAltitude.
elevationMaxAltitude	string[]	Use property for filtering/facet-filtering by elevation/maxAltitude.
season	string[]	Use property for filtering/facet-filtering by season.
type	string[]	Use property for filtering by type.
combinedType	string[]	Use property for filtering by combinedType which contains parentType and parentAdditionalType.
combinedTypeTree	string[]	Use property for filtering by combinedTypeTree.
leafType	string[]	Use property for filtering by leafType which contains additionalType or type.
searchText	string	Optional. Search for contained string by the searchable fields.
searchFields	string	Optional. When name of fields are specified as a comma separated string (e.g. 'name, description, address/name') then only the selected fields will be used for searching.
select	string	Optional. When name of fields are specified as a comma separated string (e.g. 'name, description, @id, address') then only the selected fields will be returned.
currentPage	integer	Optional. By default equal 1. Determines which page of results to return in the response.
resultsPerPage	integer	Optional. By default equal 10 for regular request and 50 for pdf request. Determines how many results are in response.
orderBy	string	Optional. Determines name of field by which result will be ordered.
scoringReferencePoint	string	Optional. Coordinates of point in format 'Longitude,Latitude' (e.g.: 8.5172912,47.5722339) which will be used for scoring by distance.
onlySuggestions	boolean	Optional. Use property to get only suggestions in the response based on current request.
facetOrder	string	Optional. Use property to specify ordering direction (desc or asc) for facets results.
personalize	boolean	If true then personalisation is enabled. In this case a valid Authorization Token needs to be passed.
searchProfileName	string	If personalisation is enabled a specific search profile can be passed. Per default the first searchProfile in the user profile is used.
viewId	string	Search view identifier. A view represents a predefined set of search parameters. If specified, the search will be executed based on these view parameters, and the parameters from the current query will be applied on top of the view result. Must be a valid view identifier from the system.