GuidesAPI ReferenceChangelogDiscussions
Log In

📘

Note

All events include Session Properties, Device Properties, App Properties, and Shopify Properties that are present on the Event Object. For more information, refer to the Common Event Object & Metadata document.

Event Properties, however, are unique to every event and are outlined in this page.

The Discount Applied event fires when a user successfully applies a discount code to their cart.

The event properties unique to this event include:

 "event_properties": {
    "event_id": "5e334-8a25-4fd7-b581-e1bc233w2a42",
    "discount_code": "Buy 1 Get 1 50% Off",
    "discount_code_list": ["Buy 1 Get 1 50% Off"],
    "discount_amount_applied": "7.99",
    "cart_subtotal": "55.98",
    "cart_total": "47.99",
    "total_discount_value_applied": "7.99",
    "cart_discounted_items_list": ["7133333062493"],
    "multi_currency_code": "CAD",
    "cart_total_items": "2",
    "cart_total_items_list": ["Jeans", "Tshirt"],
    "cart_total_product_id_list": ["7133333062493", "7134212718685"],
    "cart_id": null,
    "checkout_id": "ae7e30abc2396594fed533we86bca5828",
    "discount_type": "automatic"
  }

event_id String : The unique identifier of the session associated with the event. This event will also exist on the Event object level as well


discount_code String : The discount code a user inputs within their cart or the name of the automatic discount that was applied


discount_code_list List : The total list of discount code(s) a user inputs within their cart that were successfully applied


discount_amount_applied Float : The amount that was taken off of the checkout via the discount code


cart_subtotal Float : The value of the cart before any discounts or gift cards are applied


cart_total Float : The value of the cart after any discounts or gift cards are applied


total_discount_value_applied Float : The total value of all of the discounts that were successfully applied to the cart


cart_id String : The unique ID of the cart


checkout_id String : The Shopify Checkout ID of the checkout event


discount_type String : The type of discount that is applied to the cart (this can be “manual” or ”automatic”)

Note: To view more information on the discount types, reference the Event Sources page


multi_currency_code String : The current currency the user has selected in the app


cart_total_items Integer : The total count of current items in the cart after the discount is applied


cart_total_items_list List : A list of all of the product titles in the cart after the discount is applied


cart_total_product_id_list List : A list of all of the product IDs in the cart after the discount is applied


cart_discounted_items_list List : A list of all of the product IDs of products that had the discount successfully applied within the cart