VTEX · Schema

ShippingData

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
logisticsInfo array List that references the SLAs responsible for delivering each item in the order. This list must contain the same number of items as the `items` list, previously defined. For example: if the order cont
selectedAddresses array
isFob boolean Boolean that indicates whether the order's delivery is the marketplace responsibility. Optional, defaulting to false.
isMarketplaceFulfillment boolean Boolean that indicates whether the order's inventory in warehouse is the marketplace's responsibility. Optional, defaulting to false.
View JSON Schema on GitHub

JSON Schema

vtex-shippingdata-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ShippingData",
  "title": "ShippingData",
  "required": [
    "logisticsInfo",
    "selectedAddresses",
    "isFob",
    "isMarketplaceFulfillment"
  ],
  "type": "object",
  "properties": {
    "logisticsInfo": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/LogisticsInfo"
      },
      "description": "List that references the SLAs responsible for delivering each item in the order.  \n\nThis list must contain the same number of items as the `items` list, previously defined. For example: if the order contains 3 SKUs, you must describe 3 SLAs in this list, one for each SKU (even in cases where the same SLA will deliver all of them).  \n\nThe order of the SLAs in this list must also follow the same order as in the `items` list. For example: if the SLA named **Correios Express** will be responsible for delivering the SKU with ID equal to **1015**, which is found at index 0 of the `items` list, it must be in index 0 of the `logisticsInfo` list as well."
    },
    "selectedAddresses": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SelectedAddress"
      },
      "description": ""
    },
    "isFob": {
      "type": "boolean",
      "title": "isFob",
      "description": "Boolean that indicates whether the order's delivery is the marketplace responsibility. Optional, defaulting to false.",
      "example": false
    },
    "isMarketplaceFulfillment": {
      "type": "boolean",
      "title": "isMarketplaceFulfillment",
      "description": "Boolean that indicates whether the order's inventory in warehouse is the marketplace's responsibility. Optional, defaulting to false.",
      "example": false
    }
  }
}

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