v1
latestOpenAPI 3.0.32026-07-173196215.4 KBList filters
Filters endpoint should be used to display a reduced list of products based on specific criteria. Often, it is the same criteria, as it was sent to show products. Multiple filter criteria can and should be combined in the single request.
As an example, the following request: /v1/filters?filters[category]=235870&filters[sale]=true&with=values will restrict the response to include only the available filter values for a specific category for products on sale. When adding the with=values parameter, the response will include values and their product counts for the combination of the filters used.
In the next section, all the available filters will be described in detail.
Note: Inactive products (sold out) are always automatically filtered out from the filter's response, and they are not taken into account for any of the described filters below.
Query parameters
Filter the products which belong to a specific category.
Retrieve a list of products matching the specified ean value, e.g.: filters[ean]=121213213.
Term-based search that returns products where the provided search term matches the name or attribute value within the products. E.g., filters[term]=blue shirts
Note: The attributes used for searching are configured in the Panel.
The API will split the searched term into multiple words. Then it will try to match each of these words against products' name and searchable attributes. The better the searched term matches against a product, the higher the product is returned. But it only requires a single word to match for a product to be returned.
A detailed explanation of the functionality can be found in SCAYLE Panel developer guide
It disables the typo tolerance value configured for this request. When the parameter is not provided, the typo tolerance is automatically applied according to the typo tolerance configuration in SCAYLE panel.
You can include only results for products with the specified is_new state.
- The filters[isNew]=true parameter only retrieves products which are considered new.
- The filters[isNew]=false parameter only retrieves products which are not considered new.
When is a product considered as new?:
Products are considered "new" when they were inserted into the shop within a period of 28 days. This value can be adjusted accordingly for each shop.
Only include results with a price less than or equal to maxPrice.
Note: The value is passed in a currency's fractional monetary unit (for example, 990 cents for 9,90 EUR).
Only include results with a price greater than or equal to minPrice.
Note: The value is passed in a currency's fractional monetary unit (for example, 990 cents for 9,90 EUR).
Only include results based on a products' sale state. Products are considered as sale when:
- Any of its variants is on sale.
- There is an active campaign and the campaignKey={campaignKey} is given.
Only include results with the specified attribute value for the attribute parameter attributeKey, e.g,: filters[brand]=882.
- Any attribute available on the products via with=attributes might be used as a filter.
Exclude results with the specified attribute value for the attribute parameter attributeKey, e.g,: filters:not[brand]=882&filters:not[color]=549.
- Any attribute available on the products via with=attributes might be used as a filter exclusion.
- You can provide multiple not filters (e.g. retrieve all products that are not red and not from brand Nike) in the query and multiple values for a single attribute e.g.: filters:not[color]=545,345
By default, if multiple filters are given, each filter is working as AND filter. This parameter accepts comma separated attribute group names and enables OR logic for these fields.
- Can be used together with attribute filters
- Example: ?filters[attributeGroup1]=123&filters[attributeGroup2]=456,789&filters[attributeGroup3]=9&orFiltersOperator=attributeGroup2,attributeGroup3 is equivalent to attributeGroup1 AND (attributeGroup2 OR attributeGroup3)
Only include results that are matching given masterKeys (also known as styleKeys). The masterKey define the siblings relation between products.
Multiple masterKeys can be given with a comma as a separator.
Only include results with the specified product's referenceKey. Multiple referenceKeys can be given with a comma as a separator.
Only retrieve products with the specified variant's referenceKey. Multiple referenceKeys can be given with a comma as a separator.
Only include results with merchantId equal to the given merchantId. Example: filters[merchantId]=130.
Only include results that have a campaign reduction for the given campaignKey. This filter can only be used together with an active campaign key and will return results that have a campaign reductions in the campaign.
Adjust prices based on the specified campaignKey. If results are not having a matching campaign, the default price is returned.
Please note, that campaign prices are stored in advance and available earlier than the campaign starts.
Also include sold out results when includeSoldOut is set to true.
The with parameter can also include related resources of a filter in the response.
- By calling with=values, the parameter will include the available filter values and product counts for each filter.
[ "values" ]
Response
successful operation
Example response
[
{
"name": "Savings",
"slug": "max_savings_percentage",
"attributeGroupType": "computed_attribute",
"type": "range",
"values": [
{
"name": "42",
"productCount": 1231,
"id": 55,
"value": "42"
}
]
}
]