API Reference

Wishlist Events

Suggest Edits

Wishlist events can be fired from a few triggered sources. Some are interaction based, some are time based (ie "abandoned" interactions) and some are product update based. These events can be used to connect

Add to Wishlist

Context

Fired when a shopper adds a product to a wishlist. When multiple wishlists are enabled, each add can fire one event.

Objects

  • Shopper
  • List
  • List item(Product)

Payload

{
  "Event": "Swym-addToWishlist",
  "EventTime": "2024-10-30T07:42:48Z",
  "Medium": "email",
  "MediumValue": "[email protected]",
  "ListId": "6dgey862t5d7s8ej992jd9e",
  "ListName": "Favorite Books",
  "ProductId": 4269834960999,
  "ProductName": "Emma",
  "ProductPrice": 30,
  "ProductQuantity": 20,
  "ProductBrand": "ScarlettHara",
  "ProductCategory": "White",
  "VariantId": 30774347071591,
  "VariantInfo": "Color Red",
  "VariantSKU": "sku-187-ydh",
  "ProductURL": "https://cc-test-store-nemoz.myshopify.com/products/emma?sw-rfr=4e20&swid=LvppBHin4hcnvm4anRUCC3FpUAD7o16nORhMXuYLgGsI57QzTbrR89SCrVtkyBdON9OFjCbZNhskF-5cHkc61A",
  "ImageURL": "https://cdn.shopify.com/s/files/1/0029/7772/6510/products/images-8_620x620.jpg?v=1555656217"
}

Remove from Wishlist

Fired when a shopper removes a product from wishlist. When multiple wishlists are removed, each add can fire one event

Objects

  • Shopper
  • List
  • List item(Product)

Payload

{
  "Event": "Swym-removeWishlist",
  "EventTime": "2024-10-30T07:42:48Z",
  "Medium": "email",
  "MediumValue": "[email protected]",
  "ListId": "6dgey862t5d7s8ej992jd9e",
  "ListName": "Favorite Books",
  "ProductId": 4269834960999,
  "ProductName": "Emma",
  "ProductPrice": 30,
  "ProductQuantity": 10,
  "ProductBrand": "ScarlettHara",
  "ProductCategory": "White",
  "VariantId": 30774347071591,
  "VariantInfo": "Color Red",
  "VariantSKU": "sku-187-ydh",
  "ProductURL": "https://cc-test-store-nemoz.myshopify.com/products/emma?sw-rfr=4e20&swid=LvppBHin4hcnvm4anRUCC3FpUAD7o16nORhMXuYLgGsI57QzTbrR89SCrVtkyBdON9OFjCbZNhskF-5cHkc61A",
  "ImageURL": "https://cdn.shopify.com/s/files/1/0029/7772/6510/products/images-8_620x620.jpg?v=1555656217" 
}

Wishlist Reminders

Fired when a shopper adds a product to a wishlist and does not finish a purchase within a time period. The default time period is 24 hours.

This event can be used to trigger a marketing automation like sending email or sms or push notifications.

Context

  • Multiple products

Objects

  • Shopper
  • Medium
  • List of items and Products

Wishlist x Back in Stock

Fired when a shopper adds a product to a wishlist, does not finish a purchase and then the product comes back in stock above a threshold quantity. The default threshold for stock is 1.

This event can be used to trigger a marketing automation like sending email or sms or push notifications.

  • Single product
  • Secondary products

Context

  • Single product

Objects

  • Shopper
  • Medium
  • List
  • List item and Product
  • Diff - Stock change

Wishlist x Price Drop

Fired when a shopper adds a product to a wishlist, does not finish a purchase and then the product price drops by a threshold percentage from the previous known price. The default threshold for price is 5%.

This event can be used to trigger a marketing automation like sending email or sms or push notifications.

  • Single product
  • Secondary products

Context

  • Single product

Objects

  • Shopper
  • Medium
  • List
  • List item and Product
  • Diff - Price change

Wishlist x Low Stock

Fired when a shopper adds a product to a wishlist, does not finish a purchase and then the product goes low in stock below a threshold quantity. The default threshold for low stock is 5.

This event can be used to trigger a marketing automation like sending email or sms or push notifications.

  • Single product
  • Secondary products

Context

  • Single product

Objects

  • Shopper
  • Medium
  • List
  • List item and Product
  • Diff - Low stock

Wishlist x Tag changed

Fired when a shopper adds a product to a wishlist, does not finish a purchase and then there are changes in product tags, eg: new tag added, existing tag removed, etc. This is a custom configuration, please reach out to Swym Support if you want to explore this for your setup

This event can be used to trigger a marketing automation like sending email or sms or push notifications.

  • Single product
  • Secondary products

Context

  • Single product

Objects

  • Shopper
  • Medium
  • List
  • List item and Product
  • Diff - Product change

Wishlist x Custom conditions

Fired when a shopper adds a product to a wishlist, does not finish a purchase and then there are changes in product metadata or shopper metadata, eg: changes in title, image, metafields, new reviews added, loyalty points expiring, entered new loyalty tier, etc. This is a custom configuration, please reach out to Swym Support if you want to explore this for your setup

This event can be used to trigger a marketing automation like sending email or sms or push notifications.

  • Single product
  • Secondary products

Context

  • Single product

Objects

  • Shopper
  • Medium
  • List
  • List item and Product
  • Diff - Change condition output

Wishlist x Connect

Fired when a shopper connects their wishlist to their email or phone number without logging into the storefront directly. This is a capability surfaced through our default widget experience and Save shopper context with skipConnect: false

This event can be used to trigger a marketing automation like sending email or sms.

Context

  • Email
  • Phone
  • Medium

Objects

  • Shopper
  • Medium
  • Authentication link

Wishlist x Share

Fired when a shopper shares their wishlist to a friend's email via direct email. This is a capability surfaced through our default widget experience and Email list API

This event can be used to trigger a marketing automation like sending email.

Context

  • From address
  • To address
  • Note
  • List
  • List items and products
  • Link to the Shared Wishlist

Updated 15 days ago