Events

Checkout Started

User initiated the order process (a transaction is created).
Suggested source: server, website front-end
Properties
Name
Type
Description
Required
affiliation
string
Store or affiliation from which this transaction occurred (for example, "Google Store")

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

no
coupon
string
Transaction coupon redeemed with the transaction

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

no
discount
number
Total discount associated with the transaction

no
order_id
string
Order/transaction ID

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

no
products
object[]
Products in the order

yes
revenue
number
Revenue ($) associated with the transaction (excluding shipping and tax)

no
shipping
number
Shipping cost associated with the transaction

no
tax
number
Total tax associated with the transaction

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

no
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
}
{
    "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
}
﻿
  
products[] array
Products in the order
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

no
product_id
string
Database ID of the product

yes
quantity
integer
Quantity of the product

no
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	Store or affiliation from which this transaction occurred (for example, "Google Store")	no
checkout_type	string	Checkout provider (for example, "stripe")	no
coupon	string	Transaction coupon redeemed with the transaction	no
currency	string	Currency code of the transaction (for example, "USD") Pattern: ^[A-Z]{3}$	no
discount	number	Total discount associated with the transaction	no
order_id	string	Order/transaction ID	no
order_name	string	Order number (for example, "CHORD-000111222")	no
products	object[]	Products in the order	yes
revenue	number	Revenue ($) associated with the transaction (excluding shipping and tax)	no
shipping	number	Shipping cost associated with the transaction	no
tax	number	Total tax associated with the transaction	no
value	number	Revenue ($) with discounts and coupons added in	no

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	no
product_id	string	Database ID of the product	yes
quantity	integer	Quantity of the product	no
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

Checkout Abandoned

Checkout Step Completed