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"
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/vtex-address"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

A second provider on the same verified email joins the account you already have.