VTEX · Schema

ClientProfileData

Structure with the customer's information. An order will be identified as corporate if any of the corporate fields are filled out (`corporateDocument`, `corporatePhone`, `corporateName` or `tradeName`).

CommerceE-CommerceRetailMarketplacePayments

Properties

Name	Type	Description
email	string	String with the customer's email.
firstName	string	String with the customer's first name.
lastName	string	String with the customer’s surname.
phone	string	String with the customer’s phone number.
document	string	String with the customer’s document number.
corporateDocument	string	String with the company’s document number, in case of corporate orders.
corporatePhone	string	String with the company’s phone number, in case of corporate orders.
corporateName	string	String with the company’s name, in case of corporate orders.
tradeName	string	String with the company’s fantasy name, in case of corporate orders.
stateInscription	string	String with the company’s state registration, in case of corporate orders.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ClientProfileData",
  "title": "ClientProfileData",
  "description": "Structure with the customer's information. An order will be identified as corporate if any of the corporate fields are filled out (`corporateDocument`, `corporatePhone`, `corporateName` or `tradeName`).",
  "required": [
    "email",
    "firstName",
    "lastName",
    "phone",
    "document",
    "corporateDocument",
    "corporatePhone",
    "corporateName",
    "tradeName",
    "stateInscription"
  ],
  "type": "object",
  "properties": {
    "email": {
      "type": "string",
      "title": "email",
      "description": "String with the customer's email.",
      "example": "[email protected]"
    },
    "firstName": {
      "type": "string",
      "title": "firstName",
      "description": "String with the customer's first name.",
      "example": "Cirilla"
    },
    "lastName": {
      "type": "string",
      "title": "lastName",
      "description": "String with the customer\u2019s surname.",
      "example": "Cintra"
    },
    "phone": {
      "type": "string",
      "title": "phone",
      "description": "String with the customer\u2019s phone number.",
      "example": "99999999999"
    },
    "document": {
      "type": "string",
      "title": "The document schema",
      "description": "String with the customer\u2019s document number.",
      "example": "99999999999"
    },
    "corporateDocument": {
      "type": "string",
      "title": "corporateDocument",
      "description": "String with the company\u2019s document number, in case of corporate orders.",
      "nullable": true,
      "example": "99999999999"
    },
    "corporatePhone": {
      "type": "string",
      "title": "corporatePhone",
      "description": "String with the company\u2019s phone number, in case of corporate orders.",
      "nullable": true,
      "example": "99999999999"
    },
    "corporateName": {
      "type": "string",
      "title": "corporateName",
      "description": "String with the company\u2019s name, in case of corporate orders.",
      "nullable": true,
      "example": "The Witcher Inc."
    },
    "tradeName": {
      "type": "string",
      "title": "tradeName",
      "description": "String with the company\u2019s fantasy name, in case of corporate orders.",
      "nullable": true,
      "example": "The Witcher"
    },
    "stateInscription": {
      "type": "string",
      "title": "stateInscription",
      "description": "String with the company\u2019s state registration, in case of corporate orders.",
      "nullable": true,
      "example": "99999999999"
    }
  }
}