Omni search

post

https://api.clerk.io/v3/search/omni

Search products, categories and pages at the same time

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Search request

key

string

required

Public key of the store.

visitor

string

Tracking setting for the given visitor. If set to 'auto', which is the default, an anonymous ID is generated. See Cookieless tracking: https://help.clerk.io/help/tracking/how-clerk.io-delivers-cookieless-personalisation

query

string

Search query. And empty query will return all results.

flags

array of strings

Flags set for the call. Use for example for debugging or modifying general behavior

flags

labels

array of strings

Labels to be applied to the API call

labels

content

string

ID of the content related to this request. This allows configuration of the content in My Clerk will be applied to this call: filters, merchandising rules and labels.

language

string

enum

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

merchandising

array of strings

IDs of the merchandising campaigns to be applied to this request, additionally to the campaigns configured in My Clerk. Use the trigger "API" on merchandising campaigns to trigger them using this parameter.

merchandising

searches

object

required

Multiple indexes can be searched with the same query at once.

Responses

Language

Loading…

Response

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

application/json

200OK

400Bad Request