Events
Track wishlist actions for analytics and automation.
Use events to track user activity for analytics or automation triggers. Authentication is required.
Track event
POST /event
Request
{
"identity": {
"customerId": "8769049329896",
"sessionId": null,
"device": "desktop",
"email": "customer@example.com",
"firstName": "Jane",
"lastName": "Doe",
"locale": "en"
},
"type": "add",
"payload": {
"productId": "gid://shopify/Product/1",
"variantId": null,
"source": "pdp"
}
}Response
{
"profileId": "cuid..."
}Product visit
Track visit counts used by Smart Save.
Requires identity with customerId or sessionId.
POST /product/visit
Request
{
"identity": {
"customerId": null,
"sessionId": "guest-session-id",
"device": "desktop",
"firstName": null,
"lastName": null,
"locale": "en"
},
"productHandle": "sunglasses"
}Response
{
"profileId": "cuid...",
"productHandle": "sunglasses"
}Get visit count:
GET /product/visit?sessionId=guest-session-id&productHandle=sunglasses&device=desktop
Response:
{
"profileId": "cuid...",
"productHandle": "sunglasses",
"count": 3
}Reset visit count:
DELETE /product/visit
Request:
{
"identity": {
"customerId": null,
"sessionId": "guest-session-id",
"device": "desktop",
"firstName": null,
"lastName": null,
"locale": "en"
},
"productHandle": "sunglasses"
}Response:
{
"profileId": "cuid...",
"productHandle": "sunglasses"
}