VTEX · Schema

StorePreferencesData

Object with data from the store's configuration - stored in VTEX's License Manager.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name	Type	Description
countryCode	string	Three letters ISO code of the country (ISO 3166 ALPHA-3).
currencyCode	string	Currency code in ISO 4217. For example, `BRL`.
currencyFormatInfo	object
currencyLocale	integer	Currency Locale Code in LCID in decimal.
currencySymbol	string	Currency symbol.
timeZone	string	Time zone from where the order was made.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/StorePreferencesData",
  "title": "StorePreferencesData",
  "description": "Object with data from the store's configuration - stored in VTEX's License Manager.",
  "required": [
    "countryCode",
    "currencyCode",
    "currencyFormatInfo",
    "currencyLocale",
    "currencySymbol",
    "timeZone"
  ],
  "type": "object",
  "properties": {
    "countryCode": {
      "type": "string",
      "description": "Three letters ISO code of the country (ISO 3166 ALPHA-3)."
    },
    "currencyCode": {
      "type": "string",
      "description": "Currency code in ISO 4217. For example, `BRL`."
    },
    "currencyFormatInfo": {
      "$ref": "#/components/schemas/CurrencyFormatInfo"
    },
    "currencyLocale": {
      "type": "integer",
      "description": "Currency Locale Code in LCID in decimal."
    },
    "currencySymbol": {
      "type": "string",
      "description": "Currency symbol."
    },
    "timeZone": {
      "type": "string",
      "description": "Time zone from where the order was made."
    }
  },
  "example": {
    "countryCode": "BRA",
    "currencyCode": "BRL",
    "currencyFormatInfo": {
      "CurrencyDecimalDigits": 2,
      "CurrencyDecimalSeparator": ",",
      "CurrencyGroupSeparator": ".",
      "CurrencyGroupSize": 3,
      "StartsWithCurrencySymbol": true
    },
    "currencyLocale": 1046,
    "currencySymbol": "R$",
    "timeZone": "E. South America Standard Time"
  }
}