VTEX · Schema

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
name string Connector's name.
website string Connector's website.
logo string Connector's logo.
description string Marketplace presentation description.
segment string Marketplace segment.
availableCountries array Countries where integration is available.
connectorVtexAdminPath string
connectorApiEndpoint string
View JSON Schema on GitHub

JSON Schema

vtex-fullupdateconnector-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/fullUpdateConnector",
  "title": "",
  "required": [
    "name",
    "website",
    "logo",
    "description",
    "segment",
    "availableCountries",
    "connectorVtexAdminPath",
    "connectorApiEndpoint"
  ],
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "default": "",
      "description": "Connector's name."
    },
    "website": {
      "type": "string",
      "default": "",
      "description": "Connector's website."
    },
    "logo": {
      "type": "string",
      "default": "",
      "description": "Connector's logo."
    },
    "description": {
      "type": "string",
      "default": "",
      "description": "Marketplace presentation description."
    },
    "segment": {
      "type": "string",
      "default": "",
      "description": "Marketplace segment."
    },
    "availableCountries": {
      "type": "array",
      "default": [],
      "description": "Countries where integration is available.",
      "items": {
        "type": "string"
      }
    },
    "connectorVtexAdminPath": {
      "type": "string",
      "default": "",
      "title": "Link to Admin VTEX page where the merchant can configure integration with connector."
    },
    "connectorApiEndpoint": {
      "type": "string",
      "default": "",
      "title": "Connector's API Base URL"
    }
  },
  "example": {
    "name": "Mercado Livre Classic",
    "website": "mercadolivre.com.br",
    "logo": "https://g.foolcdn.com/art/companylogos/square/meli.png",
    "description": "MercadoLibre operates online commerce platforms in Latin America. It operates Mercado Libre Marketplace, an automated online commerce platform that enables businesses, merchants, and individuals to list merchandise and conduct sales and purchases online.",
    "segment": "OTHERS",
    "availableCountries": [
      "BRA",
      "ARG"
    ],
    "connectorVtexAdminPath": "/bridge/#/settings?openConfig=mercadolivre",
    "connectorApiEndpoint": "portal.vtexcommercestable.com/api/meliintegration/notifications"
  }
}