LogoLogo
  • Contributing to RudderStack
  • Destination_Name
  • LICENSE
  • RudderStack Docs
  • docs
    • FAQ
    • Identity Resolution
    • Home
    • cloud-extract-sources
      • ActiveCampaign Source
      • Bing Ads
      • Chargebee
      • Common Settings
      • Facebook Ads
      • Freshdesk
      • Google Ads Source
      • Google Analytics
      • Google Search Console
      • Google Sheets
      • Cloud Extract Sources
      • Intercom v2
      • Intercom
      • Mailchimp
      • Marketo
      • Mixpanel
      • NetSuite
      • Pipedrive
      • QuickBooks
      • Salesforce Pardot
      • Sendgrid Source
      • Stripe Source
      • Xero
      • Zendesk Chat
      • Zendesk
      • hubspot
        • HubSpot Data Model and Schema Information
        • HubSpot
      • salesforce
        • Salesforce
        • Schema Comparison: RudderStack vs. Segment
    • connections
      • Connection Modes: Cloud Mode vs. Device Mode
    • data-governance
      • Data Governance
      • RudderTyper
      • Data Governance API
      • RudderTyper
      • tracking-plans
        • Tracking Plans
        • Tracking Plan Spreadsheet
    • data-warehouse-integrations
      • Amazon Redshift
      • Azure Data Lake
      • Azure Synapse
      • ClickHouse
      • Databricks Delta Lake
      • Google Cloud Storage Data Lake
      • Google BigQuery
      • Identity Resolution
      • Warehouse Destinations
      • Microsoft SQL Server
      • PostgreSQL
      • Amazon S3 Data Lake
      • Snowflake
      • FAQ
      • Warehouse Schema
    • destinations
      • Destinations
      • Webhooks
      • advertising
        • Bing Ads
        • Criteo
        • DCM Floodlight
        • Facebook App Events
        • Facebook Custom Audience
        • Facebook Pixel
        • Google Ads (gtag.js)
        • Google AdWords Enhanced Conversions
        • Google Adwords Remarketing Lists (Customer Match)
        • Advertising
        • LinkedIn Insight Tag
        • Lotame
        • Pinterest Tag
        • Reddit Pixel
        • Snap Pixel
        • TikTok Ads
      • analytics
        • Amplitude
        • AWS Personalize
        • Chartbeat
        • Firebase
        • FullStory
        • Google Analytics 360
        • Google Analytics
        • Heap.io
        • Hotjar
        • Analytics
        • Indicative
        • Keen
        • Kissmetrics
        • Kubit
        • Lytics
        • Mixpanel
        • Pendo
        • PostHog
        • Quantum Metric
        • Singular
        • adobe-analytics
          • Adobe Analytics Heartbeat Measurement
          • Mobile Device Mode Settings
          • Web Device Mode Settings
          • E-commerce Events
          • Adobe Analytics
          • Setting Up Adobe Analytics in RudderStack
        • google-analytics-4
          • Cloud Mode
          • Device Mode
          • Google Analytics 4
          • Setting up Google Analytics 4
        • profitwell
          • ProfitWell
          • Cloud Mode
          • Device Mode
      • attribution
        • Adjust
        • AppsFlyer
        • Branch
        • Attribution
        • Kochava
        • TVSquared
      • business-messaging
        • Business Messaging
        • Intercom
        • Kustomer
        • Slack
        • Trengo
      • continuous-integration
        • Visual Studio App Center
        • Continuous Integration
      • crm
        • Delighted
        • HubSpot
        • CRM
        • Salesforce
        • Variance
        • Zendesk
      • customer-data-platform
        • Customer Data Platform
        • Segment
      • error-reporting
        • Bugsnag
        • Error Reporting
        • Sentry
      • marketing
        • ActiveCampaign
        • AdRoll
        • Airship
        • Appcues
        • Autopilot
        • Blueshift
        • Braze
        • CleverTap
        • Customer.io
        • Gainsight PX
        • Gainsight
        • Marketing
        • Iterable
        • Klaviyo
        • Leanplum
        • Mailchimp
        • Marketo Lead Import
        • Marketo
        • MoEngage
        • Ometria
        • Pardot
        • Post Affiliate Pro
        • Qualtrics
        • SendGrid
        • Salesforce Marketing Cloud
        • Userlist
        • drip
          • Cloud Mode
          • Device Mode
          • Drip
          • Setting Up Drip in RudderStack
      • productivity
        • Google Sheets
        • Productivity
      • storage-platforms
        • Amazon S3
        • DigitalOcean Spaces
        • Google Cloud Storage
        • Storage Platforms
        • Azure Blob Storage
        • MinIO
        • Redis
      • streaming-platforms
        • Amazon EventBridge
        • Amazon Kinesis Firehose
        • Amazon Kinesis
        • Azure Event Hubs
        • BigQuery Stream
        • Confluent Cloud
        • Google Pub/Sub
        • Streaming Platforms
        • Apache Kafka
      • tag-managers
        • Google Tag Manager
        • Tag Managers
      • testing-and-personalization
        • Algolia Insights
        • Candu
        • Google Optimize
        • A/B Testing & Personalization
        • LaunchDarkly
        • Monetate
        • Optimizely Full Stack
        • Optimizely Web
        • Split.io
        • Statsig
        • VWO (Visual Website Optimizer)
    • get-started
      • RudderStack Cloud vs. RudderStack Open Source
      • Glossary
      • Get Started
      • RudderStack Architecture
    • reverse-etl
      • Amazon Redshift
      • Amazon S3
      • ClickHouse
      • FAQ
      • Google BigQuery
      • Reverse ETL
      • PostgreSQL
      • Snowflake
      • common-settings
        • Importing Data using Models
        • Importing Data using Tables
        • Common Settings
        • Sync Modes
        • Sync Schedule
      • features
        • Airflow Provider
        • Features
        • Models
        • Visual Data Mapper
    • rudderstack-api
      • Data Regulation API
      • HTTP API
      • RudderStack API
      • Personal Access Tokens
      • Pixel API
      • Test API
      • api-specification
        • Application Lifecycle Events Specification
        • API Specification
        • Video Events Specification
        • rudderstack-ecommerce-events-specification
          • Browsing
          • Coupons
          • E-Commerce Events Specification
          • Ordering
          • Promotions
          • Reviewing
          • Sharing
          • Wishlist
        • rudderstack-spec
          • Alias
          • Common Fields
          • Group
          • Identify
          • RudderStack Event Specification
          • Page
          • Screen
          • Track
    • rudderstack-cloud
      • Audit Logs
      • Dashboard Overview
      • Destinations
      • RudderStack Cloud
      • Live Events
      • Connection Modes: Cloud Mode vs. Device Mode
      • Sources
      • Teammates (User Management)
      • connections
        • Adding a Destination
        • Connections
    • rudderstack-open-source
      • Control Plane Setup
      • RudderStack Open Source
      • installing-and-setting-up-rudderstack
        • Developer Machine Setup
        • Docker
        • Data Plane Setup
        • Kubernetes
        • Sending Test Events
    • stream-sources
      • App Center
      • AppsFlyer
      • Auth0
      • Braze
      • Customer.io
      • Extole
      • Event Stream Sources
      • Iterable
      • Looker
      • PostHog
      • Segment
      • Shopify
      • Webhook Source
      • rudderstack-sdk-integration-guides
        • Client-side Event Filtering
        • SDKs
        • AMP Analytics
        • Cordova
        • .NET
        • Go
        • Java
        • Node.js
        • PHP
        • Python
        • React Native
        • Ruby
        • Rust
        • Unity
        • SDK FAQs
        • rudderstack-android-sdk
          • Adding Application Class
          • Flushing Events Periodically
          • Android
        • rudderstack-flutter-sdk
          • Flutter SDK v1
          • Flutter v2
          • Flutter
        • rudderstack-ios-sdk
          • iOS
          • tvOS
          • watchOS
        • rudderstack-javascript-sdk
          • Data Storage in Cookies
          • Detecting Ad-blocked Pages
          • JavaScript
          • JavaScript SDK Enhancements
          • JavaScript SDK FAQs
          • Querystring API
          • Quick Start Guide
          • Version Migration Guide
          • consent-managers
            • Consent Managers
            • OneTrust
    • transformations
      • Access Token
      • FAQ
      • Transformations
      • Transformations API
    • user-guides
      • User Guides
      • administrators-guide
        • Troubleshooting Guide
        • Alerting Guide
        • Bucket Configuration Settings for Event Backups
        • Configuration Parameters
        • Event Replay
        • High Availability
        • Horizontal Scaling
        • Administrator's Guides
        • Infrastructure Provisioning
        • Monitoring and Metrics
        • Okta SSO Setup
        • OneLogin SSO Setup
        • RudderStack Grafana Dashboard
        • Software Releases
      • how-to-guides
        • How to Use Custom Domains
        • How to Develop Integrations for RudderStack
        • How to Configure a Destination via the Event Payload
        • How to Filter Events using Different Methods
        • How to Filter Selective Destinations
        • How to Submit a Pull Request for a New Integration
        • How-to Guides
        • How to Debug Live Destination Events
        • How to Use AWS Lambda Functions with RudderStack
        • create-a-new-destination-transformer-for-rudder
          • Best Practices for Coding Transformation Functions in JavaScript
          • How to Create a New Destination Transformation for RudderStack
        • implement-native-js-sdk-integration
          • How to Add a Device Mode SDK to RudderStack JavaScript SDK
          • How to Implement a Native JavaScript SDK Integration
        • rudderstack-jamstack-integration
          • How to Integrate RudderStack with Your JAMstack Site
          • How to Integrate Rudderstack with Your Angular App
          • How to Integrate Rudderstack with Your Astro Site
          • How to Integrate Rudderstack with Your Eleventy Site
          • How to Integrate Rudderstack with Your Ember.js App
          • How to Integrate Rudderstack with a Gatsby Website
          • How to Integrate Rudderstack with a Hugo Site
          • How to Integrate Rudderstack with Your Jekyll Site
          • How to Integrate Rudderstack with Your Next.js App
          • How to Integrate Rudderstack with Your Nuxt.js App
          • How to Integrate Rudderstack with Your Svelte App
          • How to Integrate Rudderstack with Your Vue App
      • migration-guides
        • Migrating from Blendo to RudderStack
        • Migrating Your Warehouse Destination from Segment to RudderStack
        • Migration Guides
        • Migrating from Segment to RudderStack
  • src
    • @rocketseat
      • gatsby-theme-docs
        • text
          • Home
Powered by GitBook
On this page
  • Introduction
  • Product Added to Wishlist
  • Product Removed from Wishlist
  • Wishlist Product Added to Cart
  • Contact Us

Was this helpful?

  1. docs
  2. rudderstack-api
  3. api-specification
  4. rudderstack-ecommerce-events-specification

Wishlist

Detailed description of the ecommerce lifecycle events related to the customer's wishlisting activity

Introduction

The product wishlisting events are associated with the key activities that a customer might perform while adding a product to their shopping wishlist. This is useful if your website/app supports the wishlisting feature.

Product Added to Wishlist

This event is triggered whenever a customer adds a product to their shopping wishlist. The following properties are supported by this event:

Property Name

Type

Description of the Property

wishlist_id

String

Contains the wishlist ID to which the product was added

wishlist_name

String

Contains the name of the wishlist to which the product was added

product_id

String

Contains the database ID of the product being viewed

sku

String

Contains the SKU of the product

category

String

Contains the category of the product being viewed

name

String

Contains the name of the product

brand

String

Contains the name of the brand associated with the product

variant

String

Contains the name of the variant associated with the product

price

Number

Contains the price of the product being viewed (in USD)

quantity

Number

Contains information on the quantity of the product

coupon

String

Contains information about the coupon code associated with the product

position

Number

Contains the position of the product in the product list

url

String

Contains the URL of the product page

image_url

String

Contains the image URL of the product

An example of the Product Added to Wishlist event is as shown:

rudderanalytics.track("Product Added to Wishlist", {
  wishlist_id: "12345",
  wishlist_name: "Games",
  product_id: "235564423234",
  sku: "F-17",
  category: "Games",
  name: "Cards",
  brand: "Imagepro",
  variant: "123",
  price: 8.99,
  quantity: 1,
  coupon: "COUPON",
  position: 1,
  url: "https://www.site.com/product/path",
  image_url: "https://www.site.com/product/path.jpg",
})

Product Removed from Wishlist

This event is triggered whenever a customer removes a product from their shopping wishlist. The following properties are supported by this event:

Property

Type

Description

wishlist_id

String

Contains the wishlist ID to which the product was added

wishlist_name

String

Contains the name of the wishlist to which the product was added

product_id

String

Contains the database ID of the product being viewed

sku

String

Contains the SKU of the product

category

String

Contains the category of the product being viewed

name

String

Contains the name of the product

brand

String

Contains the name of the brand associated with the product

variant

String

Contains the name of the variant associated with the product

price

Number

Contains the price of the product being viewed (in USD)

quantity

Number

Contains information on the quantity of the product

coupon

String

Contains information about the coupon code associated with the product

position

Number

Contains the position of the product in the product list

url

String

Contains the URL of the product page

image_url

String

Contains the image URL of the product

An example of the Product Removed from Wishlist event is as shown:

rudderanalytics.track("Product Removed from Wishlist", {
  wishlist_id: "12345",
  wishlist_name: "Games",
  product_id: "235564423234",
  sku: "F-17",
  category: "Games",
  name: "Cards",
  brand: "Imagepro",
  variant: "123",
  price: 8.99,
  quantity: 1,
  coupon: "COUPON",
  position: 1,
  url: "https://www.site.com/product/path",
  image_url: "https://www.site.com/product/path.jpg",
})

Wishlist Product Added to Cart

This event is triggered whenever a wishlisted product is added to the shopping cart by the customer. The following properties are supported by this event:

Property

Type

Description

wishlist_id

String

Contains the wishlist ID to which the product was added

wishlist_name

String

Contains the name of the wishlist to which the product was added

product_id

String

Contains the database ID of the product being viewed

sku

String

Contains the SKU of the product

category

String

Contains the category of the product being viewed

name

String

Contains the name of the product

brand

String

Contains the name of the brand associated with the product

variant

String

Contains the name of the variant associated with the product

price

Number

Contains the price of the product being viewed (in USD)

quantity

Number

Contains information on the quantity of the product

coupon

String

Contains information about the coupon code associated with the product

position

Number

Contains the position of the product in the product list

url

String

Contains the URL of the product page

image_url

String

Contains the image URL of the product

An example of the Wishlist Product Added to Cart event is as shown:

rudderanalytics.track("Wishlist Product Added to Cart", {
  wishlist_id: "12345",
  wishlist_name: "Games",
  product_id: "235564423234",
  sku: "F-17",
  category: "Games",
  name: "Cards",
  brand: "Imagepro",
  variant: "123",
  price: 8.99,
  quantity: 1,
  coupon: "COUPON",
  position: 1,
  url: "https://www.site.com/product/path",
  image_url: "https://www.site.com/product/path.jpg",
})

Contact Us

PreviousSharingNextrudderstack-spec

Last updated 3 years ago

Was this helpful?

To know more about the RudderStack eCommerce spec, feel free to or start a conversation in our community. You can also to see RudderStack in action.

contact us
Slack
request a demo