Events

Checkout Abandoned

User abandoned the checkout process.
Suggested source: server
Properties
Name
Type
Description
Required
affiliation
string
Store or affiliation from which this transaction occurred (for example, "Google Store")

﻿
checkout_type
string
Checkout provider (for example, "stripe")

﻿
coupon
string
Transaction coupon redeemed with the transaction

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

﻿
discount
number
Total discount associated with the transaction

﻿
order_id
string
Order/transaction ID

﻿
order_name
string
Order number (for example, "CHORD-000111222")

﻿
products
object[]
﻿
﻿
revenue
number
Revenue ($) associated with the transaction (excluding shipping and tax)

﻿
shipping
number
Shipping cost associated with the transaction

﻿
tax
number
Total tax associated with the transaction

﻿
value
number
Revenue ($) with discounts and coupons added in

﻿
discounted_order_cart_url
string
URL to return to the cart if a cart recovery promotion is available

﻿
order_cart_url
string
URL to return to the cart

﻿
email
string
Email address associated with the order

﻿
phone
string
Phone number associated with the order

﻿
Example
JSON
{
    "affiliation": "My Plant Store",
    "checkout_type": "Shopify",
    "coupon": "SPRING",
    "currency": "USD",
    "discount": 10,
    "order_id": "345678912",
    "order_name": "PLANT-567891234",
    "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"
        }
    ],
    "revenue": 5.98,
    "shipping": 0,
    "tax": 0,
    "value": 15.98,
    "discounted_order_cart_url": "https://example.com/cart?discount=ABANDONED",
    "order_cart_url": "https://example.com/cart",
    "email": "[email protected]",
    "phone": "+1234567890"
}
{
    "affiliation": "My Plant Store",
    "checkout_type": "Shopify",
    "coupon": "SPRING",
    "currency": "USD",
    "discount": 10,
    "order_id": "345678912",
    "order_name": "PLANT-567891234",
    "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"
        }
    ],
    "revenue": 5.98,
    "shipping": 0,
    "tax": 0,
    "value": 15.98,
    "discounted_order_cart_url": "https://example.com/cart?discount=ABANDONED",
    "order_cart_url": "https://example.com/cart",
    "email": "customer@example.com",
    "phone": "+1234567890"
}
﻿
  
products[] array
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")

﻿
brand
string
Brand associated with the product

﻿
bundle
boolean
Product belongs to a bundle

﻿
category
string
Product category

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

﻿
description
string
Short description of the product

﻿
image_url
string
Image URL of the product

﻿
name
string
Name of the product

﻿
option_values
string[]
Option values of the product variant

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

﻿
price
number
Price ($) of the product

﻿
product_id
string
Database ID of the product

﻿
quantity
integer
Quantity of the product

﻿
sku
string
SKU of the product variant

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

﻿
url
string
URL of the product page

﻿
variant
string
Name of the product variant

﻿
line_item_id
string
Database ID of the line item

﻿
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
affiliation	string	Store or affiliation from which this transaction occurred (for example, "Google Store")
checkout_type	string	Checkout provider (for example, "stripe")
coupon	string	Transaction coupon redeemed with the transaction
currency	string	Currency code of the transaction (for example, "USD") Pattern: ^[A-Z]{3}$
discount	number	Total discount associated with the transaction
order_id	string	Order/transaction ID
order_name	string	Order number (for example, "CHORD-000111222")
products	object[]
revenue	number	Revenue ($) associated with the transaction (excluding shipping and tax)
shipping	number	Shipping cost associated with the transaction
tax	number	Total tax associated with the transaction
value	number	Revenue ($) with discounts and coupons added in
discounted_order_cart_url	string	URL to return to the cart if a cart recovery promotion is available
order_cart_url	string	URL to return to the cart
email	string	Email address associated with the order
phone	string	Phone number associated with the order

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

Cart Viewed

Checkout Started