​
GET /catalog/products/filter

Filter against a list of predefined products.

Request

A product filter request body contains the following required properties:

product_idsrequired

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 
curl -X POST https://sandbox-api.violet.io/v1/catalog/products/filter \
-H "X-Violet-App-Id: your-app-id-here" \
-H "X-Violet-App-Secret: your-app-secret-here" \
-H "X-Violet-Token: your-token-here" \
-H "Content-type: application/json" \
-d '{"product_ids": ["product-id-123", "product-id-456"], "min_commission": 15}'

Response

JSON 
[{
    "id": "3e622ea338294552be7309faeb185af2",
    "name": "Sample Product Name",
    "description": "Sample Product ",
    "brand": "Sample Brand",
    "available": true,
    "visible": true,
    "total_sales": 0,
    "type": "PHYSICAL",
    "currency": "USD",
    "min_price": 67500,
    "max_price": 72500,
    "variants": [...],
    "offers": [...],
    "categories": [...],
    "meta": [],
    "tags": [],
    "related_product_ids": [],
    "cross_sale_product_ids": [],
    "gtins": [],
    "default_image_url": "<url to image>",
    "qty_available": 149972,
    "max_commission_rate": 10.0,
    "merchant_ids": [
        10003
    ],
    "date_created": "2018-12-11T19:45:24+0000",
    "date_last_modified": "2018-12-19T20:01:09+0000"
}, 
{
    "id": "3e622ea338294552be7309faeb185af3",
    "name": "Sample Product Name 2",
    "description": "Sample Product 2",
    "brand": "Sample Brand",
    "available": true,
    "visible": true,
    "total_sales": 0,
    "type": "PHYSICAL",
    "currency": "USD",
    "min_price": 67500,
    "max_price": 72500,
    "variants": [...],
    "offers": [...],
    "categories": [...],
    "meta": [],
    "tags": [],
    "related_product_ids": [],
    "cross_sale_product_ids": [],
    "gtins": [],
    "default_image_url": "<url to image>",
    "qty_available": 149972,
    "max_commission_rate": 10.0,
    "merchant_ids": [
        10003
    ],
    "date_created": "2018-12-11T19:45:24+0000",
    "date_last_modified": "2018-12-19T20:01:09+0000"
}]
Product SearchGet Categories