Item

ParameterTypeRequiredDescription
productIdstringThe SPU ID of this item.
productTitlestringThe SPU name of this item.
variantIdstringThe item ID. *Either item_id or item_name is required.
variantTitlestringThe name of the item.*Either item_id or item_name is required.
variantBrandstringThe brand of the item.
variantListIdstringThe 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.
variantCategorystringThe item's category. If part of a category hierarchy or taxonomy, this will represent the top-level category.
variantCategory2stringThe second category hierarchy or an additional taxonomy for the item.
variantCategory3stringThe third category hierarchy or an additional taxonomy for the item.
variantCategory4stringThe fourth category hierarchy or an additional taxonomy for the item.
variansCategory5stringThe fifth category hierarchy or an additional taxonomy for the item.
variantListTitlestringThe 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.
couponstringThe coupon name/code linked to the item. Event-level and item-level coupon parameters are independent of each other.
discountnumberThe unit monetary discount value linked with the item.
indexnumberThe index/position of the item in a list.
quantitynumberThe 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
currencystringThe currency code for the amount, following the ISO 4217 standard.
amountnumberThe price of the item before any discounts and taxes are applied.

Example

preparing...