Remind Me[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.

❗️
Back in Stock Markets Integration Support
Back in Stock events are currently not supported for stores using the Back in Stock Markets solution. Stores using Shopify Markets with the standard Back in Stock app are not affected.
If your store uses the Back in Stock Markets solution, these events will not be available. For updates on multi-market event support, please contact [email protected].

Objects

User[Shopper]
Item[Product]
Device

Payload

{
    "EventName": "Swym-remindeMe",
    "EventTime": "2024-10-30T07:42:48Z",
    "EventCustomProperties": {}, //cprops
    "EventSource": "collections", 
    "EventChannel": "web",
    "EventTopic": "backinstock",
    "User": {
        "UserId": "7shd3456dgey862t5d7s8ej992jd9e",
        "Medium": "email",
        "MediumValue": "[email protected]"
    },
    "Item": { //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"
    },
    "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
EventTopic	Topic for user subscription(eg., backinstock/comingsoon)	✅ 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

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
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