Docs
Management API
Store Locale

Store Locale

Get Locale Settings

GET /settings/store/locale

Request

Returns global locale settings.

Authentication

  • X-Auth-Token in header
    required

Parameters

  • store_hash in path - string
  • Accept in header with default of application/json - string
    required

    The MIME type of the response body.

example

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.

Example

Update Locale Settings

PUT /settings/store/locale

Request

Updates global locale settings.

Authentication

  • X-Auth-Token in header
    required

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

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.

Example

Did you find what you were looking for?