VTEX · Schema

Address

Address information.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
country string Buyer address country.
street string Buyer address street.
number string Buyer address number.
complement string Buyer address complement.
neighborhood string Buyer address neighborhood.
postalCode string Buyer address postal code.
city string Buyer address city.
state string Buyer address state.
View JSON Schema on GitHub

JSON Schema

vtex-address-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Address",
  "title": "Address",
  "description": "Address information.",
  "required": [
    "country",
    "street",
    "number",
    "complement",
    "neighborhood",
    "postalCode",
    "city",
    "state"
  ],
  "type": "object",
  "properties": {
    "country": {
      "type": "string",
      "description": "Buyer address country.",
      "example": "BRA"
    },
    "street": {
      "type": "string",
      "description": "Buyer address street.",
      "example": "Rua Praia de Botafogo"
    },
    "number": {
      "type": "string",
      "description": "Buyer address number.",
      "example": "518"
    },
    "complement": {
      "type": "string",
      "description": "Buyer address complement.",
      "example": "2o. andar"
    },
    "neighborhood": {
      "type": "string",
      "description": "Buyer address neighborhood.",
      "example": "Botafogo"
    },
    "postalCode": {
      "type": "string",
      "description": "Buyer address postal code.",
      "example": "22250-040"
    },
    "city": {
      "type": "string",
      "description": "Buyer address city.",
      "example": "Rio de Janeiro"
    },
    "state": {
      "type": "string",
      "description": "Buyer address state.",
      "example": "RJ"
    }
  }
}