VTEX · Schema

FromV2

Object with information about the items been replaced. If instead of an order `replace` you wish to `remove` items, you will use the same schema naming the object `remove` instead of `from`. 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 item to be replaced.
View JSON Schema on GitHub

JSON Schema

vtex-fromv2-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/FromV2",
  "title": "FromV2",
  "required": [
    "items"
  ],
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ItemV2"
      },
      "description": "Array with information about the item to be replaced."
    }
  },
  "description": "Object with information about the items been replaced. If instead of an order `replace` you wish to `remove` items, you will use the same schema naming the object `remove` instead of `from`. For a complete example, see the description at the top of the page.",
  "example": {
    "items": [
      {
        "id": "1",
        "quantity": 1
      }
    ]
  }
}