Clerk.io Developer Documentation
API Reference
API ReferenceHelp ArticlesService StatusProduct UpdatesLog In

search/suggestions

get
https://api.clerk.io/v2/search/suggestions

Auto-complete the customer's search query as they type.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Suggest queries the customer could be searching for given the current typed query.

Query Params
string
required

You store API key.

string
required

The search query.

int32
required

Number of results to be returned. Maximum 10.

string

Required for tracking
Visitor ID for the given visitor.
If auto, an anonymous ID is generated.
See API documentation on Visitor Tracking for details.

string

The language used for finding results. If not provided, the language configured on the Store in my.clerk.io will be used.

string

JSONP - Wraps the response as a function call with the name of the string.

boolean
Defaults to false

When true, the response will include a JSON dictionary of the various customisations made to the results shown by Synonyms, Customized Search, Merchandising etc.

Response

Updated about 1 year ago

Language
Credentials
Query
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 year ago