VTEX · Schema

Example

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
productId string
productName string
brand string
linkText string
productReference string
categories array
link string
description string
items array
View JSON Schema on GitHub

JSON Schema

vtex-example-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Example",
  "title": "Example",
  "required": [
    "productId",
    "productName",
    "brand",
    "linkText",
    "productReference",
    "categories",
    "link",
    "description",
    "items"
  ],
  "type": "object",
  "properties": {
    "productId": {
      "type": "string"
    },
    "productName": {
      "type": "string"
    },
    "brand": {
      "type": "string"
    },
    "linkText": {
      "type": "string"
    },
    "productReference": {
      "type": "string"
    },
    "categories": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": ""
    },
    "link": {
      "type": "string"
    },
    "description": {
      "type": "string",
      "nullable": true
    },
    "items": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Item"
      },
      "description": ""
    }
  }
}