GuidesAPI ReferenceChangelogDiscussions
Log In

📘

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 Added to Cart event fires when a product is explicitly added to cart from any source. This can occur from a quick add, pdp, or any other source in which a product can exclusively be added to cart.

The Event Properties unique to the Added to Cart event include:

  "event_properties": {
    "source": null,
    "product_id": "4487722260272",
    "product_title": "Meal Supplement",
    "product_type": "Supplement",
    "variant_id": "31822283310640",
    "variant_name": "Protein",
    "variant_price": "79.99",
    "event_id": "DF222C8C-FBDB-4DA5-AD29-089F567A70A6",
    "cart_add_source": "pdp_direct_add",
    "cart_add_type": "product_add",
    "collection_id": "272228123312",
    "collection_title": "Protein Powders",
    "multi_currency_code": "USD",
    "cart_total_price": "159.98",
    "cart_total_items": "1",
    "cart_total_items_list": ["Meal Supplement"],
    "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"


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


variant_id String : The unique identifier for the variant selected on the product added to the cart. Each id is unique across the Shopify system. No two variants will have the same id


variant_title String : The text title of the variant selected on the product added to cart


variant_price Float : The price of the variant selected of the product added to the cart


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


cart_add_source String : The source in which a product gets added to the cart

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


cart_add_type String :The specific type of cart addition. This could be classified as a quick add, direct add from a pdp, or an add directly from the cart.


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


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


cart_total_price Float : The total amount of the cart after cart update in the merchant’s currency


cart_total_items Integer : The total count of current items in the cart after the addition to the cart


cart_total_items_list List : A list of all of the product titles (represented as strings) in the cart after the addition to the cart


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