How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

BigCommerce Search Filters API

The Search Filters API from BigCommerce — 3 operation(s) for search filters.

BigCommerce Search Filters API is one of 161 APIs that BigCommerce publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Search Filters. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.

This API exposes 5 operations across 3 paths, and defines 16 schemas. It is described by OpenAPI 3.0.0, at version 3.0.0.

Requests are made against a single base URL, https://api.bigcommerce.com/stores/{store_hash}/v3.

5 operations 3 paths 16 schemas 3 GET2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
3.0.0
Base URL
https://api.example.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

BigCommerce Search Filters API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-Auth-Token (X-Auth-Token). By default, every request must be authenticated.

  • X-Auth-Token — OAuth scopes | UI Name | Permission | Parameter | |:--|:--|:-| | Information & Settings | read-only | storev2informationreadonly| | Information & Settings | mo…

Paths & Operations 5

Across 3 paths, the API surfaces 5 operations — 3 GET, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Search Filters 5
GET
/settings/search/filters
BigCommerce Get Enabled Filters
getSettingsEnabledSearchFilters → 200
PUT
/settings/search/filters
BigCommerce Update Enabled Filters
updateSettingsEnabledSearchFilters 1 param body → 200
GET
/settings/search/filters/available
BigCommerce Get Available Filters
getSettingsAvailableFilters 4 params → 200
GET
/settings/search/filters/contexts
BigCommerce Get Contextual Filters
getSettingsFiltersContexts 3 params → 200
PUT
/settings/search/filters/contexts
BigCommerce Upsert Contextual Filters
upsertSettingsFiltersContexts 2 params body → 200

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are EnabledMiscFilter (10 properties), EnabledProductFilter (8 properties), EnabledBrandFilter (8 properties), EnabledCategoryFilter (7 properties). Each schema is shown below with its type and property counts.

AvailableFilter
object
EnabledCategoryFilter
object
A storefront filter for product category
7 properties
EnabledProductFilter
object
A filter that uses product options and custom field data.
8 properties
ConfiguredFiltersOverride
object
A new set of enabled Product Filtering filters which should display in a particular context, such as on a particular Channel, or while viewing a particular Cat…
2 properties
EnabledRatingFilter
object
A filter based on product review ratings.
5 properties
AvailablePriceFilter
object
5 properties
SearchFilterOverrideContextIdentifier
object
2 properties
MetaOpen
object
Response metadata.
EnabledPriceFilter
object
A filter based on the product’s price, shown as a price range on the storefront.
5 properties
AvailableOtherFilter
object
3 properties
MetaPaginationObject
object
1 property
ConfiguredFilters
array
EnabledBrandFilter
object
A storefront filter for product brand
8 properties
AvailableNormalFilter
object
4 properties
EnabledMiscFilter
object
Miscellaneous Filters which appear as a group.
10 properties
ConfiguredFilter

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

bigcommerce-search-filters-api-openapi.yml Raw ↑

Other APIs BigCommerce publishes across the network.

Big Commerce Inventory
Big Commerce Locations
Big Commerce Customer Segmentation
Big Commerce Promotions
Big Commerce Promotion Settings
Big Commerce Pickup Methods
Big Commerce Storefront Pickup Options
Big Commerce Transactions
BigCommerce Abandoned Cart Emails API
BigCommerce Abandoned Cart Settings API
BigCommerce Abandoned Carts API
BigCommerce Abandoned Carts Settings API
Where this information came from

This is an independent, third-party profile of BigCommerce Search Filters API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.