VTEX · Schema

ToV2

Object with information about the new replacing items. If instead of an order `replace` you wish to `add` items, you will use the same schema naming the object `add` instead of `to`. For a complete example, see the description at the top of the page.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
items array Array with information about the replacing item.
shippingData object
View JSON Schema on GitHub

JSON Schema

vtex-tov2-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ToV2",
  "title": "ToV2",
  "required": [
    "items"
  ],
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Item1V2"
      },
      "description": "Array with information about the replacing item."
    },
    "shippingData": {
      "$ref": "#/components/schemas/ShippingDataV2"
    }
  },
  "description": "Object with information about the new replacing items. If instead of an order `replace` you wish to `add` items, you will use the same schema naming the object `add` instead of `to`. For a complete example, see the description at the top of the page.",
  "example": {
    "items": [
      {
        "id": "1",
        "quantity": 1,
        "measurementUnit": "kg",
        "unitMultiplier": 1
      }
    ],
    "shippingData": {
      "logisticsInfo": [
        {
          "itemIndex": 0,
          "slaId": "Normal",
          "deliveryChannel": "delivery",
          "addressId": "12334048475146857",
          "price": 1000
        }
      ]
    }
  }
}