VTEX · Schema

Item2

CommerceE-CommerceRetailMarketplacePayments

Properties

Name	Type	Description
id	string	SKU ID.
productId	string	Product ID.
refId	string	Product Reference ID.
name	string	Product name.
value	number	Product value.
price	number	Product price.
quantity	integer	Product quantity.
shippingDiscount	integer	Discount to be applied for the shipping value.
discount	number	Discount applied on item.
priceTags	array	Array of price tags, each of which modifies the price in some way, like discounts or rates that apply to the item in the context of the order.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Item2",
  "title": "Item2",
  "type": "object",
  "required": [
    "id",
    "productId",
    "refId",
    "name",
    "value",
    "price",
    "quantity",
    "shippingDiscount",
    "discount",
    "priceTags"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "SKU ID.",
      "example": "2001023"
    },
    "productId": {
      "type": "string",
      "description": "Product ID.",
      "example": "2000492"
    },
    "refId": {
      "type": "string",
      "description": "Product Reference ID.",
      "example": "35994"
    },
    "name": {
      "type": "string",
      "description": "Product name.",
      "example": "Vaporizador Des. ColC4nia Branco"
    },
    "value": {
      "type": "number",
      "description": "Product value.",
      "example": 14.99
    },
    "price": {
      "type": "number",
      "description": "Product price.",
      "example": 14.99
    },
    "quantity": {
      "type": "integer",
      "description": "Product quantity.",
      "example": 1
    },
    "shippingDiscount": {
      "type": "integer",
      "description": "Discount to be applied for the shipping value.",
      "example": 0
    },
    "discount": {
      "type": "number",
      "description": "Discount applied on item.",
      "example": -7.5
    },
    "priceTags": {
      "type": "array",
      "description": "Array of price tags, each of which modifies the price in some way, like discounts or rates that apply to the item in the context of the order.",
      "items": {
        "$ref": "#/components/schemas/PriceTag"
      }
    }
  }
}