VTEX · Schema

requestSendInvoice

Object used to send invoice information related to an order.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
type string Indicates the type of the invoice. Use `"Output"` for regular orders and `"Input"` for returns.
invoiceNumber string Invoice number.
courier string Courier, if available on invoice.
trackingNumber string Tracking number.
trackingUrl string Tracking URL.
items array Array containing the order items.
issuanceDate string Issuance date.
invoiceValue integer Invoice value.
View JSON Schema on GitHub

JSON Schema

vtex-requestsendinvoice-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/requestSendInvoice",
  "title": "requestSendInvoice",
  "type": "object",
  "description": "Object used to send invoice information related to an order.",
  "required": [
    "type",
    "invoiceNumber",
    "items"
  ],
  "properties": {
    "type": {
      "type": "string",
      "description": "Indicates the type of the invoice. Use `\"Output\"` for regular orders and `\"Input\"` for returns.",
      "example": "Output"
    },
    "invoiceNumber": {
      "type": "string",
      "description": "Invoice number.",
      "example": "NFe-00002"
    },
    "courier": {
      "type": "string",
      "description": "Courier, if available on invoice.",
      "example": "courier-example"
    },
    "trackingNumber": {
      "type": "string",
      "description": "Tracking number.",
      "example": "12345678abc"
    },
    "trackingUrl": {
      "type": "string",
      "description": "Tracking URL.",
      "example": "https://courier-example.com/tracking"
    },
    "items": {
      "type": "array",
      "description": "Array containing the order items.",
      "items": {
        "type": "object",
        "description": "Specification data for each order item.",
        "required": [
          "id",
          "quantity",
          "price"
        ],
        "properties": {
          "id": {
            "type": "string",
            "description": "SKU ID.",
            "example": "6"
          },
          "quantity": {
            "type": "integer",
            "description": "Quantity of items of the SKU in the cart.",
            "example": 1
          },
          "price": {
            "type": "integer",
            "description": "Price of the item.",
            "example": 5500
          }
        }
      }
    },
    "issuanceDate": {
      "type": "string",
      "description": "Issuance date.",
      "example": "2021-05-21T10:00:00"
    },
    "invoiceValue": {
      "type": "integer",
      "description": "Invoice value.",
      "example": 6000
    }
  }
}

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