VTEX · Schema

Client

Client information.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
id string Customer's identification.
email string Customer's email address.
document string Document number informed by the customer.
View JSON Schema on GitHub

JSON Schema

vtex-client-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Client",
  "title": "Client",
  "type": "object",
  "description": "Client information.",
  "properties": {
    "id": {
      "type": "string",
      "description": "Customer's identification.",
      "example": "3b1abc17-988e-4a14-8b7f-31fc6a5b955c"
    },
    "email": {
      "type": "string",
      "description": "Customer's email address.",
      "example": "[email protected]"
    },
    "document": {
      "type": "string",
      "description": "Document number informed by the customer.",
      "example": "42151783120"
    }
  }
}