VTEX · Schema

CreateChannel

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
vendor string Name of the connector making the integration.
name string Name of the channel with which the integration is being established.
logo string URL redirecting to the image file of the graphic symbol that identifies the marketplace. The file must in PNG format, and the image's dimension should be 300x300 pixels.
View JSON Schema on GitHub

JSON Schema

vtex-createchannel-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CreateChannel",
  "title": "CreateChannel",
  "required": [
    "vendor",
    "name",
    "logo"
  ],
  "type": "object",
  "properties": {
    "vendor": {
      "type": "string",
      "description": "Name of the connector making the integration.",
      "default": "vtex"
    },
    "name": {
      "type": "string",
      "description": "Name of the channel with which the integration is being established.",
      "default": "Amazon"
    },
    "logo": {
      "type": "string",
      "description": "URL redirecting to the image file of the graphic symbol that identifies the marketplace. The file must in PNG format, and the image's dimension should be 300x300 pixels.",
      "default": "https://marketplace.com/logos/logo.png"
    }
  },
  "example": {
    "vendor": "vtex",
    "name": "Amazon",
    "logo": "https://marketplace.com/logos/logo.png"
  }
}