Autocomplete

Search suggestions

Get search suggestions

get

Returns search suggestions grouped by type (products and categories) that match the provided search text. This endpoint is automatically triggered as users type in the search field.

How Autocomplete Works:

When a search text is provided, the system queries Elasticsearch using multiple match types to find the best matches:

• Multi-match query across product search text fields

• Phrase match for exact phrase matching

• Phrase prefix match for partial phrase completion

If ES_MIN_SCORE_COEFFICIENT is greater than zero, a minimum score threshold is calculated and applied to filter low-relevance results.

The search query is then processed through sorting and pre-filtering functions based on current configuration. After processing, the most relevant 4 product results are returned. These 4 results represent product IDs that are automatically displayed in the search interface.

In addition to products, category suggestions are also generated. If categories match the search text, up to 4 category suggestions are returned and displayed at the top of the autocomplete results.

Suggestion Details:

Product suggestions include product name, URL, image, price, and retail price. Category suggestions include category name, URL, and parent category hierarchy showing the full category path.

If no search text is provided, an empty list of suggestions is returned.

Caching:

Results are cached for optimal performance using a two-layer cache system: 540 seconds expiration

The cache duration is configured to balance freshness with response speed.

Query parameters

search_textstringOptional

Search query text

Example: {"value":"smartwatch","summary":"Single word search"}

Responses

200

Autocomplete suggestions retrieved successfully

application/json

Autocomplete suggestions grouped by type

get

/autocomplete/

HTTPcURLJavaScriptPython

GET /autocomplete/ HTTP/1.1
Host: sandbox.akinon.com
Accept: */*

200

Autocomplete suggestions retrieved successfully

{
  "groups": [
    {
      "suggestion_type": "product",
      "entries": [
        {
          "label": "Smart Watch X",
          "url": "https://sandbox.akinon.com/product/smart-watch-x/",
          "suggestion_type": "product",
          "extra": {
            "image": "https://cdn.akinon.com/images/products/smart-watch-x.png",
            "price": "1999.00",
            "retail_price": "2499.00",
            "product_type": "standard",
            "parent_categories": [
              "Electronics",
              "Wearables"
            ],
            "category_id": 42,
            "ANY_ADDITIONAL_PROPERTY": "anything"
          }
        }
      ]
    }
  ]
}