VTEX · Schema

Agent

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
id string Agent ID.
name string Agent name.
identification string Agent identification.
phone string Agent phone number.
email string Agent email.
vehicle string Agent vehicle.
View JSON Schema on GitHub

JSON Schema

vtex-agent-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Agent",
  "title": "Agent",
  "required": [
    "id",
    "name",
    "identification",
    "phone",
    "email",
    "vehicle"
  ],
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Agent ID."
    },
    "name": {
      "type": "string",
      "description": "Agent name."
    },
    "identification": {
      "type": "string",
      "description": "Agent identification."
    },
    "phone": {
      "type": "string",
      "description": "Agent phone number."
    },
    "email": {
      "type": "string",
      "description": "Agent email."
    },
    "vehicle": {
      "type": "string",
      "description": "Agent vehicle."
    }
  },
  "example": {
    "id": "27327489234",
    "name": "Pedro",
    "identification": "020323809",
    "phone": "+57314855674",
    "email": "[email protected]",
    "vehicle": "SCOOTER"
  }
}