Wishlist Remove[Beta]
Please contact your CSM or [email protected] to enable this API for your store
Fires when a shopper removes a product from their wishlist. If multiple wishlists are enabled, each removal generates its own event.
Objects
- User(Shopper)
- List
- List item
- Product
- Device
Payload
{
"EventName": "Swym-removeWishlist",
"EventTime": "2024-10-30T07:42:48Z",
"User": {
"UserId": "7shd3456dgey862t5d7s8ej992jd9e",
"Medium": "email",
"MediumValue": "[email protected]",
"UserType": "VIP", //To Be Supported
"LastPurchaseDate": "2024-10-30T07:42:48Z", //To Be Supported
"LastPurchaseAmount": 100 //To Be Supported
},
"Product": {
"ProductId": 4269834960999,
"ProductName": "Emma",
"ProductPrice": 30,
"ProductQuantity": 20,
"ProductBrand": "ScarlettHara",
"ProductCategory": "White",
"ProductURL": "https://cc-test-store-nemoz.myshopify.com/products/emma?sw-rfr=4e20&swid=LvppBHin4hcnvm4anRUCC3FpUAD7o16nORhMXuYLgGsI57QzTbrR89SCrVtkyBdON9OFjCbZNhskF-5cHkc61A",
"ProductImageURL": "https://cdn.shopify.com/s/files/1/0029/7772/6510/products/images-8_620x620.jpg?v=1555656217",
"ProductVariantId": 30774347071591,
"ProductVariantInfo": "Color Red",
"ProductVariantSKU": "sku-187-ydh",
},
"ListItem": { //To Be Supported
"ProductId": 4269834960999,
"ProductName": "Emma",
"ProductPrice": 30,
"ProductQuantity": 20,
"ProductBrand": "ScarlettHara",
"ProductCategory": "White",
"ProductVariantURL": "https://cc-test-store-nemoz.myshopify.com/products/emma?sw-rfr=4e20&swid=LvppBHin4hcnvm4anRUCC3FpUAD7o16nORhMXuYLgGsI57QzTbrR89SCrVtkyBdON9OFjCbZNhskF-5cHkc61A",
"ProductVariantImageURL": "https://cdn.shopify.com/s/files/1/0029/7772/6510/products/images-8_620x620.jpg?v=1555656217",
"ProductVariantId": 30774347071591,
"ProductVariantInfo": "Color Red",
"ProductVariantSKU": "sku-187-ydh",
"ActionBy": "Staff User",
"ActionByUser": {
"UserId": "s3ta734gey862t5d7s8ej992jd9e",
"Medium": "email",
"MediumValue": "[email protected]"
}
},
"List": {
"Id": "6dgey862t5d7s8ej992jd9e",
"Name": "Favorite Books",
"CreatedTime": "2024-10-29T07:42:48Z",//To Be Supported
"UpdatedTime": "2024-10-20T07:42:48Z"//To Be Supported
},
"Device": {
"DeviceId": "7shd3456dgey862t5d7s8ej992jd9e",
"DeviceType": "mobile", //To Be Supported
"DeviceName": "iPhone 12 Pro Max", //To Be Supported
"DeviceOS": "iOS 14.5", //To Be Supported
"DeviceBrowser": "Safari", //To Be Supported
"DeviceIP": "192.168.1.1", //To Be Supported
"DeviceLocation": "New York, NY" //To Be Supported
},
"EventExtras": "cprops", //To Be Supported
"EventSource": "web", //To Be Supported
"EventChannel": "email" //To Be Supported
}
| Attribute | Description | Supported |
|---|---|---|
| EventName | Name of the event | ✅ Yes |
| EventTime | Date Time | ✅ Yes |
| EventExtras | Custom properties or tags(cprops) | 🚧 To Be Supported |
| EventSource | Origin of the event (e.g., web, mobile) | 🚧 To Be Supported |
| EventChannel | Event channel (e.g., email, SMS) | 🚧 To Be Supported |
| Attribute | Description | Supported |
|---|---|---|
| UserId | Unique identifier for the user | ✅ Yes |
| Medium | Type of identifier (e.g., email, sms) | ✅ Yes |
| MediumValue | Actual value of the identifier | ✅ Yes |
| UserType | Category of the user (e.g., VIP, Regular) | 🚧 To Be Supported |
| LastPurchaseDate | Date Time of the user’s last purchase | 🚧 To Be Supported |
| LastPurchaseAmount | Amount value of the user’s last purchase | 🚧 To Be Supported |
| Attribute | Description | Supported |
|---|---|---|
| ProductId | Product ID | ✅ Yes |
| ProductName | Name of the product | ✅ Yes |
| ProductPrice | Price of the product | ✅ Yes |
| ProductQuantity | Quantity in stock or shown at time of event | ✅ Yes |
| ProductBrand | Brand of the product | ✅ Yes |
| ProductCategory | Category/Collection | ✅ Yes |
| ProductURL | Product URL | ✅ Yes |
| ProductImageURL | Product image URL | ✅ Yes |
| ProductVariantId | Variant ID of the product | ✅ Yes |
| ProductVariantInfo | Variant attributes like color, size, etc. | ✅ Yes |
| ProductVariantSKU | SKU for the product variant | ✅ Yes |
| Attribute | Description | Supported |
|---|---|---|
| ProductId | Product ID | 🚧 To Be Supported |
| ProductName | Product name | 🚧 To Be Supported |
| ProductPrice | Price | 🚧 To Be Supported |
| ProductQuantity | Quantity | 🚧 To Be Supported |
| ProductBrand | Brand | 🚧 To Be Supported |
| ProductCategory | Category | 🚧 To Be Supported |
| ProductURL | Product URL | 🚧 To Be Supported |
| ProductImageURL | Product image URL | 🚧 To Be Supported |
| ProductVariantId | Variant ID | 🚧 To Be Supported |
| ProductVariantInfo | Variant details | 🚧 To Be Supported |
| ProductVariantSKU | SKU | 🚧 To Be Supported |
| ActionBy | Actor who performed the action (e.g., "Staff User") | 🚧 To Be Supported |
| ActionByUser.UserId | ID of the acting user | 🚧 To Be Supported |
| ActionByUser.Medium | Identifier medium | 🚧 To Be Supported |
| ActionByUser.MediumValue | Identifier value (e.g., email of staff user) | 🚧 To Be Supported |
| Attribute | Description | Supported |
|---|---|---|
| Id | ID of the wishlist/list | ✅ Yes |
| Name | Name of the list | ✅ Yes |
| CreatedTime | Update Date Time | 🚧 To Be Supported |
| UpdatedTime | Update Date Time | 🚧 To Be Supported |
| Attribute | Description | Supported |
|---|---|---|
| DeviceId | Unique device identifier | ✅ Yes |
| DeviceType | Type of device (mobile, desktop) | 🚧 To Be Supported |
| DeviceName | Name/model of the device | 🚧 To Be Supported |
| DeviceOS | Operating system | 🚧 To Be Supported |
| DeviceBrowser | Browser used | 🚧 To Be Supported |
| DeviceIP | IP address | 🚧 To Be Supported |
| DeviceLocation | Estimated location from IP | 🚧 To Be Supported |
Updated 15 days ago