Docs
Management API
Settings
Storefront Search

Storefront Search

Get Storefront Search Settings

GET /settings/storefront/search

Request

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.

  • null indicates 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 header

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
    Channel ID to use for channel-specific settings. If omitted, you will interact with the global settings only.

example

curl --request GET \
--url 'https://api.bigcommerce.com/stores/[store_hash]/v3/settings/storefront/search' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'X-Auth-Token: {{token}}'

Response

OK, null indicates that a particular field has not been overridden on a channel level when channel level settings are requested

Body

object | application/json

  • data    object

  • meta    object

    Response metadata.

example-1

{
"data": {
"content_product_sort": "relevance",
"default_product_sort": "bestselling",
"product_filtering_enabled": true,
"search_suggest": true
},
"meta": {}
}

Update Storefront Search Settings

PUT /settings/storefront/search

Request

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.

  • null should 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 with null value in order to delete overrides per channel.

Authentication

  • X-Auth-Token in header

Parameters

  • store_hash in path - string
  • Accept in header with default of application/json - string
    required
    The MIME type of the response body.
  • Content-Type in header with default of application/json - string
    required
    The MIME type of the request body.
  • channel_id in query - integer
    Channel ID to use for channel-specific settings. If omitted, you will interact with the global settings only.

Body

object | application/json

  • content_product_sort    string
    required

    Allowed: relevance | alphaasc | alphadesc

    Default: relevance

  • default_product_sort    string
    required

    The available sorts for PLP pages.

    Allowed: featured | bestselling | newest | alphaasc | alphadesc | pricedesc | priceasc | avgcustomerreview | relevance

    Default: bestselling

  • product_filtering_enabled    boolean
    required

    Controls whether Product Filtering feature is active on the storefront. Only supports manipulation on a global level.

  • search_suggest    boolean
    required

example-1

{
"content_product_sort": "relevance",
"default_product_sort": "featured",
"product_filtering_enabled": true,
"search_suggest": true
}

Response

OK

Body

object | application/json

  • data    object

  • meta    object

    Response metadata.

example-1

{
"data": {
"content_product_sort": "relevance",
"default_product_sort": "featured",
"product_filtering_enabled": true,
"search_suggest": true
},
"meta": {}
}
Did you find what you were looking for?
Update Robots.txt SettingsGet Storefront Search Settings