VTEX · Schema

Document

Document information.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name	Type	Description
id	string	ID of the document.
dataEntityId	string	Data entity name.
accountId	string	ID of the VTEX account.
accountName	string	Name of the VTEX account.
followers	array	Followers.
schemas	array	Schemas which the document is compliant with.
email	string	User email.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Document",
  "title": "Document",
  "required": [
    "id",
    "dataEntityId",
    "accountId",
    "accountName",
    "followers"
  ],
  "type": "object",
  "description": "Document information.",
  "properties": {
    "id": {
      "type": "string",
      "description": "ID of the document."
    },
    "dataEntityId": {
      "type": "string",
      "description": "Data entity name."
    },
    "accountId": {
      "type": "string",
      "description": "ID of the VTEX account."
    },
    "accountName": {
      "type": "string",
      "description": "Name of the VTEX account."
    },
    "followers": {
      "type": "array",
      "description": "Followers.",
      "deprecated": true,
      "items": {
        "type": "string",
        "description": "Follower."
      }
    },
    "schemas": {
      "type": "array",
      "description": "Schemas which the document is compliant with.",
      "items": {
        "type": "string",
        "description": "Schema name."
      }
    },
    "email": {
      "type": "string",
      "description": "User email."
    }
  }
}