VTEX · Schema

Item1V2

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
id string SKU ID of the item that will replace the previous one. If you only wish to replace the product weight, you will repeat the SKU ID used in `from`.
quantity integer Updated quantity of the item been changed.
measurementUnit string Measurement unit of the new item. The values accepted are the measurement units registered in the store's catalog. For example, `kg` for kilograms or `un` for unitary items. When you don't specify a v
unitMultiplier number Unit multiplier for item update. For example, if you wish to increase an order with three times more items than a single one, you would fill in with `3.0`.
View JSON Schema on GitHub

JSON Schema

vtex-item1v2-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Item1V2",
  "title": "Item1V2",
  "required": [
    "id",
    "quantity",
    "measurementUnit",
    "unitMultiplier"
  ],
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "SKU ID of the item that will replace the previous one. If you only wish to replace the product weight, you will repeat the SKU ID used in `from`.",
      "example": "1"
    },
    "quantity": {
      "type": "integer",
      "description": "Updated quantity of the item been changed.",
      "example": 1
    },
    "measurementUnit": {
      "type": "string",
      "description": "Measurement unit of the new item. The values accepted are the measurement units registered in the store's catalog. For example, `kg` for kilograms or `un` for unitary items. When you don't specify a value, the request gets the information from the Catalog.",
      "example": "kg"
    },
    "unitMultiplier": {
      "type": "number",
      "description": "Unit multiplier for item update. For example, if you wish to increase an order with three times more items than a single one, you would fill in with `3.0`.",
      "example": 3
    }
  },
  "example": {
    "id": "1",
    "quantity": 1,
    "measurementUnit": "kg",
    "unitMultiplier": 1
  }
}