Settings V3
Get Locale Settings
GET /stores/{store_hash}/v3/settings/store/locale
Request
Returns global locale settings.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
- Accept in header with default of application/json - stringrequired
The MIME type of the response body.
example
Response
Body
dataobject
The basic locale settings for a store, used to give shopper information about languages, countries, etc.
metaobject
Response metadata.
Example
Update Locale Settings
PUT /stores/{store_hash}/v3/settings/store/locale
Request
Updates global locale settings.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
- Accept in header with default of application/json - stringrequired
The MIME type of the response body.
- Content-Type in header with default of application/json - stringrequired
The MIME type of the request body.
Body
The basic locale settings for a store, used to give shopper information about languages, countries, etc.
default_shopper_languagestring
requiredExample: en, en-us
Default: en
shopper_language_selection_methodstring
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 setdefault_shopper_language. Only the selected language is supported.
Allowed: browser | default_shopper_language
Example: default_shopper_language
Default: default_shopper_language
store_countrystring
Default: United States
Example
Response
Body
dataobject
The basic locale settings for a store, used to give shopper information about languages, countries, etc.
metaobject
Response metadata.