BigCommerce · Schema

LocaleObject

A particular localeʼs translations.

E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS

Properties

Name	Type	Description
locale	string	Locale code for this language, such as "en", "en-us", "fr-ca".
keys	object	Language keys for the template. User-defined. Should match any lang keys used in the template.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/LocaleObject",
  "title": "LocaleObject",
  "type": "object",
  "properties": {
    "locale": {
      "type": "string",
      "example": "en",
      "description": "Locale code for this language, such as \"en\", \"en-us\", \"fr-ca\"."
    },
    "keys": {
      "type": "object",
      "example": {
        "reset_password": "To change your customer account password at {{name}} please click this link or copy and paste it into your browser:"
      },
      "description": "Language keys for the template. User-defined. Should match any lang keys used in the template."
    }
  },
  "description": "A particular locale\u02bcs translations.",
  "x-internal": false
}