Item

ParameterTypeRequiredDescription
productIdstring✔The SPU ID of this item.
productTitlestring✔The SPU name of this item.
variantIdstring✔The item ID. *Either item_id or item_name is required.
variantTitlestring✔The name of the item.*Either item_id or item_name is required.
variantBrandstring✔The brand of the item.
variantListIdstring✔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.
variantCategorystring✔The item's category. If part of a category hierarchy or taxonomy, this will represent the top-level category.
variantCategory2string✔The second category hierarchy or an additional taxonomy for the item.
variantCategory3string✔The third category hierarchy or an additional taxonomy for the item.
variantCategory4string✔The fourth category hierarchy or an additional taxonomy for the item.
variansCategory5string✔The fifth category hierarchy or an additional taxonomy for the item.
variantListTitlestring✔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.
couponstring✔The coupon name/code linked to the item. Event-level and item-level coupon parameters are independent of each other.
discountnumber✔The unit monetary discount value linked with the item.
indexnumber✔The index/position of the item in a list.
quantitynumber✔The quantity of the item. If not specified, the quantity defaults to 1.
unitPricesUnitPrice[]✔The price of the item before any discounts and taxes are applied.

UnitPrice

ParameterTypeRequiredDescription
currencystring✔The currency code for the amount, following the ISO 4217 standard.
amountnumber✔The price of the item before any discounts and taxes are applied.

Example

preparing...