Sign in

v1

latestOpenAPI 3.0.32026-07-173196215.4 KB
filters

List values

Retrieve the filter values and product counts for a specific filterGroup, for example: /v1/filters/sale/values?filters[category]=20201 will show how many products in the category "20201" are on sale and how many of them are not on sale.

Any valid attribute group can be used. Additionally, these special filters are supported: sale, categoryids, savings, prices, brands, and isnew.

get/v1/filters/{groupName}/values

Path parameters

groupNamestring required

Group Name

Query parameters

filters[category]integer[]

Filter the products which belong to a specific category.

filters[term]string

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

disableFuzzinessboolean

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.

filters[isNew]boolean

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.

filters[attributeKey]string[]

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.
filters:not[attributeKey]integer[]

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
campaignKeystring

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.

Response

successful operation

OR
OR

Example response

[
  {
    "name": "42",
    "productCount": 1231,
    "id": 55,
    "value": "42"
  }
]