Search Products

Searches the categories displayed on the storefront for products or product options that the shopper types in a search query.

Query Params
string

The terms to search on.

boolean
Defaults to true
string

A set of filter expressions representing the search parameters for a query: eq=equals, ne=not equals, gt=greater than, lt = less than or equals, gt = greater than or equals, lt = less than or equals, sw = starts with, or cont = contains. Optional.

string
string
string
string
string
string
string
string
string
string
string
string

The element to sort the results by and the order in which the results appear. Either ascending (a-z) or descending (z-a) order. Optional.

int32

Used to page results from a query. Indicates the maximum number of entities to return from a query. The default value is 12 and the maximum value is 200. Optional.

int32
Defaults to 0

Used to page results from a query. Indicates the zero-based offset in the complete result set where the returned entities begin. The default value is 0. Optional.

string
boolean
Defaults to true
string
string
string
string
string
string
string

Pass in * to begin a deep page operation. The response will include a nextCursorMark value. Pass this into the next call. Continue with this pattern until nextCursorMark is null.

string
string
boolean
string
boolean
boolean
Defaults to false

Optional. If true return all images instead of default images.

string
Defaults to Default
boolean
Defaults to false
string

Optional. Use a specific search-merchandizing-rule code if provided.

string
string

limits which fields are returned in the response body

Response

Language
Credentials
URL
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/json
text/plain