Item
| Parameter | Type | Required | Description |
|---|---|---|---|
| productId | string | ✔ | The SPU ID of this item. |
| productTitle | string | ✔ | The SPU name of this item. |
| variantId | string | ✔ | The item ID. *Either item_id or item_name is required. |
| variantTitle | string | ✔ | The name of the item.*Either item_id or item_name is required. |
| variantBrand | string | ✔ | The brand of the item. |
| variantListId | string | ✔ | The ID of the list where the item was shown to the user. If provided, the event-level item_list_id is ignored. If not provided, the event-level item_list_id will be used, if available. |
| variantCategory | string | ✔ | The item's category. If part of a category hierarchy or taxonomy, this will represent the top-level category. |
| variantCategory2 | string | ✔ | The second category hierarchy or an additional taxonomy for the item. |
| variantCategory3 | string | ✔ | The third category hierarchy or an additional taxonomy for the item. |
| variantCategory4 | string | ✔ | The fourth category hierarchy or an additional taxonomy for the item. |
| variansCategory5 | string | ✔ | The fifth category hierarchy or an additional taxonomy for the item. |
| variantListTitle | string | ✔ | The name of the list where the item was shown to the user. If provided, the event-level item_list_name is ignored. If not provided, the event-level item_list_name will be used, if available. |
| coupon | string | ✔ | The coupon name/code linked to the item. Event-level and item-level coupon parameters are independent of each other. |
| discount | number | ✔ | The unit monetary discount value linked with the item. |
| index | number | ✔ | The index/position of the item in a list. |
| quantity | number | ✔ | The quantity of the item. If not specified, the quantity defaults to 1. |
| unitPrices | UnitPrice[] | ✔ | The price of the item before any discounts and taxes are applied. |
UnitPrice
| Parameter | Type | Required | Description |
|---|---|---|---|
| currency | string | ✔ | The currency code for the amount, following the ISO 4217 standard. |
| amount | number | ✔ | The price of the item before any discounts and taxes are applied. |
Example
{ productId: 'P920582', productTitle: 'T-Shirt', variantId: 'SKU_12345', variantTitle: 'Stan and Friends Tee', variantBrand: 'AS', variantListId: '031711cdfabe4290993b9c2c8e076a75', variantCategory: 'Apparel', variantCategory2: 'Adult', variantCategory3: 'Shirts', variantCategory4: 'Crew', variantCategory5: 'Short sleeve', variantListTitle: 'Shirt Categary' coupon: 'SUMMER_FUN', discount: 123, index: 5, quantity: 3, unitPrices: [{ currency: 'USD', amount: 10 }] }