VTEX · Schema

To2

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
items array Array containing information about the item replacing the previous one.
paymentData object
receiptData object Information about the receipt after order change.
shippingData object
View JSON Schema on GitHub

JSON Schema

vtex-to2-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/To2",
  "title": "To2",
  "required": [
    "items",
    "paymentData",
    "receiptData",
    "shippingData"
  ],
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Item3"
      },
      "description": "Array containing information about the item replacing the previous one."
    },
    "paymentData": {
      "$ref": "#/components/schemas/PaymentDataV2"
    },
    "receiptData": {
      "type": "object",
      "nullable": true,
      "description": "Information about the receipt after order change.",
      "example": null
    },
    "shippingData": {
      "$ref": "#/components/schemas/ShippingData3"
    }
  },
  "example": {
    "items": [
      {
        "uniqueId": "40E763F4378E4F40AD1FE915FE1078E1",
        "id": "1",
        "productId": "1",
        "productRefId": "",
        "refId": "codrefxicaraazul",
        "ean": "8745121641",
        "name": "x\u00edcara azul",
        "skuName": "azul",
        "modalType": null,
        "parentItemIndex": null,
        "parentAssemblyBinding": null,
        "assemblies": [],
        "priceValidUntil": null,
        "tax": 0,
        "price": 5000,
        "listPrice": null,
        "manualPrice": null,
        "manualPriceAppliedBy": null,
        "sellingPrice": 5000,
        "rewardValue": 0,
        "isGift": false,
        "additionalInfo": {
          "dimension": null,
          "brandName": null,
          "brandId": null,
          "offeringInfo": null,
          "offeringType": null,
          "offeringTypeId": null,
          "categoriesIds": null,
          "productClusterId": null,
          "commercialConditionId": null
        },
        "preSaleDate": null,
        "productCategoryIds": "/1/",
        "productCategories": {
          "1": "Category"
        },
        "quantity": 1,
        "seller": "1",
        "sellerChain": [
          "1"
        ],
        "imageUrl": "http://qastore.vteximg.com.br/arquivos/ids/155394-55-55/xicara.jpg?v=636565506415770000",
        "detailUrl": "/xicara/p",
        "components": [],
        "bundleItems": [],
        "attachments": [],
        "attachmentOfferings": [],
        "offerings": [],
        "priceTags": [],
        "availability": null,
        "measurementUnit": "un",
        "unitMultiplier": 1,
        "manufacturerCode": null,
        "priceDefinition": {
          "calculatedSellingPrice": 5000,
          "total": 5000,
          "sellingPrices": [
            {
              "value": 5000,
              "quantity": 1
            }
          ]
        }
      }
    ],
    "paymentData": {
      "transactions": []
    },
    "receiptData": null,
    "shippingData": {
      "logisticsInfo": [
        {
          "itemIndex": 0,
          "selectedSla": "Lenta",
          "selectedDeliveryChannel": "delivery",
          "addressId": "9ec276fd3a604eb1aa151b5333ca5db6",
          "slas": [
            {
              "id": "Lenta",
              "deliveryChannel": "delivery",
              "name": "Lenta",
              "deliveryIds": [
                {
                  "courierId": "1c083bf",
                  "warehouseId": "1_1",
                  "dockId": "1",
                  "courierName": "Donkey",
                  "quantity": 1,
                  "kitItemDetails": [],
                  "accountCarrierName": null
                }
              ],
              "shippingEstimate": "25bd",
              "shippingEstimateDate": "2023-08-30T10:17:24.6436519Z",
              "lockTTL": "12d",
              "availableDeliveryWindows": [],
              "deliveryWindow": null,
              "price": 600,
              "listPrice": 180,
              "tax": 0,
              "pickupStoreInfo": {
                "isPickupStore": false,
                "friendlyName": null,
                "address": null,
                "additionalInfo": null,
                "dockId": null
              },
              "pickupPointId": null,
              "pickupDistance": null,
              "polygonName": "",
              "transitTime": "25bd"
            },
            {
              "id": "Normal",
              "deliveryChannel": "delivery",
              "name": "Normal",
              "deliveryIds": [
                {
                  "courierId": "1",
                  "warehouseId": "1_1",
                  "dockId": "1",
                  "courierName": "Transportadora",
                  "quantity": 1,
                  "kitItemDetails": [],
                  "accountCarrierName": null
                }
              ],
              "shippingEstimate": "3bd",
              "shippingEstimateDate": null,
              "lockTTL": "12d",
              "availableDeliveryWindows": [],
              "deliveryWindow": null,
              "price": 500,
              "listPrice": 500,
              "tax": 0,
              "pickupStoreInfo": {
                "isPickupStore": false,
                "friendlyName": null,
                "address": null,
                "additionalInfo": null,
                "dockId": null
              },
              "pickupPointId": null,
              "pickupDistance": null,
              "polygonName": "",
              "transitTime": "3bd"
            },
            {
              "id": "Pickup",
              "deliveryChannel": "delivery",
              "name": "Pickup",
              "deliveryIds": [
                {
                  "courierId": "ech018654",
                  "warehouseId": "1_1",
                  "dockId": "1",
                  "courierName": "Retirada",
                  "quantity": 1,
                  "kitItemDetails": [],
                  "accountCarrierName": null
                }
              ],
              "shippingEstimate": "25bd",
              "shippingEstimateDate": null,
              "lockTTL": "12d",
              "availableDeliveryWindows": [],
              "deliveryWindow": null,
              "price": 700,
              "listPrice": 700,
              "tax": 0,
              "pickupStoreInfo": {
                "isPickupStore": false,
                "friendlyName": null,
                "address": null,
                "additionalInfo": null,
                "dockId": null
              },
              "pickupPointId": null,
              "pickupDistance": null,
              "polygonName": "",
              "transitTime": "25bd"
            }
          ],
          "shipsTo": [
            "BRA"
          ],
          "itemId": "1",
          "deliveryChannels": [
            {
              "id": "delivery"
            }
          ],
          "price": 600,
          "listPrice": 180,
          "shippingEstimate": "25bd",
          "dockEstimate": null,
          "shippingEstimateDate": "2023-08-30T10:17:24.6436519Z",
          "lockTTL": "12d",
          "deliveryCompany": null,
          "polygonName": "",
          "transitTime": "25bd",
          "sellingPrice": 600,
          "deliveryIds": [
            {
              "courierId": "1c083bf",
              "warehouseId": "1_1",
              "dockId": "1",
              "courierName": "Donkey",
              "quantity": 1,
              "kitItemDetails": null,
              "accountCarrierName": "qastoreecho"
            }
          ],
          "deliveryWindow": null,
          "pickupPointId": null,
          "pickupStoreInfo": {
            "isPickupStore": false,
            "friendlyName": null,
            "address": null,
            "additionalInfo": null,
            "dockId": null
          },
          "pickupDistance": null
        }
      ]
    }
  }
}

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