Docs
Management API
Settings
Store Locale

Store Locale

Get Locale Settings

GET /settings/store/locale

Request

Returns global locale settings.

For stores with Catalyst channels, the shopper_language_selection_method field is deprecated. Using this endpoint on those stores will return a warning about the deprecation. For additional information, refer to Locale Configuration.

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.

example

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

Response

Body

object | application/json

  • data    object

    The basic locale settings for a store, used to give shopper information about languages, countries, etc.

  • meta    object

    Response metadata.

Default Example

{
"data": {
"default_shopper_language": "en",
"shopper_language_selection_method": "default_shopper_language",
"store_country": "United States"
},
"meta": {}
}

Multi-Language Example

{
"data": {
"default_shopper_language": "en",
"shopper_language_selection_method": "default_shopper_language",
"store_country": "United States"
},
"meta": {
"deprecated_fields": "shopper_language_selection_method property has been replaced for the stores with Catalyst channels by the explicit list of languages enabled on a channel. For additional information please check https://developer.bigcommerce.com/docs/store-operations/settings/locales."
}
}

Update Locale Settings

PUT /settings/store/locale

Request

Updates global locale settings.

For stores with Catalyst channels, the shopper_language_selection_method field is deprecated. Using this endpoint on those stores will return a warning about the deprecation. For additional information, refer to Locale Configuration.

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.

Body

object | application/json
The basic locale settings for a store, used to give shopper information about languages, countries, etc.

  • default_shopper_language    string
    required

    Example: en, en-us

    Default: en

  • shopper_language_selection_method    string

    Determines whether to display the storefront content in the shopperʼs browser language or the shopperʼs selected default language.

    Available values:

    • browser
      • language updates automatically based on the shopper browser language. Multiple languages are supported.
    • default_shopper_language
      • content is displayed in a single language based on the set default_shopper_language. Only the selected language is supported.

    Allowed: browser | default_shopper_language

    Example: default_shopper_language

    Default: default_shopper_language

  • store_country    string

    Default: United States

Example

{
"default_shopper_language": "en",
"shopper_language_selection_method": "default_shopper_language",
"store_country": "United States"
}

Response

Body

object | application/json

  • data    object

    The basic locale settings for a store, used to give shopper information about languages, countries, etc.

  • meta    object

    Response metadata.

Default Example

{
"data": {
"default_shopper_language": "en",
"shopper_language_selection_method": "default_shopper_language",
"store_country": "United States"
},
"meta": {}
}

Multi-Lang Example

{
"data": {
"default_shopper_language": "en",
"shopper_language_selection_method": "default_shopper_language",
"store_country": "United States"
},
"meta": {
"deprecated_fields": "shopper_language_selection_method property has been replaced for the stores with Catalyst channels by the explicit list of languages enabled on a channel. For additional information please check https://developer.bigcommerce.com/docs/store-operations/settings/locales."
}
}
Did you find what you were looking for?
Upsert Contextual FiltersGet Locale Settings