View on GitHub

Open Commerce Search Stack

The Documentation

SuggestApi

All URIs are relative to http://localhost

Method HTTP request Description
suggest GET /suggest-api/v1/{indexname}/suggest Autocomplete the user input

suggest

List suggest(indexname, userQuery, limit, filter)

Autocomplete the user input

Runs a suggestion request on the data of a certain index.

Parameters

Name Type Description Notes
indexname String index name that should be searched for autocompletions [default to null]
userQuery String the simple raw query typed by the user [default to null]
limit Integer A optional limit for the suggestions [optional] [default to null]
filter String Optional comma-separated list of filter values. [optional] [default to null]

Return type

List

Authorization

basic-auth

HTTP request headers