OneSignal Help & Documentation

Welcome to the OneSignal New IA developer hub. You'll find comprehensive guides and documentation to help you start working with OneSignal New IA as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    Discussions

Abandoned Cart

Reminding users about their shopping list.

πŸ“˜

Case Studies - ecommerce

MuteSix Increased Revenue by 182% with Abandoned Cart Notifications.

Princeton Review 400% increase in conversions Case Study

Evino Increases Revenue 12% Case Study.

One of the most common uses for notifications is reminding customers about items left in their shopping carts. Used correctly, these notifications will often increase revenue as seen in numerous Case Studies.

This guide will walk you through step-by-step with example code how add abandoned cart notifications to your site or app.

Once setup, OneSignal will automatically send your customized message to users when they leave items in their cart.

Quick Reference

Details

Step 1 Add Abandoned Cart Code

Code examples for easily adding Data Tags which start collecting cart details.

Step 2 Setup Abandoned Cart Segment

Easily setup reusable segments for tracking abandoned cart users.

Step 3 Create Abandoned Cart Message

Create your reusable messages that get sent to customers with Message Personalization like the cart item and image.

Step 4 Setup Abandoned Cart Automated Messages

Let OneSignal automatically send abandoned cart messages to your users.

Optional Setup Abandoned Cart Performance Tracking

Track sends, clicks and actual revenue brought in through our Abandoned Cart Automated Campaigns.

Step 1 Add Abandoned Cart Code

When a customer adds an item to the cart (usually by clicking "Add to cart" button), let's use OneSignal Data Tags to track 3 things: 1 - the event occurred (required), 2 - the name of the item added (optional), 3 - the image url of the item added (optional).

We recommend tagging customers the moment they add an item to the shopping cart and if multiple items are added, override these tags with the latest item because it will be easier for the customer to remember the most recent item added.

The below example covers if your store's "add to cart" button is on a page with a single button (like a product details page) or multiple buttons (multiple products to add to cart).

<script>
let productName = "Name of the Product";//Replace with the name of item
let productImageURL = "https://yoursiteurl.com/image-file.jpg";//Replace with the url to the image
//Use this example method when user adds item to cart
function addTagsUponCartUpdate(productName, productImageURL) {
  OneSignal.push(function () {
    let timestamp = Math.floor(Date.now() / 1000);
    OneSignal.sendTags({
      cart_update: timestamp,
      product_name: productName,
      product_image: productImageURL,
    }).then(function (tagsSent) {
      // Callback called when tags have finished sending
      console.log(tagsSent);
    });
  });
}
</script>
<script>
//Example if page has a single "Add to cart" button like "product description" page
window.addEventListener("load", () => {
  // replace ".add-to-cart-btn" with the class name of your cart button element
  const addToCartButton = document.querySelector(".add-to-cart-btn");
  // replace ".product-title" with the class name of the element containing your product name
  let productName = document.querySelector(".product-title").innerHTML;
  console.log("productName: ", productName);
  // replace ".product-img" with the class name of your product img element
  let productImageURL = document.querySelector(".product-img").src;
  console.log("productImageURL: ", productImageURL);
  addToCartButton.addEventListener("click", () => {
    OneSignal.push(function () {
      let timestamp = Math.floor(Date.now() / 1000);
      OneSignal.sendTags({
        cart_update: timestamp,
        product_name: productName,
        product_image: productImageURL,
      }).then(function (tagsSent) {
        // Callback called when tags have finished sending
        console.log(tagsSent);
      });
    });
  });
});
</script>
<script>
//Example if page has multiple "Add to cart" buttons, see: https://onesignaldemo.github.io/
window.addEventListener("load", () => {
  let buttonsDOM = [];
  // replace ".add-to-cart-btn" with the class name of your cart button element
  const addToCartButtons = [
    ...document.querySelectorAll(".add-to-cart-btn"),
  ];
  buttonsDOM = addToCartButtons;
  addToCartButtons.forEach((addToCartButton) => {
    // this example adds the product id witin each "add-to-cart" button
    // this creates unique id attributes for each product to identify them
    // this example assumes you use unique id attributes for the product title and image
    let id = addToCartButton.dataset.id;
    addToCartButton.addEventListener("click", () => {
      // replace `product-title-id-${id}` with the id of the element containing your product name
      let productName = document.getElementById(`product-title-id-${id}`)
        .innerHTML;
      console.log("productName: ", productName);
      // replace `product-img-id-${id}` with the id of the element containing your product image
      let productImageURL = document.getElementById(`product-img-id-${id}`)
        .src;
      console.log("productImageURL: ", productImageURL);
      OneSignal.push(function () {
        let timestamp = Math.floor(Date.now() / 1000);
        OneSignal.sendTags({
          cart_update: timestamp,
          product_name: productName,
          product_image: productImageURL,
        }).then(function (tagsSent) {
          // Callback called when tags have finished sending
          console.log(tagsSent);
        });
      });
    });
  });
});
</script>

Next, let's make sure we do not send abandoned cart notifications if the user checks out or removes items from their cart. We need to check the cart and if item(s) are removed, update the tags to any item still in the cart and if a purchase is made, remove all tags.

Tags can be changed by setting them to a new value or deleted by setting them to an empty string.

<script>
//Removes the cart tags, call when user purchases or removes items from cart
function removeCartTags(){
  OneSignal.push(function () {
    OneSignal.sendTags({
      cart_update: "",
      product_name: "",
      product_image: "",
    }).then(function (tagsSent) {
      // Callback called when tags have finished sending
      console.log(tagsSent);
    });
  });
}
</script>
<script>
//Example update/remove tags if cart changes, call this method within your 
function updateOSTagsOnCartChange() {
  // this example checks how many items are in the cart element
  // replace ".cart-content" with the class name of your div holding all cart items
  const cartContent = document.querySelector(".cart-content");
  // if an item remains, update tags to the topmost item
  if (cartContent.children.length > 0) {
    // replace ".cart-product-title" with the class name of the element containing your product name
    let productName = document.querySelector(".cart-product-title")
      .innerHTML;
    console.log("cart productName: ", productName);
    // replace ".cart-product-img" with the class name of your product img element
    let productImageURL = document.querySelector(".cart-product-img").src;
    console.log("productImageURL: ", productImageURL);
    OneSignal.push(function () {
      let timestamp = Math.floor(Date.now() / 1000);
      OneSignal.sendTags({
        cart_update: timestamp,
        product_name: productName,
        product_image: productImageURL,
      }).then(function (tagsSent) {
        // Callback called when tags have finished sending
        console.log(tagsSent);
      });
    });
  } else {
    OneSignal.sendTags({
      cart_update: "",
      product_name: "",
      product_image: "",
    }).then(function (tagsSent) {
      // Callback called when tags have finished sending
      console.log(tagsSent);
    });
  }
}

// replace ".clear-cart" with the class name of your element that removes cart items 
const clearCartBtn = document.querySelector(".clear-cart");
if (typeof clearCartBtn != "undefined" && clearCartBtn != null) {
  clearCartBtn.addEventListener("click", () => {
    updateOSTagsOnCartChange();
  });
}

// replace ".submit-payment" with the class name of your element that submits payment
const submitPaymentBtn = document.querySelector(".submit-payment");
if (typeof submitPaymentBtn != "undefined" && submitPaymentBtn != null) {
  submitPaymentBtn.addEventListener("click", () => {
    console.log("submit payment");
    OneSignal.sendTags({
      cart_update: "",
      product_name: "",
      product_image: "",
    }).then(function (tagsSent) {
      // Callback called when tags have finished sending
      console.log(tagsSent);
    });
  });
}
});
</script>

πŸ‘

Abandoned Cart Code Finished

If the user leaves your site without checking out (abandoning their cart), you now have enough information to target them with a personalized abandoned cart notification.


Step 2 Setup Abandoned Cart Segment

Once the tagging setup is complete we'll need to target these users and send them notifications after some time has passed. In your OneSignal Dashboard, go to Audience > Segments.

OneSignal's Segments allow for grouping devices based on the data collected: 1 - if they have items in the cart and 2 - how long it has been since those items were left in the cart.

Option 1 With Last Session Filter:

This segment will include users that have items in their cart and have left the site or mobile app over 1 hour ago. The user adds an item to the cart, then leaves the app or site, 1 hour later they will be in this segment.

  1. Select the "User Tag" filter
  2. Set cart_update to "exists"
  3. Select "Add Filter" to create an "AND" relationship.
  4. Select "Last Session" filter and set "greater than" 1.
  5. Name the Segment Abandoned Cart 1 Hour (not required but helpful to remember).

Option 2 With Time Operators:

Paid Plan Required

This segment will include users that added an item to their cart over 1 hour ago.

The cart_update tag key has a unix timestamp value. We can segment users based on how much time has passed since that tag was added.

  1. Select the "User Tag" filter.
  2. Set cart_update with "time elapsed greater than" and number of seconds.
    Example: 3600 for 1 hour (60 seconds * 60 minutes)
  3. Name the Segment Abandoned Cart 1 Hour (not required but helpful to remember)

πŸ‘

Abandoned Cart Segment Finished

As users add/remove items from their cart and leave/return to the site, they will automatically move in and out of this segment.

You can always come back into this segment later if you want to change the time frame from 1 hour to a higher timeframe.

Segments can be duplicated to create more and setup different time frames if you want to send different messages after longer timeframes as well.


Step 3 Create Abandoned Cart Message

This is where we can use some creativity! If your site/app has certain phrases, language, or emojis you like, then use it! All that is great for brand recognition, get users to click, and getting them to checkout.

Also, using the product_name and product_image tags, we can include this data within the message for Message Personalization.

For example, we can say: "Hey Cool Cat 😸 ! Your new Yellow Cat Water Dish is waiting for you!".
And include the picture of the item in the message.

In the OneSignal Dashboard, go to Messages > Templates and select "New Push Template".

Templates are a way to create reusable message and monitor how many times they have been sent and clicked.

  1. Name the Template: Abandoned Cart 1 Hour or whatever you named the Segment.
  2. Add your Title, example: Hey Cool Cat 😸 !
  3. Add your Message, example: Your new {{product_name | default: "item"}} is waiting for you!
  • here {{product_name | default: "item"}} will be replaced by whatever value is set for that tag. If no tag is set than "item" will be used.
  1. Set the Image to be: {{product_image}}
  • here {{product_image}} will be replaced with the URL of the image to the product. If tag value is not a direct link to the image, then it will not show.
  1. Set the Launch URL to be the URL of your checkout page
  • here if the checkout page is unique per user, we would need to either link to the cart page (if not unique) or use more tag substitution. For example, if your checkout page is: https://yoursite.com/username/checkout we need to tag the user with a user_name tag so their username can be replaced if we use: https://yoursite.com/{{user_name}}/checkout

Important: you can use any language in these fields (does not have to be English) and if you want to add more than 1 language, just select "Add Languages" to put your own translation for the message.

Emojis can be copy-pasted into the field. Here is a great site for emojis.

  1. Under the preview, click "Send To Test Device" to test out how it looks! See Find Devices & Set Test Users if you are not a test user yet.

  2. When done press "Save" at the bottom.

πŸ‘

Abandoned Cart Message Finished

Now that our reusable template is setup, we can return to the Messages > Templates page to keep an eye on how many times this has been sent and opened.


Step 4 Setup Abandoned Cart Automated Messages

Within the OneSignal Dashboard visit Messages > Automated > New Automated Push to setup this Abandoned Cart Automated Message campaign.

  1. Name the Automated Message: Abandoned Cart 1 Hour (should be the same name as the Segment and Template to keep things simple).
  2. Select "Send to Particular Segment(s)" > Click "X" on the Subscribed Users Segment > Click "Add Segment" and select "+" next to the Abandoned Cart 1 Hour segment.
  3. Select the Message Template: Abandoned Cart 1 Hour
  1. Set the Delivery Schedule to be "Immediately"
  • here you can use "Intelligent Delivery" or "Timezone" option, but the message may take up to 24 hours. Details in Sending Push Messages.
  1. Select "If the user returns to the app"
  • here the message will be sent again after the user returns to the site or app and if they are still in the segment.
  • Optional: if you select "After a certain amount of time" you can set 24 hours to resend the push if the user is still in the segment after 24 hours.
  1. Click "Make Active"

πŸ‘

Abandoned Cart Code Finished! πŸ₯³

You have successfully finished Abandoned Cart setup! Visit your site or app, make sure to subscribe, then add an item to your cart and leave the site.

If you have a paid OneSignal account, you should receive the abandoned cart push after about an hour.

If you are on a free OneSignal account, Automated Messages may take several hours to send.


Optional Setup Abandoned Cart Performance Tracking

Once abandoned cart message are set up, you can track how well it performs by going to Templates and looking at the open and click rates.

If you have a Paid OneSignal Account, you can also use Outcomes to track actual revenue brought in.

When the customer finishes payment, upon selection of the "Submit Payment" button call the following method.

//Example to get the price and total items in cart
// replace ".checkout-price-total" with the class name the element containing the cart's total price
const checkoutPriceTotal = document.querySelector(".checkout-price-total").innerText;
// optional replace ".checkout-items-total" with the class name the element containing the total items in cart to be purchased
const checkoutItemsTotal = document.querySelector(".checkout-items-total").innerText;
//Call this method in the click event for the final button to submit payment
function updateOSOnCartPurchase(checkoutPriceTotal, checkoutItemsTotal) {
  let purchasePriceTotal = parseFloat(checkoutPriceTotal);
  let purchasedItemCount = parseInt(checkoutItemsTotal);
  OneSignal.push(function () {
    OneSignal.sendOutcome("Purchase", purchasePriceTotal);
    OneSignal.sendOutcome("Purchased Item Count", purchasedItemCount);
  });
}
//example of adding this method to the "submit-payment" button
const submitPurchaseButton = document.querySelector(".submit-payment");
if (typeof submitPurchaseButton != "undefined" && submitPurchaseButton != null) {
  submitPurchaseButton.addEventListener("click", () => {
    updateOSOnCartPurchase(checkoutPriceTotal, checkoutItemsTotal);
  });
}
  • OneSignal.sendOutcome("Purchase", purchasePriceTotal); - will send OneSignal the total purchase amount and accumulate that revenue for all purchases made by all customers that clicked a push or received a push within a specific timeframe (influenced) and made the purchase.

  • OneSignal.sendOutcome("Purchased Item Count", purchasedItemCount); - will send OneSignal the total amount of items purchased associated with the customer that directly clicked the push to make a purchase or made the purchase "influenced" by a push.

πŸ‘

πŸ”₯ Full Abandoned Cart Implementation Achieved! πŸ‘ 🎊

You are now an OneSignal expert! You achieved an in-depth implementation of OneSignal's offering and are ready to do more! Continue adding more best practices outlined in our Use Cases & Best Practices or follow the links below to go into more depth on these individual features.

Updated about a month ago



Abandoned Cart


Reminding users about their shopping list.

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.