VTEX · Schema

Buyer

Buyer information.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
id string VTEX buyer ID. The unique identifier of the buyer.
firstName string First name of the buyer.
lastName string Last name of the buyer.
document string Document number of the buyer.
documentType string Type of document of the buyer, which depends on their country.
email string Email of the buyer.
phone string Phone number of the buyer.
address object
View JSON Schema on GitHub

JSON Schema

vtex-buyer-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Buyer",
  "title": "Buyer",
  "description": "Buyer information.",
  "required": [
    "id",
    "firstName",
    "lastName",
    "document",
    "documentType",
    "email",
    "phone",
    "address"
  ],
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "VTEX buyer ID. The unique identifier of the buyer.",
      "example": "c1245228-1c68-11e6-94ac-0afa86a846a5"
    },
    "firstName": {
      "type": "string",
      "description": "First name of the buyer.",
      "example": "John"
    },
    "lastName": {
      "type": "string",
      "description": "Last name of the buyer.",
      "example": "Doe"
    },
    "document": {
      "type": "string",
      "description": "Document number of the buyer.",
      "example": "012.345.678-90"
    },
    "documentType": {
      "type": "string",
      "description": "Type of document of the buyer, which depends on their country.",
      "example": "CPF"
    },
    "email": {
      "type": "string",
      "description": "Email of the buyer.",
      "example": "john@doe.com"
    },
    "phone": {
      "type": "string",
      "description": "Phone number of the buyer.",
      "example": "+5521987654321"
    },
    "address": {
      "$ref": "#/components/schemas/Address"
    }
  }
}

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-buyer"
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.