Name: SearchParams

 

XML Example:
<SearchParams>
  zero or N[<attributeFilters>AttributeFilter</attributeFilters>]
  <currency>xsd:string</currency>
  <currentPage>xsd:int</currentPage>
  <facetMode>NO_FACETS | STANDARD_FACETS | ALL_FACETS</facetMode>
  <lang>xsd:string</lang>
  <query>xsd:string</query>
  <resultsPerPage>xsd:int</resultsPerPage>
  <sortBy>NAME_ASC | NAME_DESC | RELEVANCE | PRICE_ASC | PRICE_DESC | CUSTOMER_RATING</sortBy>
  <taxAreaId>xsd:int</taxAreaId>
</SearchParams>
JSON Example:
 {
   "attributeFilters": [AttributeFilter],
   "currency": String,
   "currentPage": Number,
   "facetMode": 'NO_FACETS' | 'STANDARD_FACETS' | 'ALL_FACETS',
   "lang": String,
   "query": String,
   "resultsPerPage": Number,
   "sortBy": 'NAME_ASC' | 'NAME_DESC' | 'RELEVANCE' | 'PRICE_ASC' | 'PRICE_DESC' | 'CUSTOMER_RATING',
   "taxAreaId": Number,
 }


Elements
NameTypeRequiredNillableDefault ValueDescription
attributeFilterszero or N[AttributeFilter]falsefalseEach entry allows to filter for a specific attribute-value or -range of a product-attribute.
currencyxsd:stringtruefalseThe price calculation is based on the currency.
currentPagexsd:intfalsefalse"1"The current page of the search-results page.
facetModeNO_FACETS | STANDARD_FACETS | ALL_FACETSfalsefalse"NO_FACETS"Specifies whether the response includes no facets, only standard facets or standard and custom facets.
langxsd:stringtruefalseA two-digit code used for the localisation of the search-results.
queryxsd:stringfalsefalse""If the search-query is empty or null, a wildcard search is executed which returns all products of a shop.
resultsPerPagexsd:inttruefalseThe number of search-results which are displayed on a single page.
sortByNAME_ASC | NAME_DESC | RELEVANCE | PRICE_ASC | PRICE_DESC | CUSTOMER_RATINGfalsefalse"RELEVANCE"Determines the sorting of the search-results.
taxAreaIdxsd:intfalsefalseIf the id of the tax-area is not set, the price-calculation is based on net-prices.