Product Search

The product search resource enables you to discover the products available to you within the Violet product catalog. Using any of the filter criteria described below, you can retrieve information on products that match that criteria.

GET /products/search

Returns a list of ProductMetadata objects. API Referece: Search Products

Request

query - Use the query property to search products by their names, descriptions, variants, etc. merchant_id - use the merchant_id property to limit your search results to products of a single merchant. category_id - use the category_id property to limit your search results to products of a single category. category_slug - use the category_slug property to limit your search results to products of a single category. min_commission - use the min_commission property to limit your search results to products that offer a commission rate equal to or greater than this value. max_commission - use the max_commission property to limit your search results to products that offer a commission rate equal to or less than this value. min_price - use the min_price property to limit your search results to products that have a price equal to or greater than this price. max_price - use the max_price property to limit your search results to products that have a price equal to or less than this price. include_offers - extends the results to include available offers for each product. Pass a value of true if you wish to include product offers in the search results.

Optional Query Parameters:

page - the current page, used in pagination. size - the number of products each page should contain, used in pagination. exclude_public - excludes products that are publicly available by default to all applications. Pass a value of true if you wish to limit the product collection to only the merchants you have directly connected to. exclude_hidden - excludes products that are not visible. Pass a value of true if you wish to limit the product collection to only visible products.

Response