Iterable · Schema

CommerceItem

A commerce item in a purchase or cart

Cross-Channel MessagingCustomer EngagementEmailMarketing AutomationPush NotificationsSMS

Properties

Name	Type	Description
id	string	Item ID or SKU
sku	string	Item SKU
name	string	Item name
description	string	Item description
categories	array	Item categories
price	number	Item price
quantity	integer	Quantity purchased
imageUrl	string	URL of the item image
url	string	URL of the item page
dataFields	object	Additional item data fields

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CommerceItem",
  "title": "CommerceItem",
  "type": "object",
  "description": "A commerce item in a purchase or cart",
  "required": [
    "id",
    "name",
    "price",
    "quantity"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Item ID or SKU"
    },
    "sku": {
      "type": "string",
      "description": "Item SKU"
    },
    "name": {
      "type": "string",
      "description": "Item name"
    },
    "description": {
      "type": "string",
      "description": "Item description"
    },
    "categories": {
      "type": "array",
      "description": "Item categories",
      "items": {
        "type": "string"
      }
    },
    "price": {
      "type": "number",
      "description": "Item price"
    },
    "quantity": {
      "type": "integer",
      "description": "Quantity purchased"
    },
    "imageUrl": {
      "type": "string",
      "format": "uri",
      "description": "URL of the item image"
    },
    "url": {
      "type": "string",
      "format": "uri",
      "description": "URL of the item page"
    },
    "dataFields": {
      "type": "object",
      "description": "Additional item data fields",
      "additionalProperties": true
    }
  }
}