VTEX · Schema

Item4

CommerceE-CommerceRetailMarketplacePayments

Properties

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

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Item4",
  "title": "Item4",
  "required": [
    "id",
    "quantity",
    "price",
    "measurementUnit",
    "unitMultiplier",
    "sellingPrice",
    "name",
    "detailUrl",
    "imageUrl"
  ],
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "SKU ID of the item.",
      "example": "1"
    },
    "quantity": {
      "type": "integer",
      "description": "Quantity of items been replaced.",
      "example": 1
    },
    "price": {
      "type": "string",
      "nullable": true,
      "description": "Item's shipping price. It does not account for the whole order's shipping price and is presented in cents.",
      "example": 1000
    },
    "measurementUnit": {
      "type": "string",
      "nullable": true,
      "description": "Item's measurement unit. For example, `kg` for kilograms or `un` for unitary items.",
      "example": "kg"
    },
    "unitMultiplier": {
      "type": "integer",
      "description": "Item's unit multiplier.",
      "example": 3
    },
    "sellingPrice": {
      "type": "string",
      "description": "Item's selling price.",
      "example": 100
    },
    "name": {
      "type": "string",
      "nullable": true,
      "description": "Item's name.",
      "example": "T-shirt with logo"
    },
    "detailUrl": {
      "type": "string",
      "nullable": true,
      "description": "Item's URL slug.",
      "example": "/tshirt-logo/p"
    },
    "imageUrl": {
      "type": "string",
      "nullable": true,
      "description": "Item's image URL slug.",
      "example": "http://store.com.br/ids/155419-55-55//tshirt-logo.png?v=6378858562367"
    }
  },
  "example": {
    "id": "31",
    "quantity": 1,
    "price": 5000,
    "measurementUnit": "un",
    "unitMultiplier": 1,
    "sellingPrice": 5000,
    "name": "Fusca miniatura Fusca preto",
    "detailUrl": "/fusca-miniatura-24/p",
    "imageUrl": "http://qastore.vteximg.com.br/arquivos/ids/155431-55-55/image-bdab69af1e5c41cdbc498d02e370b376.jpg?v=636579391945870000"
  }
}