VTEX · Schema

Package

Package information.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
id string Package ID.
orderId string Order ID.
envelope string Name of the envelope used.
dimensions object Package dimensions.
weight string Package weight in grams.
totalValue integer Total value of the order.
items array Array containing information about the order's products.
categories array Array of categories.
description string Package description.
View JSON Schema on GitHub

JSON Schema

vtex-package-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Package",
  "title": "Package",
  "required": [
    "id",
    "orderId",
    "envelope",
    "dimensions",
    "weight",
    "totalValue",
    "items",
    "categories",
    "description"
  ],
  "type": "object",
  "description": "Package information.",
  "properties": {
    "id": {
      "type": "string",
      "description": "Package ID."
    },
    "orderId": {
      "type": "string",
      "description": "Order ID."
    },
    "envelope": {
      "type": "string",
      "description": "Name of the envelope used."
    },
    "dimensions": {
      "$ref": "#/components/schemas/Dimensions",
      "description": "Package dimensions."
    },
    "weight": {
      "type": "string",
      "description": "Package weight in grams."
    },
    "totalValue": {
      "type": "integer",
      "format": "int32",
      "description": "Total value of the order."
    },
    "items": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Item",
        "description": "Product general information."
      },
      "description": "Array containing information about the order's products."
    },
    "categories": {
      "type": "array",
      "items": {
        "type": "string",
        "description": "Category name."
      },
      "description": "Array of categories."
    },
    "description": {
      "type": "string",
      "description": "Package description."
    }
  },
  "example": {
    "id": "a46e5bc1-8959-459f-a094-b6e699f7214c",
    "orderId": "46369545534253-01",
    "envelope": "Foam or Plastic Containers",
    "dimensions": {
      "height": "5",
      "length": "11",
      "width": "7"
    },
    "weight": "48",
    "totalValue": 5352,
    "items": [
      {
        "id": "184",
        "name": "Chicken",
        "ean": "EAN354",
        "quantity": 8,
        "price": 669,
        "refId": "314",
        "image": "https://picsum.photos/seed/YtoZ9/128/480",
        "type": "other",
        "weight": "6"
      }
    ],
    "categories": [
      "Movies",
      "Garden",
      "Books"
    ],
    "description": "Unde deserunt libero cupiditate illum."
  }
}

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