VTEX · Schema

Address1

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
postalCode string
country object
city string
state string
neighborhood string
street string
number string
complement string
coordinates array
View JSON Schema on GitHub

JSON Schema

vtex-address1-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Address1",
  "title": "Address1",
  "required": [
    "postalCode",
    "country",
    "city",
    "state",
    "neighborhood",
    "street",
    "number",
    "complement",
    "coordinates"
  ],
  "type": "object",
  "properties": {
    "postalCode": {
      "type": "string"
    },
    "country": {
      "title": "Country",
      "required": [
        "acronym",
        "name"
      ],
      "type": "object",
      "properties": {
        "acronym": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "example": {
        "acronym": "BRA",
        "name": "Brazil"
      }
    },
    "city": {
      "type": "string"
    },
    "state": {
      "type": "string"
    },
    "neighborhood": {
      "type": "string"
    },
    "street": {
      "type": "string"
    },
    "number": {
      "type": "string"
    },
    "complement": {
      "type": "string"
    },
    "coordinates": {
      "type": "array",
      "items": {
        "type": "array",
        "items": {
          "type": "number"
        }
      }
    }
  },
  "example": {
    "postalCode": "22220070",
    "country": {
      "acronym": "BRA",
      "name": "Brazil"
    },
    "city": "Rio de Janeiro",
    "state": "RJ",
    "neighborhood": "Catete",
    "street": "Artur Bernardes Street",
    "number": "100",
    "complement": "",
    "coordinates": [
      [
        -43.18228090000002,
        -22.9460398
      ]
    ]
  }
}