BigCommerce
Management API
Search Filters

Settings V3

Get Enabled Filters

GET /settings/search/filters

Request

Returns a list of enabled default Product Filtering filters. These filters will be used if a store does not have contextual overrides.

Authentication

  • X-Auth-Token in header - required

Parameters

  • store_hash in path - string

example

Response

Body

object | application/json
  • data
    array[]

  • meta
    object

    Response metadata.

example-1

Update Enabled Filters

PUT /settings/search/filters

Request

Updates enabled default Product Filtering filters.

Authentication

  • X-Auth-Token in header - required

Parameters

  • store_hash in path - string
  • Content-Type in header with default of application/json - string - required

    The MIME type of the request body.

Body

array | application/json
One of:
  • collapsed_by_default
    boolean

  • display_name
    string

  • display_product_count
    boolean

  • id
    string

  • is_enabled
    boolean

  • items_to_show
    integer

    Allowed: 5 | 10 | 15

  • sort_by
    string

    Allowed: alpha | option_values | item_count

  • type
    string

    Allowed: product

example-1

Response

Body

object | application/json
  • data
    array[]

  • meta
    object

    Response metadata.

example-1

Get Available Filters

GET /settings/search/filters/available

Request

Returns a list of filters available to power Product Filtering.

Authentication

  • X-Auth-Token in header - required

Parameters

  • store_hash in path - string
  • Content-Type in header with default of application/json - string - required

    The MIME type of the request body.

  • channel_id in query - integer

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

  • category_id in query - integer

    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.

example

Response

Body

object | application/json
  • data
    array[object]

  • meta
    object

    Response metadata.

example-1

Get Contextual Filters

GET /settings/search/filters/contexts

Request

Returns a list of contextual filters enabled for a particular channel or category.

Usage Notes

Contextual filters allow you to configure the enabled filters per channel or category, so that shoppers can filter by the most relevant criteria.

The order of the returned filters will match the sort order of the filters on the storefront.

Authentication

  • X-Auth-Token in header - required

Parameters

  • store_hash in path - string
  • Accept in header with default of application/json - string - required

    The MIME type of the response body.

  • channel_id in query - integer

    Only return contextual overrides related to a particular Channel.

  • category_id in query - integer

    Only return contextual overrides related to a particular Category.

example

Response

OK

Body

object | application/json
  • data
    array[object]

  • meta
    object

example

Upsert Contextual Filters

PUT /settings/search/filters/contexts

Request

Upserts contextual filters for a particular channel or category.

Usage Notes

Contextual filters allow you to configure the enabled filters per channel or category, so that shoppers can filter by the most relevant criteria.

You can change the order of the filters on the live site by changing the order of the filters you send.

Authentication

  • X-Auth-Token in header - required

Parameters

  • store_hash in path - string
  • Content-Type in header with default of application/json - string - required

    The MIME type of the request body.

Body

array | application/json
  • context
    object

  • data
    array[]

example

Response

OK

Body

object | application/json
  • data
    array[object]

  • meta
    object

    Response metadata.

example

Did you find what you were looking for?