Wishlist Backinstock[Beta]

✍️
This feature is currently in beta and it is provided for early access and feedback purposes.
Please contact your CSM or Email at [email protected] to learn more about the event.

Objects

User[Shopper]
List
List item[Product]
Device

Payload

{
    "EventName": "Swym-backinstock",
    "EventTime": "2024-10-30T07:42:48Z",
    "EventCustomProperties": {}, //cprops
    "EventSource": "collections", 
    "EventChannel": "web",
    "EventExtras": {
        "OriginalStock": 8,
        "Stock": 5
     },
    "User": {
        "UserId": "7shd3456dgey862t5d7s8ej992jd9e",
        "Medium": "email",
        "MediumValue": "[email protected]",
        "Currency": "USD", //Markets fields
        "Country": "US",  //Markets fields
        "Locale": "en"  //Markets fields
    },
    "ListItem": { //To Be Supported
        "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"
    },
    "List": {
        "Id": "6dgey862t5d7s8ej992jd9e",
        "Name": "Favorite Books"
    },
    "Device": {
        "DeviceId": "7shd3456dgey862t5d7s8ej992jd9e",
        "DeviceType": "mobile", 
        "DeviceName": "iPhone 12 Pro Max",
        "DeviceOS": "iOS 14.5", 
        "DeviceBrowser": "Safari", 
        "DeviceIP": "192.168.1.1"
    }
}

Attribute	Description	Supported
EventName	Name of the event	✅ Yes
EventTime	Date Time	✅ Yes
EventCustomProperties	Custom properties or tags(cprops)	✅ Yes
EventSource	Origin of the event (e.g., pdp, collections)	✅ Yes
EventChannel	Event channel (e.g., web, pos)	✅ Yes
EventExtras	Extra info supporting event (e.g., web, pos)	✅ Yes
EventExtras.OriginalStock	Number of items before coming back in stock	✅ Yes
EventExtras.Stock	Current available number after back in stock	✅ Yes

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
Currency	Shopper's local market currency	✅ Yes
Country	Shopper's local market country	✅ Yes
Locale	Shopper's market locale	✅ Yes

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
Id	ID of the wishlist/list	✅ Yes
Name	Name of the list	✅ Yes

Attribute	Description	Supported
DeviceId	Unique device identifier	✅ Yes
DeviceType	Type of device (mobile, desktop)	✅ Yes
DeviceName	Name/model of the device	✅ Yes
DeviceOS	Operating system	✅ Yes
DeviceBrowser	Browser used	✅ Yes