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

{
  "$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": "[email protected]"
    },
    "phone": {
      "type": "string",
      "description": "Phone number of the buyer.",
      "example": "+5521987654321"
    },
    "address": {
      "$ref": "#/components/schemas/Address"
    }
  }
}