Surfside Ecommerce Events

You can set up ecommerce events to collect information about the shopping behavior of your users. The events enable you to quantify your most popular products and see the influence of promotions and product placement on revenue.

This document describes each ecommerce event, the data types associated with each event, and the actions that trigger each event. For implementation guidance, see the Implementation Guide.

Supported Ecommerce Data Types and Actions

Product and Promotion Actions

Note: The actions in bold are required for a complete ecommerce implementation.

Action	Description
click	A click on a product or product link for one or more products.
detail	A view of product details.
add	Adding one or more products to a shopping cart.
remove	Removing one or more products from a shopping cart.
checkout	Initiating the checkout process for one or more products.
checkout_option	Sending the option value for a given checkout step.
purchase	The sale of one or more products.
refund	The refund of one or more products.
promo_click	A click on an internal promotion.

Product Data

Product data represents individual products that were viewed, added to the shopping cart, etc. It is referred to as a productFieldObject and contains the following values:

Key	Value Type	Required	Description
id	text	YES	The product ID or SKU (e.g. P67890). One of id or name must be set.
name	text	YES	The name of the product (e.g. Pancake). One of id or name must be set.
list	text	No	The list associated with the product (e.g. Cookies).
brand	text	No	The brand associated with the product (e.g. Search).
category	text	No	The category to which the product belongs (e.g. Flower). Use / as a delimiter to specify up to 5-levels of hierarchy (e.g. Flower/Pre-Roll/Premium).
variant	text	No	The variant of the product (e.g. 1g).
price	number	No	The price of a product (e.g. 19.20).
quantity	integer	No	The quantity of a product (e.g. 2).
coupon	text	No	The coupon code associated with a product (e.g. SUMMER_SALE13).
position	integer	No	The product's position in a list or collection (e.g. 2).
currency	text	No	The product's currency (e.g. 'usd').

Transaction Data

Represents information about an ecommerce related action that has taken place. It is referred to as an transactionFieldObject and contains the following values:

Key	Value Type	Required	Description
id	text	Yes	The transaction ID (e.g. T1234). Required if the action type is purchase or refund
affiliation	text	No	The store or affiliation from which this transaction occurred (e.g. Surfside Store).
revenue	number	No	Specifies the total revenue or grand total associated with the transaction (e.g. 11.99). This value may include shipping, tax costs, or other adjustments to total revenue that you want to include as part of your revenue calculations.
tax	number	No	The total tax associated with the transaction.
shipping	number	No	The shipping cost associated with the transaction.
coupon	text	No	The transaction coupon redeemed with the transaction.
list	text	No	The list that the associated products belong to.
step	integer	No	A number representing a step in the checkout process. Optional on checkout actions.
option	text	No	Additional field for checkout and checkout_option actions that can describe option information on the checkout page, like selected payment method.

Impression Data

Represents information about a product that has been viewed. It is referred to as an impressionFieldObject and contains the following values:

Key	Value Type	Required	Description
id	text	YES	The product ID or SKU (e.g. P67890). One of id or name must be set.
name	text	YES	The name of the product (e.g. Pancake). One of id or name must be set.
list	text	No	The list or collection to which the product belongs (e.g. Catalog)
brand	text	No	The brand associated with the product (e.g. Cookies).
category	text	No	The category to which the product belongs (e.g. Flower). Use / as a delimiter to specify up to 5-levels of hierarchy (e.g. Flower/Pre-Roll/Premium).
variant	text	No	The variant of the product (e.g. 1g).
position	integer	No	The product's position in a list or collection (e.g. 2).
price	number	No	The price of a product (e.g. 15.20).

Promotion Data

Represents information about a promotion that has been viewed. It is referred to a promoFieldObject and contains the following values:

Key	Value Type	Required	Description
id	text	Yes	The promotion ID (e.g. PROMO_1234). One of id or name must be set.
name	text	Yes	The name of the promotion (e.g. Summer Sale ) . One of id or name must be set.
creative	text	No	The creative associated with the promotion (e.g. summer_banner2).
position	text	No	The position of the creative (e.g. banner_slot_1).