VTEX · Schema

NotifyCarrierwithAppRequest

Object containing email, account, and dispatched order information.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
account object
email string Fill in this field if you wish to send the generated file for an email besides the ones already involved in the operation, like the carrier and VTEX account's email.
dispatchOrder object
View JSON Schema on GitHub

JSON Schema

vtex-notifycarrierwithapprequest-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/NotifyCarrierwithAppRequest",
  "title": "NotifyCarrierwithAppRequest",
  "description": "Object containing email, account, and dispatched order information.",
  "required": [
    "email",
    "dispatchOrder",
    "account"
  ],
  "type": "object",
  "properties": {
    "account": {
      "$ref": "#/components/schemas/Account"
    },
    "email": {
      "type": "string",
      "description": "Fill in this field if you wish to send the generated file for an email besides the ones already involved in the operation, like the carrier and VTEX account's email.",
      "example": "email"
    },
    "dispatchOrder": {
      "$ref": "#/components/schemas/DispatchOrder"
    }
  }
}

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