VTEX · Schema

To1

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-to1-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/To1",
  "title": "To1",
  "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/ShippingData2"
    }
  },
  "example": {
    "items": [
      {
        "uniqueId": "40E763F4378E4F40AD1FE915FE1078E1",
        "id": "1",
        "productId": null,
        "productRefId": null,
        "refId": null,
        "ean": null,
        "name": null,
        "skuName": null,
        "modalType": null,
        "parentItemIndex": null,
        "parentAssemblyBinding": null,
        "assemblies": [],
        "priceValidUntil": null,
        "tax": 0,
        "price": null,
        "listPrice": null,
        "manualPrice": null,
        "manualPriceAppliedBy": null,
        "sellingPrice": null,
        "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": null,
        "productCategories": {},
        "quantity": 1,
        "seller": null,
        "sellerChain": [
          null
        ],
        "imageUrl": null,
        "detailUrl": null,
        "components": [],
        "bundleItems": [],
        "attachments": [],
        "attachmentOfferings": [],
        "offerings": [],
        "priceTags": [],
        "availability": null,
        "measurementUnit": "un",
        "unitMultiplier": 1,
        "manufacturerCode": null,
        "priceDefinition": null
      }
    ],
    "paymentData": {
      "transactions": []
    },
    "receiptData": null,
    "shippingData": {
      "logisticsInfo": [
        {
          "itemIndex": 0,
          "selectedSla": "Lenta",
          "selectedDeliveryChannel": "delivery",
          "addressId": "9ec276fd3a604eb1aa151b5333ca5db6",
          "slas": [
            {
              "id": "Lenta",
              "deliveryChannel": "delivery",
              "name": "Lenta",
              "deliveryIds": [],
              "shippingEstimate": null,
              "shippingEstimateDate": null,
              "lockTTL": null,
              "availableDeliveryWindows": [],
              "deliveryWindow": null,
              "price": 600,
              "listPrice": 600,
              "tax": 0,
              "pickupStoreInfo": {
                "isPickupStore": false,
                "friendlyName": null,
                "address": null,
                "additionalInfo": null,
                "dockId": null
              },
              "pickupPointId": null,
              "pickupDistance": null,
              "polygonName": null,
              "transitTime": null
            }
          ],
          "shipsTo": [],
          "itemId": "1",
          "deliveryChannels": [],
          "price": 600,
          "listPrice": 600,
          "shippingEstimate": null,
          "dockEstimate": null,
          "shippingEstimateDate": null,
          "lockTTL": null,
          "deliveryCompany": null,
          "polygonName": null,
          "transitTime": null,
          "sellingPrice": 600,
          "deliveryIds": [],
          "deliveryWindow": null,
          "pickupPointId": null,
          "pickupStoreInfo": {
            "isPickupStore": false,
            "friendlyName": null,
            "address": null,
            "additionalInfo": null,
            "dockId": null
          },
          "pickupDistance": null
        }
      ]
    }
  }
}