VTEX · Schema

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
sellerEmail string Seller's contact email;
sellerName string Seller's store's name.
sellerAccountName string Name of the seller's account, part of the url of their VTEX Admin.
salesChannel string Sales channel (or [trade policy](https://help.vtex.com/en/tutorial/como-funciona-uma-politica-comercial--6Xef8PZiFm40kg2STrMkMV#master-data)) associated to the seller account created.
email string
sellerType integer Type of seller, including: `1`: regular seller `2`: whitelabel seller
accountId string Marketplace's account ID
document string Company's legal document code.
hasAcceptedLegalTerms boolean Indicates if the seller has accepted the platform's legal terms and conditions.
address object
accountable object
View JSON Schema on GitHub

JSON Schema

vtex-createsellerleadrequest-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CreateSellerLeadRequest",
  "title": "",
  "required": [
    "sellerEmail",
    "sellerName",
    "sellerAccountName",
    "salesChannel",
    "email",
    "sellerType",
    "accountId",
    "accountable",
    "hasAcceptedLegalTerms",
    "address",
    "document"
  ],
  "type": "object",
  "properties": {
    "sellerEmail": {
      "type": "string",
      "description": "Seller's contact email;",
      "default": "selleremail@email.com"
    },
    "sellerName": {
      "type": "string",
      "description": "Seller's store's name.",
      "default": "Seller Name"
    },
    "sellerAccountName": {
      "type": "string",
      "description": "Name of the seller's account, part of the url of their VTEX Admin.",
      "default": "seller123"
    },
    "salesChannel": {
      "type": "string",
      "description": "Sales channel (or [trade policy](https://help.vtex.com/en/tutorial/como-funciona-uma-politica-comercial--6Xef8PZiFm40kg2STrMkMV#master-data)) associated to the seller account created.",
      "default": "1"
    },
    "email": {
      "type": "string",
      "default": "email@email.com"
    },
    "sellerType": {
      "type": "integer",
      "description": "Type of seller, including: \n\n`1`: regular seller \n\n`2`: whitelabel seller",
      "default": 1
    },
    "accountId": {
      "type": "string",
      "description": "Marketplace's account ID",
      "default": "5fb38ace-d95e-45ad-970d-ee97cce9fbcd"
    },
    "document": {
      "type": "string",
      "description": "Company's legal document code.",
      "default": "12345671000"
    },
    "hasAcceptedLegalTerms": {
      "type": "boolean",
      "description": "Indicates if the seller has accepted the platform's legal terms and conditions.",
      "default": true
    },
    "address": {
      "$ref": "#/components/schemas/address"
    },
    "accountable": {
      "$ref": "#/components/schemas/accountable"
    }
  },
  "example": {
    "sellerEmail": "selleremail@email.com",
    "sellerName": "Seller Name",
    "sellerAccountName": "seller123",
    "salesChannel": "1",
    "email": "email@email.com",
    "sellerType": 1,
    "accountId": "5fb38ace-d95e-45ad-970d-ee97cce9fbcd",
    "document": "12345671000",
    "hasAcceptedLegalTerms": true,
    "address": {
      "postalcode": "12345678",
      "complement": "Appartment 1234",
      "street": "VTEX street",
      "number": "25",
      "neighborhood": "VTEX quarter",
      "state": "RJ",
      "city": "Rio de Janeiro"
    },
    "accountable": {
      "name": "Jane Smith",
      "email": "email@email.com",
      "phone": "1234567890"
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/vtex-createsellerleadrequest"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

A second provider on the same verified email joins the account you already have.