BigCommerce · Schema

Locale

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

E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS

Properties

Name Type Description
default_shopper_language string
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
store_country string
View JSON Schema on GitHub

JSON Schema

bigcommerce-locale-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Locale",
  "title": "Locale",
  "description": "The basic locale settings for a store, used to give shopper information about languages, countries, etc.",
  "type": "object",
  "properties": {
    "default_shopper_language": {
      "type": "string",
      "example": "en, en-us",
      "default": "en"
    },
    "shopper_language_selection_method": {
      "description": "Determines whether to display the storefront content in the shopper\u02bcs browser language or the shopper\u02bcs selected default language.\n\nAvailable values:\n* `browser` - language updates automatically based on the shopper browser language. Multiple languages are supported.\n* `default_shopper_language` - content is displayed in a single language based on the set `default_shopper_language`. Only the selected language is supported.",
      "type": "string",
      "example": "default_shopper_language",
      "default": "default_shopper_language",
      "enum": [
        "browser",
        "default_shopper_language"
      ]
    },
    "store_country": {
      "type": "string",
      "default": "United States"
    }
  },
  "required": [
    "default_shopper_language"
  ],
  "x-internal": false
}