Get product filters

POST https://app.ecwid.com/api/v3/{storeId}/products/filters

Required access scopes

Your app must have the following access scopes to make this request: read_catalog

Path params

All path params are required.

Param	Type	Description
storeId	number	Ecwid store ID.

Query params

Request requires one query param.

Name	Type	Description
filterFields	string	Comma-separated list of filters for Ecwid to return. Supported filters: "price","inventory","onsale","categories", "option_{optionName}", "attribute_{attributeName}". Example: "price,inventory,option_Size,attribute_Brand,categories". If an option or attribute has a comma or backslash in its name, escape it with a backslash: "\". I.e. option name "Color, size" will transform to "option_Color\, size" when used in query param.

Headers

The Authorization header is required.

Header	Format	Description
Authorization	Bearer secret_ab***cd	Access token of the application.

Request JSON

A JSON object with the following fields:

Field	Type	Description
params	object params	Filtering params for the request.

params

Field	Type	Description
filterFields	string	String that defines all applied filtering params, for example: "price,inventory,option_Size,attribute_Brand,categories". Full list of supported filters: "price" "inventory" "onsale" "categories" "option_{optionName}" "attribute_{attributeName}" If an option/attrubute has a comma or a backslash in its name, escape it with a backslash \. For examplem, option name "Color, size" transforms to "option_Color\, size" in the request.

Response JSON

A JSON object with the following fields: