Add to Wishlist
Event Key
ootb_add_to_wishlist
This event should be sent when a user adds a product to their wishlist, favorites list, or save-for-later area — indicating future purchase intent.
Event Key | Event Name | Type |
---|---|---|
ootb_add_to_wishlist | Added to Wishlist | Simple event |
Event Structure
The mandatory properties (tenant
, timestamp
, event
, and customer
) are required for all events and documented in detail on the Mandatory Properties page. Below is the JSON structure for the context-specific properties of the Add to Wishlist event:
{
"context": {
"ootb_session_id": "248rhdbuw2her1",
"ootb_userid": "ExampleUser1234",
"ootb_eventdatetime": "2024-03-09T07:40:00.000Z",
"ootb_product_id": "Sneakers93824",
"ootb_variant_id": "Sneakers93824-White9",
"ootb_sku_id": "Sneakers93824-White9-S9",
"ootb_item_name": "White High-Top Sneakers - Size 9",
"ootb_brand": "ExampleBrand",
"ootb_category": "C-Footwear",
"ootb_department": "D-Shoes",
"ootb_url": "https://www.example.com/sneakers/white9",
"ootb_page_title": "White High-Top Sneakers",
"ootb_page_category": "Footwear > Sneakers",
"ootb_price": 89.99,
"ootb_currency": "USD"
}
}
Parameters
Parameter Key | Parameter Name | Type | Description |
---|---|---|---|
ootb_session_id | Session ID | String | User’s browser session identifier. |
ootb_userid | User ID | String | Unique key identifying the user. |
ootb_eventdatetime | Event Date Time | Timestamp | Timestamp of the add-to-wishlist action. |
ootb_product_id | Product ID | String | Product identifier. |
ootb_variant_id | Variant ID | String | Variant identifier. |
ootb_sku_id | SKU ID | String | SKU identifier. |
ootb_item_name | Item Name | String | Item name (most granular level). |
ootb_brand | Brand | String | Brand of the product. |
ootb_category | Category | String | Lowest-level product category. |
ootb_department | Department | String | Highest-level department or category. |
ootb_url | URL | String | Product or variant URL. |
ootb_page_title | Page Title | String | Page title of the product. |
ootb_page_category | Page Category | String | Page category context. |
ootb_price | Price | Number | Displayed price when the item was added. |
ootb_currency | Currency | String | Currency of the price. |
Explanation
- event: Set to
ootb_add_to_wishlist
to indicate a user has added an item to their wishlist/favorites/save-for-later. - context:
ootb_session_id
,ootb_userid
: Link the action to the user’s session and identity.ootb_eventdatetime
: When the add-to-wishlist action occurred.ootb_product_id
,ootb_variant_id
,ootb_sku_id
,ootb_item_name
,ootb_brand
: Identify the exact product, variant, SKU, and item name.ootb_category
,ootb_department
,ootb_url
,ootb_page_title
,ootb_page_category
: Provide taxonomy and page context for the item.ootb_price
,ootb_currency
: Capture the displayed price and currency at the time of adding to wishlist.
Updated 3 days ago