search/search

get

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

Search for products in the store with a ranking based on sales and behavioural data as well as keyword matching.

Query Params

key

string

required

You store API key.

query

string

required

The search query.

limit

int32

required

Number of results to be returned.

visitor

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.

labels

array of strings

Required for tracking
A list of one or more text labels, used to track the labels performance in Analytics.

labels

facets

array of strings

List of facets to be returned for the products in the result. See API documentation on Facets for details.

facets

longtail

boolean

Defaults to false

Should all products matching any word in the query be in the result.

offset

int32

Defaults to 0

Offset into the result. See pagenation docs for a deeper specification on how to use pagenation.

filter

string

A attribute filter to filter the result. See API documentation on Filters for details.

exclude

array of strings

Array of product IDs to be excluded from the result. See API documentation on Filters for details.

exclude

orderby

string

Attribute to order the results by.

order

string

Defaults to asc

Should the ordering from orderby be ascending (asc) or descending (desc).

language

string

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

attributes

array of strings

Product attributes to be provided in the response. See API documentation on Product Metadata for details.

attributes

callback

string

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

debug

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

Language

Credentials

Query

Request

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200