Search Products

Searches the product catalog by keyword and returns one Product per match. Each Product carries the
distributor SKUs known for it, so it can be priced with POST /v1/product-cloud/pna.

limit is the page size, between 0 and 50; 0 or an omitted limit returns 50 Products per page.
products.total_count is the number of matching Products across all pages. When more pages exist,
products.next_cursor holds a cursor: send it as the cursor query parameter, with the same body, to
get the next page. products.next_cursor is null on the last page.

filters narrows the search. Pass back the ids returned in the filters member of an earlier response:

  • manufacturer-filters, category-filters, attribute-filters set how many filter options of each
    kind the response returns.
  • manufacturer-filter-ids and category-filter-ids select one or more manufacturer or category ids.
  • attribute-filter is a list of attribute filter values, each <attribute id>==<value id>.

The request body is limited to 1 MB.

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

The products.next_cursor of the previous page. Omit it for the first page.

Body Params

Request body for a Product search.

data
object
required

The search request.

Responses

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