5min

Product Filtering

ο»ΏThe product filtering resource enables you to filter against a list of products. This endpoint behaves very much like product search, however instead of searching for and filtering against new products, you are filtering a specified list of products. This API comes in handy when you're filtering against products of a certain category, since there can be thousands of products that meet your criteria.

ο»ΏGET /catalog/products/filter

Filter against a list of predefined products.

Request

A product filter request body contains the following required properties:

product_ids - a list of unique product ID's.

A product filter request body contains the following optional properties:

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.

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.

Curl
|

Response

JSON
|

ο»Ώ

Updated 13 May 2022
Did this page help you?
Yes
No