Events

Payment Info Entered

User added payment information.
Suggested source: server, website front-end
Properties
Name
Type
Description
Required
checkout_id
string
Checkout transaction ID

no
order_id
string
Order ID

no
payment_method
string
String representing the payment method chosen

no
shipping_method
string
String representing the shipping the method chosen

no
step
number
Number representing a step in the checkout process

yes
products
object[]
Products in the order

yes
coupon
string
Transaction coupon redeemed with the transaction

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

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

no
Example
JSON
{
    "checkout_id": "CHK12345ABC",
    "order_id": "ORD67890XYZ",
    "payment_method": "credit_card",
    "shipping_method": "standard",
    "step": 3,
    "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"
        }
    ],
    "coupon": "SPRING",
    "currency": "USD",
    "value": 15.98
}
{
    "checkout_id": "CHK12345ABC",
    "order_id": "ORD67890XYZ",
    "payment_method": "credit_card",
    "shipping_method": "standard",
    "step": 3,
    "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"
        }
    ],
    "coupon": "SPRING",
    "currency": "USD",
    "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")

﻿
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	Required
checkout_id	string	Checkout transaction ID	no
order_id	string	Order ID	no
payment_method	string	String representing the payment method chosen	no
shipping_method	string	String representing the shipping the method chosen	no
step	number	Number representing a step in the checkout process	yes
products	object[]	Products in the order	yes
coupon	string	Transaction coupon redeemed with the transaction	no
currency	string	Currency code of the transaction (for example, "USD") Pattern: ^[A-Z]{3}$	no
value	number	Revenue ($) with discounts and coupons added in	no

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

Password Reset Started

Product Added to Wishlist