Events

Product Added

User added a product to their shopping cart.
Suggested source: website front-end
Properties
Name
Type
Description
Required
affiliation
string
Product affiliation to designate a supplying company or brick and mortar store location (for example, "Google Store")

no
brand
string
Brand associated with the product

no
bundle
boolean
Product belongs to a bundle

no
category
string
Product category

no
coupon
string
Coupon code associated with a product (for example, "MAY_DEALS_3")

no
description
string
Short description of the product

no
image_url
string
Image URL of the product

no
name
string
Name of the product

yes
option_values
string[]
Option values of the product variant

no
position
integer
Position in the product list (for example, 3)

no
price
number
Price ($) of the product

yes
product_id
string
Database ID of the product

yes
quantity
integer
Quantity of the product

no
sku
string
SKU of the product variant

yes
slug
string
Slug of the product, often used in URLs (for example, "product-red")

no
url
string
URL of the product page

no
variant
string
Name of the product variant

no
line_item_id
string
Database ID of the line item

no
actionable_date
string
Next date when this subscription will be actionable (renewed, expired, etc.)

no
cart_id
string
ID of the current cart

no
currency
string
Currency code of the transaction (for example, "USD")
Pattern: ^[A-Z]{3}$

no
end_date
string
Subscription will stop auto-renewing after this date

no
installment_count
integer
Number of installments for the prepaid subscription

no
interval_length
integer
Interval number at which the subscription renews

no
interval_units
string
Interval unit at which the subscription renews (for example, "month")

no
prepaid
boolean
Whether the subscription is prepaid

no
products
object[]
Products in the shopping cart

yes
total
number
Revenue ($) with discounts and coupons added in.

yes
value
number
Total value of the product after quantity

yes
Example
JSON
{
    "affiliation": "My Plant Store",
    "brand": "Green Thumb Nurseries",
    "bundle": false,
    "category": "Outdoor Plants",
    "description": "A vibrant, easy-to-care-for garden plant perfect for adding a splash of color to any outdoor space.",
    "image_url": "https://example.com/images/petunia.jpg",
    "name": "Petunia",
    "option_values": [
        "Purple",
        "Red",
        "White"
    ],
    "position": 3,
    "price": 7.99,
    "product_id": "123456789",
    "sku": "PETUNIA-001",
    "slug": "petunia",
    "url": "https://example.com/plants/petunia",
    "variant": "Purple",
    "coupon": "SPRING",
    "line_item_id": "234567891",
    "quantity": 2,
    "actionable_date": "2019-01-01T00:00:00Z",
    "cart_id": "1234",
    "currency": "USD",
    "end_date": "2019-01-01T00:00:00Z",
    "installment_count": 1,
    "interval_length": 1,
    "interval_units": "month",
    "prepaid": false,
    "products": [
        {
            "affiliation": "My Plant Store",
            "brand": "Green Thumb Nurseries",
            "bundle": false,
            "category": "Outdoor Plants",
            "coupon": "SPRING",
            "description": "A vibrant, easy-to-care-for garden plant perfect for adding a splash of color to any outdoor space.",
            "image_url": "https://example.com/images/petunia.jpg",
            "line_item_id": "234567891",
            "name": "Petunia",
            "option_values": [
                "Purple",
                "Red",
                "White"
            ],
            "position": 3,
            "price": 7.99,
            "product_id": "123456789",
            "quantity": 2,
            "sku": "PETUNIA-001",
            "slug": "petunia",
            "url": "https://example.com/plants/petunia",
            "variant": "Purple"
        }
    ],
    "total": 15.98,
    "value": 15.98
}
{
    "affiliation": "My Plant Store",
    "brand": "Green Thumb Nurseries",
    "bundle": false,
    "category": "Outdoor Plants",
    "description": "A vibrant, easy-to-care-for garden plant perfect for adding a splash of color to any outdoor space.",
    "image_url": "https://example.com/images/petunia.jpg",
    "name": "Petunia",
    "option_values": [
        "Purple",
        "Red",
        "White"
    ],
    "position": 3,
    "price": 7.99,
    "product_id": "123456789",
    "sku": "PETUNIA-001",
    "slug": "petunia",
    "url": "https://example.com/plants/petunia",
    "variant": "Purple",
    "coupon": "SPRING",
    "line_item_id": "234567891",
    "quantity": 2,
    "actionable_date": "2019-01-01T00:00:00Z",
    "cart_id": "1234",
    "currency": "USD",
    "end_date": "2019-01-01T00:00:00Z",
    "installment_count": 1,
    "interval_length": 1,
    "interval_units": "month",
    "prepaid": false,
    "products": [
        {
            "affiliation": "My Plant Store",
            "brand": "Green Thumb Nurseries",
            "bundle": false,
            "category": "Outdoor Plants",
            "coupon": "SPRING",
            "description": "A vibrant, easy-to-care-for garden plant perfect for adding a splash of color to any outdoor space.",
            "image_url": "https://example.com/images/petunia.jpg",
            "line_item_id": "234567891",
            "name": "Petunia",
            "option_values": [
                "Purple",
                "Red",
                "White"
            ],
            "position": 3,
            "price": 7.99,
            "product_id": "123456789",
            "quantity": 2,
            "sku": "PETUNIA-001",
            "slug": "petunia",
            "url": "https://example.com/plants/petunia",
            "variant": "Purple"
        }
    ],
    "total": 15.98,
    "value": 15.98
}
﻿
  
option_values[] array
Option values of the product variant
Option value (for example, "red")
Item Type: stringExample
JSON
[
    "Purple"
]
[
    "Purple"
]
﻿
  
products[] array
Products in the shopping cart
The product
Item Properties
Name
Type
Description
Required
affiliation
string
Product affiliation to designate a supplying company or brick and mortar store location (for example, "Google Store")

no
brand
string
Brand associated with the product

no
bundle
boolean
Product belongs to a bundle

no
category
string
Product category

no
coupon
string
Coupon code associated with a product (for example, "MAY_DEALS_3")

no
description
string
Short description of the product

no
image_url
string
Image URL of the product

no
name
string
Name of the product

yes
option_values
string[]
Option values of the product variant

no
position
integer
Position in the product list (for example, 3)

no
price
number
Price ($) of the product

yes
product_id
string
Database ID of the product

yes
quantity
integer
Quantity of the product

yes
sku
string
SKU of the product variant

no
slug
string
Slug of the product, often used in URLs (for example, "product-red")

no
url
string
URL of the product page

no
variant
string
Name of the product variant

no
line_item_id
string
Database ID of the line item

no
Example
JSON
[
    {
        "affiliation": "My Plant Store",
        "brand": "Green Thumb Nurseries",
        "bundle": false,
        "category": "Outdoor Plants",
        "description": "A vibrant, easy-to-care-for garden plant perfect for adding a splash of color to any outdoor space.",
        "image_url": "https://example.com/images/petunia.jpg",
        "name": "Petunia",
        "option_values": [
            "Purple",
            "Red",
            "White"
        ],
        "position": 3,
        "price": 7.99,
        "product_id": "123456789",
        "sku": "PETUNIA-001",
        "slug": "petunia",
        "url": "https://example.com/plants/petunia",
        "variant": "Purple",
        "coupon": "SPRING",
        "line_item_id": "234567891",
        "quantity": 2
    }
]
[
    {
        "affiliation": "My Plant Store",
        "brand": "Green Thumb Nurseries",
        "bundle": false,
        "category": "Outdoor Plants",
        "description": "A vibrant, easy-to-care-for garden plant perfect for adding a splash of color to any outdoor space.",
        "image_url": "https://example.com/images/petunia.jpg",
        "name": "Petunia",
        "option_values": [
            "Purple",
            "Red",
            "White"
        ],
        "position": 3,
        "price": 7.99,
        "product_id": "123456789",
        "sku": "PETUNIA-001",
        "slug": "petunia",
        "url": "https://example.com/plants/petunia",
        "variant": "Purple",
        "coupon": "SPRING",
        "line_item_id": "234567891",
        "quantity": 2
    }
]
﻿
  
products[].option_values[] array
Option values of the product variant
Option value (for example, "red")
Item Type: stringExample
JSON
[
    "Purple"
]
[
    "Purple"
]
﻿
﻿

Name	Type	Description	Required
affiliation	string	Product affiliation to designate a supplying company or brick and mortar store location (for example, "Google Store")	no
brand	string	Brand associated with the product	no
bundle	boolean	Product belongs to a bundle	no
category	string	Product category	no
coupon	string	Coupon code associated with a product (for example, "MAY_DEALS_3")	no
description	string	Short description of the product	no
image_url	string	Image URL of the product	no
name	string	Name of the product	yes
option_values	string[]	Option values of the product variant	no
position	integer	Position in the product list (for example, 3)	no
price	number	Price ($) of the product	yes
product_id	string	Database ID of the product	yes
quantity	integer	Quantity of the product	no
sku	string	SKU of the product variant	yes
slug	string	Slug of the product, often used in URLs (for example, "product-red")	no
url	string	URL of the product page	no
variant	string	Name of the product variant	no
line_item_id	string	Database ID of the line item	no
actionable_date	string	Next date when this subscription will be actionable (renewed, expired, etc.)	no
cart_id	string	ID of the current cart	no
currency	string	Currency code of the transaction (for example, "USD") Pattern: ^[A-Z]{3}$	no
end_date	string	Subscription will stop auto-renewing after this date	no
installment_count	integer	Number of installments for the prepaid subscription	no
interval_length	integer	Interval number at which the subscription renews	no
interval_units	string	Interval unit at which the subscription renews (for example, "month")	no
prepaid	boolean	Whether the subscription is prepaid	no
products	object[]	Products in the shopping cart	yes
total	number	Revenue ($) with discounts and coupons added in.	yes
value	number	Total value of the product after quantity	yes

Name	Type	Description	Required
affiliation	string	Product affiliation to designate a supplying company or brick and mortar store location (for example, "Google Store")	no
brand	string	Brand associated with the product	no
bundle	boolean	Product belongs to a bundle	no
category	string	Product category	no
coupon	string	Coupon code associated with a product (for example, "MAY_DEALS_3")	no
description	string	Short description of the product	no
image_url	string	Image URL of the product	no
name	string	Name of the product	yes
option_values	string[]	Option values of the product variant	no
position	integer	Position in the product list (for example, 3)	no
price	number	Price ($) of the product	yes
product_id	string	Database ID of the product	yes
quantity	integer	Quantity of the product	yes
sku	string	SKU of the product variant	no
slug	string	Slug of the product, often used in URLs (for example, "product-red")	no
url	string	URL of the product page	no
variant	string	Name of the product variant	no
line_item_id	string	Database ID of the line item	no

Product Added to Wishlist

Product Clicked