VTEX · Schema

Item

Item information.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name	Type	Description
id	string	SKU ID.
name	string	Product name.
price	number	Item price.
quantity	integer	Quantity of this item in the cart.
deliveryType	string	Type of delivery configured by the store.
deliverySlaInMinutes	integer	Each item can have a separate shipping SLA in minutes.
categoryId	string	Category ID for the item. Configured by each store.
categoryName	string	Category name for the Item. Configured by each store.
discount	number	Discount applied on item(s) two decimal places.
sellerId	string	Discount applied on item(s), with two decimal places separated by `.`.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Item",
  "title": "Item",
  "description": "Item information.",
  "required": [
    "id",
    "name",
    "price",
    "quantity",
    "deliveryType",
    "deliverySlaInMinutes",
    "categoryId",
    "categoryName",
    "discount",
    "sellerId"
  ],
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "SKU ID.",
      "example": "132981"
    },
    "name": {
      "type": "string",
      "description": "Product name.",
      "example": "Shirt"
    },
    "price": {
      "type": "number",
      "description": "Item price.",
      "example": 20.51
    },
    "quantity": {
      "type": "integer",
      "description": "Quantity of this item in the cart.",
      "example": 2
    },
    "deliveryType": {
      "type": "string",
      "description": "Type of delivery configured by the store.",
      "example": "Normal"
    },
    "deliverySlaInMinutes": {
      "type": "integer",
      "description": "Each item can have a separate shipping SLA in minutes.",
      "example": 4320
    },
    "categoryId": {
      "type": "string",
      "description": "Category ID for the item. Configured by each store.",
      "example": "111"
    },
    "categoryName": {
      "type": "string",
      "description": "Category name for the Item. Configured by each store.",
      "example": "Electronica"
    },
    "discount": {
      "type": "number",
      "description": "Discount applied on item(s) two decimal places.",
      "example": 1.99
    },
    "sellerId": {
      "type": "string",
      "description": "Discount applied on item(s), with two decimal places separated by `.`.",
      "example": "vtexargentina"
    }
  }
}