Remove from Wishlist

This document describes the Out-Of-The-Box (OOTB) Remove From Wishlist event schema for use in your integrations. This event should be sent when a user removes a product from their wishlist, favorites list, or save-for-later area.

Event Key

Event Key	Event Name	Type
`ootb_remove_from_wishlist`	Removed from 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 Remove From Wishlist event.

{
  "context": {
    "ootb_session_id": "248rhdbuw2her1",
    "ootb_wishlist_id": "248rhdbuw2he41",
    "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
  }
}

Parameters

Optional fields are marked with *

Parameter Key	Parameter Name	Type	Description
`ootb_session_id`*	Session ID	String	User’s browser session.
`ootb_wishlist_id`	Wishlist ID	String	User’s wishlist identifier.
`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	Name of the item.
`ootb_brand`	Brand	String	Brand of the product.
`ootb_category`	Category	String	Lowest-level category.
`ootb_department`	Department	String	Top-level category or department.
`ootb_url`*	Page URL	String	Product or variant page URL.
`ootb_page_title`*	Page Title	String	Product page title.
`ootb_page_category`*	Page Category	String	Page category.
`ootb_price`*	Price	Number	Price of the item at the time it was on the wishlist.

Explanation

event: Set to ootb_remove_from_wishlist to indicate a user has removed an item from their wishlist/favorites/save-for-later.
context:
- ootb_session_id: Links the action to the user’s current session, if available.
- ootb_wishlist_id: Identifier for the specific wishlist from which the item was removed.
- ootb_product_id, ootb_variant_id, ootb_sku_id, ootb_item_name, ootb_brand: Identify the exact product, variant, SKU, item name, and brand of the item removed.
- ootb_category, ootb_department: Provide taxonomy for the removed item.
- ootb_url, ootb_page_title, ootb_page_category: Context of the page where the removal action might have occurred or product page details.
- ootb_price: The price of the item as it was on the wishlist, if relevant to track.