VTEX · Schema

Note

Notes with delivery information.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
type string Type of note.
date string Date of creation of the note in [UTC time format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`.
content string Content of the note.
author string Author of the note.
View JSON Schema on GitHub

JSON Schema

vtex-note-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Note",
  "title": "Note",
  "required": [
    "type",
    "date",
    "content",
    "author"
  ],
  "type": "object",
  "description": "Notes with delivery information.",
  "properties": {
    "type": {
      "type": "string",
      "description": "Type of note."
    },
    "date": {
      "type": "string",
      "description": "Date of creation of the note in [UTC time format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`."
    },
    "content": {
      "type": "string",
      "description": "Content of the note."
    },
    "author": {
      "type": "string",
      "description": "Author of the note."
    }
  },
  "example": {
    "type": "COMMENT",
    "date": "2024-03-09T01:43:16.280Z",
    "content": "Tracking Number: 10001709948594168",
    "author": "afterShip"
  }
}

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