📘

Note

All events include Session Properties, Device Properties, App Properties, and Shopify Properties that are present on the Event Object. For more information, refer to the Common Event Object & Metadata document.

Event Properties, however, are unique to every event and are outlined in this page.

The Product Viewed event will only fire when a product is actually clicked and viewed. The event provides context on all of the product details, the screen or collection in which the product was viewed, and even unique block details that the product originated from. Because this event requires an explicit interaction with the product, a Product Viewed will not include product previews in various carrousels.

The Event Properties unique to a Product Viewed event include:

"event_properties": {
    "source": "direct",
    "event_id": "fa333228-cef1-4747-8e14-f257a6e239e2",
    "collection_id": "",
    "product_id": "8133951881503",
    "product_title": "Makeup Brush",
    "product_type": "",
    "product_price": "50.0",
    "product_view_source": "pdp_related_products_block",
    "collection_title": null,
    "multi_currency_code": "EGP",
    "product_tags_list": ["best sellers", "makeup", "skincare"],
    "product_badge_titles_list": [],
    "product_badge_ids_list": [],
    "product_badge_positioning_list": [],
    "custom_block_id": null,
    "custom_block_source_url": null
}

source String: A value or parameter tracking where the session originated from. This value is stamped on all events of a session. The default is "direct"


event_id String : The unique identifier of the session associated with the event. This event will also exist on the Event object level as well


collection_id String : A unique identifier for the collection. Each id is unique across the Shopify system. No two collections will have the same id. The id is only represented if a collection is applicable to the product that is viewed


product_id String : A unique identifier for the product. Each id is unique across the Shopify system. No two products will have the same id


product_title String : The text title of the product provided from Shopify


product_type String : The type of product designated in Shopify


product_price Float : The price of the product searched


product_view_source String : The page, collection, or screen in which a product was viewed

Note: To view all the various sources, reference the Event Sources page


collection_title String : The title of the associated collection for the product. The collection is only available if applicable


multi_currency_code String : The current currency the user has selected in the app


product_tags_list List : A list of all of the product tags associated on the product from Shopify. The product tags are represented in String values


product_badge_titles_list List : A list of the titles of all product badges applied to the viewed product. These will only be applicable if the Tapcart Merchant has product badges enabled


product_badge_ids_list List : A list of the unique identifiers of product badges applied to the viewed product. These will only be applicable if the Tapcart Merchant has product badges enabled


product_badge_positioning_list List : A list of the relevant positioning and order of the product badges applied to the viewed product. These will only be applicable if the Tapcart Merchant has product badges enabled


custom_block_id String : The unique identifier of the custom code block if applicable


custom_block_source_url String : The unique source url of the custom block that represents the individual block. Will send null if there is no applicable custom block