​
Event Overview

The Added to wishlist event is similar to favorites but often used for long-term planning by users. This is a great trigger for “Wishlist item back in stock” or “Wishlist item on sale” campaigns.

​
Use Cases

  • Wishlist confirmation messages
  • Occasion-specific reminders
  • Share wishlist prompts
  • Price drop alerts

​
Event Attributes

FieldTypeDescription
product_idstringUnique product identifier
product_namestringDisplay name of product
product_urlstringDirect link to product page
product_image_urlstringProduct image URL
skustringStock Keeping Unit
variant_idstringSpecific variant ID
variant_namestringVariant description
brandstringProduct brand
categorystringProduct category path
product_typestringType of product
pricenumberCurrent price
compare_at_pricenumberOriginal price
currencystringCurrency code
discount_amountnumberDiscount amount
discount_percentagenumberDiscount percentage
in_stockbooleanStock availability
inventory_quantityintegerCurrent stock level
low_stock_thresholdintegerLow stock warning level
wishlist_idstringUnique wishlist identifier
wishlist_namestringName of the wishlist
total_wishlist_itemsintegerTotal items in wishlist
added_fromstringSource location
previously_wishlistedbooleanRe-added indicator
Common Wishlist Names:
  • My Wishlist - Default wishlist
  • Birthday Wishlist - Occasion-specific
  • Wedding Registry - Event registry

​
Payload Example

{
  "attributes": {
    "product_id": "PROD-789",
    "product_name": "Smart Watch",
    "product_url": "https://example.com/products/smart-watch",
    "product_image_url": "https://example.com/images/watch.jpg",
    "sku": "SW-001",
    "variant_id": "VAR-SILVER",
    "variant_name": "Silver",
    "brand": "CocoonTech",
    "category": "Electronics > Wearables",
    "product_type": "Gadgets",
    "price": 199.00,
    "compare_at_price": 249.00,
    "currency": "USD",
    "discount_amount": 50.00,
    "discount_percentage": 20.08,
    "in_stock": true,
    "inventory_quantity": 25,
    "low_stock_threshold": 10,
    "wishlist_id": "WISH-001",
    "wishlist_name": "Birthday Wishlist",
    "total_wishlist_items": 3,
    "added_from": "product_page",
    "previously_wishlisted": false
  }
}