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 Wishlist Updated Event will fire anytime any product is added to favorites, removed from favorites, or a previously added item’s variant is changed. Similar to an Add to Cart, there are details and context on the product updated in the wishlist that provide the Tapcart Merchant with more details on the behavior of the app user.

Note: The Wishlist Updated event is only available to merchants who have enabled Advanced Wishlist

Event Properties unique to the Wishlist Updated event include:

  "event_properties": {
    "event_id": "2322cb9a-5d53-3330-84b8-3a2a2d0e2db0",
    "wishlist_update_type": "wishlist_item_added",
    "wishlist_update_source": "collection",
    "wishlist_update_source_id": "89222281",
    "variant_options_updated": null,
    "wishlist_type": "swym",
    "wishlist_total_items_count": "44",
    "wishlist_title": "My Favorites",
    "wishlist_id": "d095236c-defc-484a-3336-bd2302f787b6",
    "item_wishlist_titles_list": [],
    "item_wishlist_ids_list": [],
    "product_id": "4682333121483",
    "variant_id": "32903339966155",
    "variant_option_names": ["SIZE"],
    "variant_option_values": ["8"],
    "product_title": "Sumer Skirt",
    "variant_name": "8",
    "variant_price": "52.0",
    "variant_compare_at_price": "0.0",
    "multi_currency_code": "USD"
  }

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


wishlist_update_type String : The type of wishlist update


wishlist_update_source String : The source screen in the app that the customer was on when triggering the wishlist updated event.


wishlist_update_source_id String : The source id of the source screen that the customer was on when triggering the wishlist updated event.


variant_options_updated String : Details which variants on the wishlist were updated in this event


wishlist_type String : Describes the technology partner whose providing the wishlist functionality in app.


wishlist_total_items_count String : Total number of items in the wishlist


wishlist_title String : The name for the given wishlist


wishlist_id String : The unique identifier for the given wishlist


item_wishlist_titles_list String : An array of product names in the given wishlist


item_wishlist_ids_list String : An array of product id's in the given wishlist


product_id String : The unique identifier for the given product being updated in the wishlist event


variant_id String : The unique identifier for the given variant of the product being updated in the wishlist event


variant_option_names String : name of the variant being updated in the event


variant_option_values String : Describes what variant is being updated in the event.


product_title String : The name of the product being updated


variant_name String : The name of the product vairant


variant_price Float : price of the variant being updated to.


variant_compare_at_price Float : price of the variant being change from.


multi_currency_code String : currency of the product when wishlist updated event took place