| ||
detail: element | attribute | value |
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, } |
Name | Type | Required | Nillable | Default Value | Description |
---|---|---|---|---|---|
attributeFilters | zero or N[AttributeFilter] | false | false | Each entry allows to filter for a specific attribute-value or -range of a product-attribute. | |
currency | xsd:string | true | false | The price calculation is based on the currency. | |
currentPage | xsd:int | false | false | "1" | The current page of the search-results page. |
facetMode | NO_FACETS | STANDARD_FACETS | ALL_FACETS | false | false | "NO_FACETS" | Specifies whether the response includes no facets, only standard facets or standard and custom facets. |
lang | xsd:string | true | false | A two-digit code used for the localisation of the search-results. | |
query | xsd:string | false | false | "" | If the search-query is empty or null, a wildcard search is executed which returns all products of a shop. |
resultsPerPage | xsd:int | true | false | The number of search-results which are displayed on a single page. | |
sortBy | NAME_ASC | NAME_DESC | RELEVANCE | PRICE_ASC | PRICE_DESC | CUSTOMER_RATING | false | false | "RELEVANCE" | Determines the sorting of the search-results. |
taxAreaId | xsd:int | false | false | If the id of the tax-area is not set, the price-calculation is based on net-prices. |
| ||
detail: element | attribute | value |