VTEX · Schema

Item2V2

CommerceE-CommerceRetailMarketplacePayments

Properties

Name	Type	Description
id	string	SKU ID of the item been replaced.
quantity	integer	Quantity of items been replaced.
price	string	Shipping price for the item been replaced. It does not account for the whole order's shipping price and is presented in cents.
measurementUnit	string	Measurement unit of the item been replaced. For example, `kg` for kilograms or `un` for unitary items.
unitMultiplier	integer	Unit multiplier for item been update.
sellingPrice	string	Selling price of the item been replaced.
name	string	Name of the item been replaced.
detailUrl	string	URL slug of the item been replaced.
imageUrl	string	Image URL slug of the item been replaced.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Item2V2",
  "title": "Item2V2",
  "required": [
    "id",
    "quantity",
    "price",
    "measurementUnit",
    "unitMultiplier",
    "sellingPrice",
    "name",
    "detailUrl",
    "imageUrl"
  ],
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "SKU ID of the item been replaced.",
      "example": "1"
    },
    "quantity": {
      "type": "integer",
      "description": "Quantity of items been replaced.",
      "example": 1
    },
    "price": {
      "type": "string",
      "nullable": true,
      "description": "Shipping price for the item been replaced. It does not account for the whole order's shipping price and is presented in cents.",
      "example": 1000
    },
    "measurementUnit": {
      "type": "string",
      "nullable": true,
      "description": "Measurement unit of the item been replaced. For example, `kg` for kilograms or `un` for unitary items.",
      "example": "kg"
    },
    "unitMultiplier": {
      "type": "integer",
      "description": "Unit multiplier for item been update.",
      "example": 3
    },
    "sellingPrice": {
      "type": "string",
      "description": "Selling price of the item been replaced.",
      "example": 100
    },
    "name": {
      "type": "string",
      "nullable": true,
      "description": "Name of the item been replaced.",
      "example": "T-shirt with logo"
    },
    "detailUrl": {
      "type": "string",
      "nullable": true,
      "description": "URL slug of the item been replaced.",
      "example": "/tshirt-logo/p"
    },
    "imageUrl": {
      "type": "string",
      "nullable": true,
      "description": "Image URL slug of the item been replaced.",
      "example": "http://store.com.br/ids/155419-55-55//tshirt-logo.png?v=6378858562367"
    }
  },
  "example": {
    "id": "31",
    "quantity": 1,
    "price": null,
    "measurementUnit": null,
    "unitMultiplier": 0,
    "sellingPrice": null,
    "name": null,
    "detailUrl": null,
    "imageUrl": null
  }
}