Update Enabled Filters

PUT

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

PUT

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

curl -X PUT https://api.bigcommerce.com/stores/store_hash/v3/settings/search/filters \
     -H "X-Auth-Token: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '[
  {
    "collapsed_by_default": false,
    "display_name": "Size",
    "display_product_count": true,
    "id": "124",
    "is_enabled": true,
    "items_to_show": 15,
    "sort_by": "alpha",
    "type": "product"
  },
  {
    "collapsed_by_default": false,
    "display_name": "Brand",
    "display_product_count": true,
    "id": "Y123=",
    "is_enabled": true,
    "items_to_show": 10,
    "sort_by": "alpha",
    "type": "brand"
  },
  {
    "collapsed_by_default": false,
    "display_name": "Color",
    "display_product_count": true,
    "id": "Q123=",
    "is_enabled": true,
    "items_to_show": 10,
    "sort_by": "alpha",
    "type": "product"
  },
  {
    "collapsed_by_default": true,
    "display_name": "Ships for Free",
    "display_product_count": true,
    "id": "Y456=",
    "is_enabled": true,
    "show_free_shipping_filter": true,
    "show_in_stock_filter": true,
    "show_is_featured_filter": true,
    "type": "other"
  }
]'

200example-1

{
  "data": [
    {
      "collapsed_by_default": false,
      "display_name": "Size",
      "display_product_count": true,
      "id": "126",
      "is_enabled": true,
      "items_to_show": 10,
      "sort_by": "alpha",
      "type": "product"
    },
    {
      "collapsed_by_default": false,
      "display_name": "Brand",
      "display_product_count": true,
      "id": "Y123=",
      "is_enabled": true,
      "items_to_show": 10,
      "sort_by": "alpha",
      "type": "brand"
    },
    {
      "collapsed_by_default": false,
      "display_name": "Color",
      "display_product_count": true,
      "id": "Q123=",
      "is_enabled": true,
      "items_to_show": 10,
      "sort_by": "alpha",
      "type": "product"
    },
    {
      "collapsed_by_default": true,
      "display_name": "Ships for Free",
      "display_product_count": true,
      "id": "Y456=",
      "is_enabled": true,
      "show_free_shipping_filter": true,
      "show_in_stock_filter": true,
      "show_is_featured_filter": true,
      "type": "other"
    }
  ],
  "meta": {}
}

Updates enabled default Product Filtering filters.

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.

Request

This endpoint expects a list of objects.

EnabledProductFilterobjectRequired

A filter that uses product options and custom field data.

EnabledPriceFilterobjectRequired

A filter based on the product’s price, shown as a price range on the storefront.

EnabledCategoryFilterobjectRequired

A storefront filter for product category

EnabledBrandFilterobjectRequired

A storefront filter for product brand

EnabledRatingFilterobjectRequired

A filter based on product review ratings.

EnabledMiscFilterobjectRequired

Miscellaneous filters which appear as a group.

Response

datalist of objectsOptional

metaobjectOptional

Response metadata.