VTEX · Schema

Listversion

Version information.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
id string Version ID.
date string Date when the version was created in ISO 8601 format.
document object Information about the document.
View JSON Schema on GitHub

JSON Schema

vtex-listversion-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Listversion",
  "title": "Listversion",
  "required": [
    "id",
    "date"
  ],
  "type": "object",
  "description": "Version information.",
  "properties": {
    "id": {
      "type": "string",
      "description": "Version ID."
    },
    "date": {
      "type": "string",
      "description": "Date when the version was created in ISO 8601 format."
    },
    "document": {
      "type": "object",
      "description": "Information about the document.",
      "properties": {
        "id": {
          "type": "string",
          "description": "Document ID."
        },
        "dataEntityId": {
          "type": "string",
          "description": "Data entity name."
        },
        "isNewsletterOptIn": {
          "type": "boolean",
          "description": "Indicates whether client otped to receive the store newsletter (`true`) or not (`false`).",
          "example": false,
          "nullable": true
        },
        "createdBy": {
          "type": "string",
          "description": "ID of the user who created the document."
        }
      }
    }
  }
}