VTEX · Schema

Sender

User's logged account in the VTEX store.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
cnpj string CNPJ code of the VTEX account responsible for sending the package.
fantasyName string Fantasy name of the VTEX account responsible for sending the package.
stateRegistration string State Registration code of the VTEX account responsible for sending the package.
id string VTEX account's ID.
name string Name of the VTEX account responsible for sending the package.
address object
email string Email of the VTEX account responsible for sending the package.
phone string Sender's contact number.
View JSON Schema on GitHub

JSON Schema

vtex-sender-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Sender",
  "title": "Sender",
  "description": "User's logged account in the VTEX store.",
  "required": [
    "cnpj",
    "fantasyName",
    "stateRegistration",
    "id",
    "name",
    "address",
    "email",
    "phone"
  ],
  "type": "object",
  "properties": {
    "cnpj": {
      "type": "string",
      "description": "CNPJ code of the VTEX account responsible for sending the package.",
      "example": "81.316.120/0001-02"
    },
    "fantasyName": {
      "type": "string",
      "description": "Fantasy name of the VTEX account responsible for sending the package.",
      "example": "Carrier 123",
      "nullable": true
    },
    "stateRegistration": {
      "type": "string",
      "description": "State Registration code of the VTEX account responsible for sending the package.",
      "example": "9843759348",
      "nullable": true
    },
    "id": {
      "type": "string",
      "description": "VTEX account's ID.",
      "example": "accountId",
      "nullable": true
    },
    "name": {
      "type": "string",
      "description": "Name of the VTEX account responsible for sending the package.",
      "example": "Store LTDA"
    },
    "address": {
      "$ref": "#/components/schemas/Address"
    },
    "email": {
      "type": "string",
      "description": "Email of the VTEX account responsible for sending the package.",
      "example": "email@email.com",
      "nullable": true
    },
    "phone": {
      "type": "string",
      "description": "Sender's contact number.",
      "example": "+5511111111111",
      "nullable": true
    }
  },
  "example": {
    "cnpj": "00000000000000",
    "fantasyName": null,
    "stateRegistration": null,
    "id": null,
    "name": "LTDA",
    "address": {
      "postalCode": "03475015",
      "country": {
        "code": "Brasil",
        "name": "Brasil"
      },
      "subregion1": {
        "code": "SP",
        "name": "SP"
      },
      "subregion2": {
        "code": "S\u00e3o Paulo",
        "name": "S\u00e3o Paulo"
      },
      "subregion3": {
        "code": "Vila Antonieta",
        "name": "Vila Antonieta"
      },
      "street": "Rua Exemplo",
      "number": "01",
      "complement": "",
      "location": null
    },
    "email": null,
    "phone": "+5511111111111"
  }
}

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-sender"
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.