VTEX · Schema

Region

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
IsPersisted boolean
IsRemoved boolean
Id integer
Name string
CountryCode string
ZipCode string
CultureInfoName string
View JSON Schema on GitHub

JSON Schema

vtex-region-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Region",
  "title": "Region",
  "nullable": true,
  "required": [
    "IsPersisted",
    "IsRemoved",
    "Id",
    "Name",
    "CountryCode",
    "ZipCode",
    "CultureInfoName"
  ],
  "type": "object",
  "properties": {
    "IsPersisted": {
      "type": "boolean"
    },
    "IsRemoved": {
      "type": "boolean"
    },
    "Id": {
      "type": "integer",
      "format": "int32"
    },
    "Name": {
      "type": "string"
    },
    "CountryCode": {
      "type": "string"
    },
    "ZipCode": {
      "type": "string"
    },
    "CultureInfoName": {
      "type": "string"
    }
  },
  "example": {
    "IsPersisted": true,
    "IsRemoved": false,
    "Id": 1,
    "Name": "Rio",
    "CountryCode": "BRA",
    "ZipCode": "22011050",
    "CultureInfoName": "pt-BR"
  }
}