iOS Ecommerce Activity Tracking

This e-commerce documentation helps define the journey for a customer as they visit a product page or a product category page, add a product to wishlist, update a shopping cart, create or update an order.

Here is a list of supported events:

Track activity via Reteno.ecommerce().logEvent(type: Ecommerce.EventType, date: Date, forcePush: Bool) method. Provide appropriate event type, event date and forcePush flag (if you want to send event immediatelly).

Product Viewed

Fire this event when a user views a product card.

This event supports the following properties:

Example:

let product = Ecommerce.Product(
    productId: "Product_ID",
    price: 20.0,
    isInStock: 1,
    attributes: ["size": ["23", "42"], "color": ["white", "orange"]]
)
Reteno.ecommerce().logEvent(type: .productViewed(product: product, currencyCode: "UAH"))

Product Category Viewed

Fire this event when a user views a category.

This event supports the following properties:

Example:

let productCategory = Ecommerce.ProductCategory(
    productCategoryId: "CATEGORY_ID",
    attributes: ["size": ["M", "L"]]
)
Reteno.ecommerce().logEvent(type: .productCategoryViewed(category: productCategory))

Product Added to Wishlist

Fire this event when a user adds a product to a wishlist.

This event supports the following properties:

Example:

let product = Ecommerce.Product(
    productId: "PRODUCT_ID",
    price: 20.0,
    isInStock: 1,
    attributes: ["size": ["23", "42"], "color": ["white", "orange"]]
)
Reteno.ecommerce().logEvent(type: .productAddedToWishlist(product: product, currencyCode: "EUR"))

Cart Updated

Fire this event when a user updates a shopping cart.

The cartUpdated event transmits not the fact of adding a specific product to the cart, but the current state of the cart. If the first product is added to the cart, then an array with one product is passed in the cartUpdated event. If a second, third, etc. product is added, then an array of two, three, etc. products is transmitted in the cartUpdated events. The same logic works when removing products from the cart.

In each cartUpdated event, the cartId parameter must be passed. This is a unique identifier of the current state of the cart. Each time you send the cartUpdated event, you must pass a new cartId value that will be different from the previous ones.

This event supports the following properties:

Ecommerce.ProductInCart model parameters:

Example:

let productsInCart = [
    Ecommerce.ProductInCart(productId: "uut", price: 20.0, quantity: 1),
    Ecommerce.ProductInCart(productId: "lk", price: 100.0, quantity: 3)
]
Reteno.ecommerce().logEvent(type: .cartUpdated(cartId: "CART_ID", products: productsInCart, currencyCode: "UAH"))

Order Сreated

Fire this event when a user creates an order.

This event supports the following properties:

Ecommerce.Order model parameters:

Ecommerce.Order.Item model parameters:

Example:

let order = Ecommerce.Order(
    externalOrderId: "ORDER_ID",
    totalCost: 300.0,
    status: .INITIALIZED,
    date: Date(),
    cartId: "idid"
)
Reteno.ecommerce().logEvent(type: .orderCreated(order: order, currencyCode: "UAH"))

Order Updated

Fire this event when a user updates an order.

This event supports the following properties:

Ecommerce.Order and Ecommerce.Order.Item models parameters are described in Order created event.

Example:

let order = Ecommerce.Order(
    externalOrderId: "ORDER_ID",
    totalCost: 300.0,
    status: .IN_PROGRESS,
    date: Date(),
    cartId: "idid"
)
Reteno.ecommerce().logEvent(type: .orderUpdated(order: order, currencyCode: "UAH"))

Order Delivered

Fire this event when an order status is changed to delivered. If an order does not exist then an event is ignored.

This event supports the following properties:

Example:

Reteno.ecommerce().logEvent(type: .orderDelivered(externalOrderId: "ORDER_ID"))

Order Cancelled

Fire this event when an order status is changed to cancelled. If an order does not exist then an event is ignored.

This event supports the following properties:

Example:

Reteno.ecommerce().logEvent(type: .orderCancelled(externalOrderId: "ORDER_ID"))

Search Request

This event supports the following properties:

Example:

Reteno.ecommerce().logEvent(type: .searchRequest(query: "iphone", isFound: true))

Unsupported Events

If you want to track user activity and could not find appropriate Ecommerce.EventType, you always can use Reteno.logEvent method:

Reteno.logEvent(
    eventTypeKey: "test_event_type",
    date: Date(),
    parameters: [Event.Parameter(name: "Parameter name", value: "some parameter value")],
    forcePush: false
)