Storefront Search
Get Storefront Search Settings
GET https://api.bigcommerce.com/stores/{store_hash}/v3/settings/storefront/searchRequest
Returns search settings.
-
Channel ID can be used as a query parameter for getting channel-specific settings. If omitted, you will interact with the global settings only.
-
nullindicates that a particular field has not been overridden on a channel level when channel level settings are requested and values are inherited from global level.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
example
Response
OK, null indicates that a particular field has not been overridden on a channel level when channel level settings are requested
Body
dataobject
example-1
Update Storefront Search Settings
PUT https://api.bigcommerce.com/stores/{store_hash}/v3/settings/storefront/searchRequest
Updates search settings.
-
Channel ID can be used as a query parameter for updating channel-specific settings. If omitted, you will interact with the global settings only.
-
nullshould be supplied to delete overrides per given channel and to inherit values from global level. Partial updates are not supported and all settings should be supplied withnullvalue in order to delete overrides per channel.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
Body
content_product_sortstring
requiredAllowed: relevance | alphaasc | alphadesc
Default: relevance
default_product_sortstring
requiredThe available sorts for PLP pages.
Allowed: featured | bestselling | newest | alphaasc | alphadesc | pricedesc | priceasc | avgcustomerreview | relevance
Default: bestselling
product_filtering_enabledboolean
requiredControls whether Product Filtering feature is active on the storefront. Only supports manipulation on a global level.
search_suggestboolean
required
example-1
Response
OK
Body
dataobject