Shop Search Suggestion (deprecated)

GET Get search suggestions

GET /search_suggestion

Operation ID: Get search suggestions. Tags: search_suggestion. Security: client_id; customers_auth.

Provides keyword search functionality for products, categories, content, brands and custom suggestions. Returns suggested products, suggested categories, suggested content, suggested brands and custom suggestions for the given search phrase.

Parameters

  • q (query, string, required) The query phrase to search for.
    Minimum length: 3. Maximum length: 50.
  • count (query, integer (int32)) The maximum number of suggestions per request. Default value is 5. This affects all types of suggestions (category, product, content, brand, custom suggestions).
    Minimum: 1. Maximum: 10.
  • currency (query, string) The currency mnemonic specified for price. This parameter is effective only for product suggestions.
  • locale (query, string)

Responses

  • default

    Media type: application/json, text/xml. Schema: suggestion_result.