VTEX · Schema

Address request body

Address request body.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name	Type	Description
postalCode	string	Address postal code.
countryName	string	Name of the address country.
countryCode	string	Two letter country code.
administrativeAreaLevel1	string	Name of administrative area, such as the state or province.
locality	string	Name of address locality, such as the city.
localityAreaLevel1	string	Name of the address locality area, such as the neighborhood or district.
route	string	Address route or street name.
streetNumber	string	Address street number.
contactId	string	Contact unique identifier.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CreateAddress",
  "title": "Address request body",
  "type": "object",
  "description": "Address request body.",
  "required": [
    "postalCode",
    "countryName",
    "administrativeAreaLevel1",
    "locality",
    "localityAreaLevel1",
    "route",
    "streetNumber"
  ],
  "properties": {
    "postalCode": {
      "type": "string",
      "description": "Address postal code.",
      "example": "20200-000"
    },
    "countryName": {
      "type": "string",
      "description": "Name of the address country.",
      "example": "Brasil"
    },
    "countryCode": {
      "type": "string",
      "description": "Two letter country code.",
      "example": "BR"
    },
    "administrativeAreaLevel1": {
      "type": "string",
      "description": "Name of administrative area, such as the state or province.",
      "example": "RJ"
    },
    "locality": {
      "type": "string",
      "description": "Name of address locality, such as the city.",
      "example": "Locality"
    },
    "localityAreaLevel1": {
      "type": "string",
      "description": "Name of the address locality area, such as the neighborhood or district.",
      "example": "Locality area"
    },
    "route": {
      "type": "string",
      "description": "Address route or street name.",
      "example": "51"
    },
    "streetNumber": {
      "type": "string",
      "description": "Address street number.",
      "example": "999"
    },
    "contactId": {
      "type": "string",
      "description": "Contact unique identifier.",
      "example": "1"
    }
  },
  "example": {
    "postalCode": "20200-000",
    "countryName": "Brasil",
    "countryCode": "BR",
    "administrativeAreaLevel1": "RJ",
    "locality": "Locality",
    "localityAreaLevel1": "locality area",
    "route": "51",
    "streetNumber": "999",
    "contactId": "1"
  }
}