Search products.

Searches the products in Fresh Relevance based on your criteria.

Path Params
string
required

Website ID for the account you are posting data to.

Query Params
string
enum
required

Get data in JSON format.

Allowed:
string
required

The search value.

string
enum

The type to search for the value for. If not specified all types will be checked.

  • prid - Product id
  • vid - Variant id
  • id - Fresh Relevance product id
  • n - Product name
  • sku - Product SKU
Allowed:
integer
enum
Defaults to 0

Indicate whether to do a partial match of not.

Allowed:
integer
≥ 1
Defaults to 25

Get this number of records to return in results array (pagination).

integer
Defaults to 1

Which page of results you wish to return; First page is indexed as 1.

Responses

401

Unauthorized

403

Forbidden - Usually you are requesting data for a website you don't have access to.

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