Search products

Searches the products of the store we are integrated with, for example to pick the item a customer wants in exchange.

  • Shopify stores are searched live, so stock and available_for_sale are current. Each word of the query must
    match the start of a word in the product title, the vendor or a variant title, or the start of a SKU. Only
    active products are returned, with at most 25 variants each, so a product with more variants than that may
    be returned without the variant that matched.
  • Custom integrations receive the query as the search text of their products endpoint, and define how it matches.
  • BigCommerce stores are not supported and get a 400 response.

A successful request returns the list of found products.

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

Scope

erc-ecommerce-products:read

Query Params
string
required
length between 1 and 100

The text to search for. For Shopify stores, only the first 5 words are used, * and a leading - are ignored, and the other characters are matched literally.

integer
1 to 10
Defaults to 10

The maximum number of products to return.

string

The opaque cursor taken from the next link of the previous page. The products after it are returned.

string
length between 1 and 50

The brand of the provider you want to filter by. If the account is multi-brand, this parameter is required.

Responses

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