List Available Filters

GET

https://api.bigcommerce.com/stores/:store_hash/v3/settings/search/filters/available

GET

/stores/:store_hash/v3/settings/search/filters/available

curl https://api.bigcommerce.com/stores/store_hash/v3/settings/search/filters/available \
     -H "Accept: application/json" \
     -H "X-Auth-Token: <apiKey>"

200example-1

{
  "data": [
    {
      "id": "Y2F0Zooo123=",
      "name": "Category",
      "product_count": 7,
      "type": "category"
    },
    {
      "id": "YnJh123=",
      "name": "Brand",
      "product_count": 8,
      "type": "brand"
    },
    {
      "id": "cmF0a123",
      "name": "Rating",
      "product_count": 1,
      "type": "rating"
    },
    {
      "id": "cHJp123=",
      "name": "Price",
      "price_range_max": 300.99,
      "price_range_min": 6.75,
      "type": "price"
    },
    {
      "id": "U2l123==",
      "name": "Size",
      "product_count": 3,
      "type": "product"
    },
    {
      "id": "Q29s123=",
      "name": "Color",
      "product_count": 2,
      "type": "product"
    },
    {
      "id": "Ym9123==",
      "name": "Other",
      "type": "other"
    }
  ],
  "meta": {}
}

Returns a list of filters available to power Product Filtering.

Authentication

X-Auth-Tokenstring

OAuth scopes

UI Name	Permission	Parameter
Information & Settings	modify	`store_v2_information`
Information & Settings	read-only	`store_v2_information_read_only`

NOTE: Analytics endpoints require the Content (store_v2_content and store_v2_content_read_only) OAuth scope.

Authentication header

Header	Argument	Description
`X-Auth-Token`	`access_token`	For more about API accounts that generate `access_token`s, see our Guide to API Accounts.

Path parameters

store_hashstringRequired

Permanent ID of the BigCommerce store.

Query parameters

channel_idintegerOptional

Narrows the list of available filters based on channel ID. Only products currently assigned to the given Channel will be considered.

category_idintegerOptional

Narrows the list of available filters based on category ID. You can display settings to show products from the provided category, subcategories only, or both the category and its child categories.

Response

datalist of objectsOptional

metaobjectOptional

Response metadata.