> This page is for Developer.

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.bigcommerce.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.bigcommerce.com/_mcp/server.

# Update Locale Settings

PUT https://api.bigcommerce.com/stores/{store_hash}/v3/settings/store/locale
Content-Type: application/json

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](/developer/docs/admin/store-configuration/settings/locales-configuration).

Reference: https://docs.bigcommerce.com/developer/api-reference/rest/admin/management/settings/store-locale/update-settings-locale

## Authentication

- `X-Auth-Token` header (required) — ### OAuth scopes | UI Name | Permission | Parameter | |:--------|:-----------|:----------| | Information & Settings | modify | `store_v2_information` | | Information & Settings | read-only | `store_v2_information_read_only` | NOTE: Analytics endpoints require the Content (`store_v2_content` and `store_v2_content_read_only`) OAuth scope. ### Authentication header | Header | Argument | Description | |:-------|:---------|:------------| | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). | ### Further reading For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests). For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).

## Request

### Path parameters

- `store_hash` (string, required) — Permanent ID of the BigCommerce store.

### Headers

- `Accept` (string, required, default: application/json) — The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body.

### Body (application/json)

This endpoint expects a Locale.

- `default_shopper_language` (string, required, default: en)
- `shopper_language_selection_method` (enum, optional, default: default_shopper_language) — 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 values: `browser`, `default_shopper_language`
- `store_country` (string, optional, default: United States)

## Response

### 200

OK

- `data` (Locale, optional) — The basic locale settings for a store, used to give shopper information about languages, countries, etc.
- `meta` (MetaOpen, optional) — Response metadata.

## Errors

### 422 Unprocessable Entity Error

Provided settings could not be applied for some reason - detailed errors in the response.

- `errors` (DetailedErrors, optional)
- `instance` (string, optional)
- `status` (integer, optional) — The HTTP status code.
- `title` (string, optional) — The error title describing the particular error.
- `type` (string, optional)

## Types

### Locale

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

- `default_shopper_language` (string, required, default: en)
- `shopper_language_selection_method` (enum, optional, default: default_shopper_language) — 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 values: `browser`, `default_shopper_language`
- `store_country` (string, optional, default: United States)

### MetaOpen

Response metadata.

### DetailedErrors

## Examples

### Default locale settings

**Request**

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

**Response**

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

**SDK Code**

```python Default locale settings
import requests

url = "https://api.bigcommerce.com/stores/store_hash/v3/settings/store/locale"

payload = {
    "default_shopper_language": "en",
    "shopper_language_selection_method": "default_shopper_language",
    "store_country": "United States"
}
headers = {
    "Accept": "application/json",
    "X-Auth-Token": "<apiKey>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.json())
```

```javascript Default locale settings
const url = 'https://api.bigcommerce.com/stores/store_hash/v3/settings/store/locale';
const options = {
  method: 'PUT',
  headers: {
    Accept: 'application/json',
    'X-Auth-Token': '<apiKey>',
    'Content-Type': 'application/json'
  },
  body: '{"default_shopper_language":"en","shopper_language_selection_method":"default_shopper_language","store_country":"United States"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Default locale settings
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.bigcommerce.com/stores/store_hash/v3/settings/store/locale"

	payload := strings.NewReader("{\n  \"default_shopper_language\": \"en\",\n  \"shopper_language_selection_method\": \"default_shopper_language\",\n  \"store_country\": \"United States\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Accept", "application/json")
	req.Header.Add("X-Auth-Token", "<apiKey>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Default locale settings
require 'uri'
require 'net/http'

url = URI("https://api.bigcommerce.com/stores/store_hash/v3/settings/store/locale")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Accept"] = 'application/json'
request["X-Auth-Token"] = '<apiKey>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"default_shopper_language\": \"en\",\n  \"shopper_language_selection_method\": \"default_shopper_language\",\n  \"store_country\": \"United States\"\n}"

response = http.request(request)
puts response.read_body
```

```java Default locale settings
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.put("https://api.bigcommerce.com/stores/store_hash/v3/settings/store/locale")
  .header("Accept", "application/json")
  .header("X-Auth-Token", "<apiKey>")
  .header("Content-Type", "application/json")
  .body("{\n  \"default_shopper_language\": \"en\",\n  \"shopper_language_selection_method\": \"default_shopper_language\",\n  \"store_country\": \"United States\"\n}")
  .asString();
```

```php Default locale settings
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://api.bigcommerce.com/stores/store_hash/v3/settings/store/locale', [
  'body' => '{
  "default_shopper_language": "en",
  "shopper_language_selection_method": "default_shopper_language",
  "store_country": "United States"
}',
  'headers' => [
    'Accept' => 'application/json',
    'Content-Type' => 'application/json',
    'X-Auth-Token' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp Default locale settings
using RestSharp;

var client = new RestClient("https://api.bigcommerce.com/stores/store_hash/v3/settings/store/locale");
var request = new RestRequest(Method.PUT);
request.AddHeader("Accept", "application/json");
request.AddHeader("X-Auth-Token", "<apiKey>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"default_shopper_language\": \"en\",\n  \"shopper_language_selection_method\": \"default_shopper_language\",\n  \"store_country\": \"United States\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Default locale settings
import Foundation

let headers = [
  "Accept": "application/json",
  "X-Auth-Token": "<apiKey>",
  "Content-Type": "application/json"
]
let parameters = [
  "default_shopper_language": "en",
  "shopper_language_selection_method": "default_shopper_language",
  "store_country": "United States"
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.bigcommerce.com/stores/store_hash/v3/settings/store/locale")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PUT"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

### Multi-language locale settings

**Request**

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

**Response**

```json
{
  "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 /developer/docs/admin/store-configuration/settings/locales-configuration."
  }
}
```

**SDK Code**

```python Multi-language locale settings
import requests

url = "https://api.bigcommerce.com/stores/store_hash/v3/settings/store/locale"

payload = {
    "default_shopper_language": "en",
    "shopper_language_selection_method": "default_shopper_language",
    "store_country": "United States"
}
headers = {
    "Accept": "application/json",
    "X-Auth-Token": "<apiKey>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.json())
```

```javascript Multi-language locale settings
const url = 'https://api.bigcommerce.com/stores/store_hash/v3/settings/store/locale';
const options = {
  method: 'PUT',
  headers: {
    Accept: 'application/json',
    'X-Auth-Token': '<apiKey>',
    'Content-Type': 'application/json'
  },
  body: '{"default_shopper_language":"en","shopper_language_selection_method":"default_shopper_language","store_country":"United States"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Multi-language locale settings
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.bigcommerce.com/stores/store_hash/v3/settings/store/locale"

	payload := strings.NewReader("{\n  \"default_shopper_language\": \"en\",\n  \"shopper_language_selection_method\": \"default_shopper_language\",\n  \"store_country\": \"United States\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Accept", "application/json")
	req.Header.Add("X-Auth-Token", "<apiKey>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Multi-language locale settings
require 'uri'
require 'net/http'

url = URI("https://api.bigcommerce.com/stores/store_hash/v3/settings/store/locale")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Accept"] = 'application/json'
request["X-Auth-Token"] = '<apiKey>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"default_shopper_language\": \"en\",\n  \"shopper_language_selection_method\": \"default_shopper_language\",\n  \"store_country\": \"United States\"\n}"

response = http.request(request)
puts response.read_body
```

```java Multi-language locale settings
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.put("https://api.bigcommerce.com/stores/store_hash/v3/settings/store/locale")
  .header("Accept", "application/json")
  .header("X-Auth-Token", "<apiKey>")
  .header("Content-Type", "application/json")
  .body("{\n  \"default_shopper_language\": \"en\",\n  \"shopper_language_selection_method\": \"default_shopper_language\",\n  \"store_country\": \"United States\"\n}")
  .asString();
```

```php Multi-language locale settings
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://api.bigcommerce.com/stores/store_hash/v3/settings/store/locale', [
  'body' => '{
  "default_shopper_language": "en",
  "shopper_language_selection_method": "default_shopper_language",
  "store_country": "United States"
}',
  'headers' => [
    'Accept' => 'application/json',
    'Content-Type' => 'application/json',
    'X-Auth-Token' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp Multi-language locale settings
using RestSharp;

var client = new RestClient("https://api.bigcommerce.com/stores/store_hash/v3/settings/store/locale");
var request = new RestRequest(Method.PUT);
request.AddHeader("Accept", "application/json");
request.AddHeader("X-Auth-Token", "<apiKey>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"default_shopper_language\": \"en\",\n  \"shopper_language_selection_method\": \"default_shopper_language\",\n  \"store_country\": \"United States\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Multi-language locale settings
import Foundation

let headers = [
  "Accept": "application/json",
  "X-Auth-Token": "<apiKey>",
  "Content-Type": "application/json"
]
let parameters = [
  "default_shopper_language": "en",
  "shopper_language_selection_method": "default_shopper_language",
  "store_country": "United States"
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.bigcommerce.com/stores/store_hash/v3/settings/store/locale")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PUT"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```