VTEX · Schema

ItemsRemoved

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
id string SKU ID of the item removed from the order.
name string Name of the item removed from the order.
quantity integer Quantity of items removed from the order.
price integer Total amount of items removed from the order.
unitMultiplier string Unit multiplier of the item removed from the order.
View JSON Schema on GitHub

JSON Schema

vtex-itemsremoved-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ItemsRemoved",
  "title": "ItemsRemoved",
  "required": [
    "id",
    "name",
    "quantity",
    "price",
    "unitMultiplier"
  ],
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "SKU ID of the item removed from the order."
    },
    "name": {
      "type": "string",
      "description": "Name of the item removed from the order."
    },
    "quantity": {
      "type": "integer",
      "description": "Quantity of items removed from the order."
    },
    "price": {
      "type": "integer",
      "description": "Total amount of items removed from the order."
    },
    "unitMultiplier": {
      "type": "string",
      "nullable": true,
      "description": "Unit multiplier of the item removed from the order."
    }
  },
  "example": {
    "id": "1234568358",
    "name": "Bay Max L",
    "quantity": 1,
    "price": 3290,
    "unitMultiplier": null
  }
}