Ordering Events

Product Added

Property

Type

Description

cart_id

String

Cart ID to which the product was added

product_id

String

Product ID displayed on the list

sku

String

SKU of the product being viewed

name

String

Name of the product being viewed

category

String

Category of the product

subcategory

String

Sub-category of the product

brand

String

Brand associated with the product

variant

Object

Variant of the product

price

Number

Price of the product being viewed

net_amount

Number

Price after discount

currency

String

Currency

discount

Number

Discount on the price of product being viewed

quantity

Number

Quantity of a product

position

Number

Position in the product list

url

String

URL of the product page

image_url

String

Image url of the product

Product Removed

Property

Type

Description

cart_id

String

Cart ID to which the product was added

product_id

String

Product ID displayed on the list

sku

String

SKU of the product being viewed

name

String

Name of the product being viewed

category

String

Category of the product

subcategory

String

Sub-category of the product

brand

String

Brand associated with the product

variant

Object

Variant of the product

price

Number

Price of the product being viewed

currency

String

Currency code associated with the transaction

discount

Number

Discount on the price of product being viewed

net_amount

Number

Price after discount

quantity

Number

Quantity of a product

position

Number

Position in the product list

url

String

URL of the product page

image_url

String

Image url of the product

Cart Viewed

Property

Type

Description

cart_id

String

Shopping cart ID

value

Number

Total value of the items in cart without discounts, delivery charges or additional charges

discount

Number

Total discount on the cart value

shipping_charges

Number

Shipping cost associated with the cart.

additional_charges

Number

Additional charges like packaging, tax (if not included in the cart value or shipping charges), etc

products

Array

List of displayed products

products.$.product_id

String

Product ID displayed on the list

products.$.sku

String

SKU of the product being viewed

products.$.name

String

Name of the product being viewed

products.$.category

String

Category of the product

products.$.subcategory

String

Sub-category of the product

products.$.brand

String

Brand associated with the product

products.$.variant

Object

Variant of the product

products.$.price

Number

Price of the product being viewed

products.$.currency

String

Currency code associated with the transaction

products.$.discount

Number

Discount on the price of product being viewed

products.$.quantity

Number

Quantity of a product

products.$.position

Number

Position in the product list

products.$.url

String

URL of the product page

products.$.image_url

String

Image url of the product

Checkout Started

Property

Type

Description

checkout_id

String

Checkout transaction ID

order_id

String

Order/transaction ID

total_cart_price

Number

Revenue without discounts and coupons added in.

total_discount

Number

Value of discounts and coupons added in.

total_order_amount

Number

Revenue associated with the transaction (excluding shipping, tax, including discounts)

shipping_charges

Number

Shipping cost associated with the cart.

additional_charges

Number

Additional charges like packaging, tax (if not included in the total_cart_price or shipping_charges), etc

coupon

String

Coupon applied with the transaction

currency

String

Currency code associated with the transaction

products

Array

List of displayed products

products.$.product_id

String

Product ID displayed on the list

products.$.sku

String

SKU of the product being viewed

products.$.name

String

Name of the product being viewed

products.$.category

String

Category of the product

products.$.subcategory

String

Sub-category of the product

products.$.brand

String

Brand associated with the product

products.$.variant

Object

Variant of the product

products.$.price

Number

Price of the product being viewed

products.$.currency

String

Currency code associated with the transaction

products.$.discount

Number

Discount on the price of product being viewed

products.$.quantity

Number

Quantity of a product

products.$.position

Number

Position in the product list

products.$.url

String

URL of the product page

products.$.image_url

String

Image url of the product

Checkout Step Viewed

Property

Type

Description

checkout_id

String

Checkout transaction ID

order_id

String

Order/transaction ID

step

Number

Number representing a step in the checkout process

shipping_method

String

String representing the shipping the method chosen

payment_method

String

String representing the payment method chosen

Checkout Step Completed

Property

Type

Description

checkout_id

String

Checkout transaction ID

order_id

String

Order/transaction ID

step

Number

Number representing a step in the checkout process

shipping_method

String

String representing the shipping the method chosen

payment_method

String

String representing the payment method chosen

Payment Info Entered

Property

Type

Description

checkout_id

String

Checkout transaction ID

order_id

String

Order ID (optional)

payment_method

String

String representing the payment method chosen

shipping_method

String

String representing the shipping the method chosen

Order Status Viewed

Property

Type

Description

order_id

String

Order/transaction ID

total_cart_price

Number

Revenue without discounts and coupons added in.

total_discount

Number

Value of discounts and coupons added in.

total_order_amount

Number

Revenue associated with the transaction (excluding shipping, tax, including discounts)

shipping_charges

Number

Shipping cost associated with the cart.

additional_charges

Number

Additional charges like packaging, tax (if not included in the total_cart_price or shipping_charges), etc

coupon

String

Coupon applied with the transaction

currency

String

Currency code associated with the transaction

products

Array

List of displayed products

products.$.product_id

String

Product ID displayed on the list

products.$.sku

String

SKU of the product being viewed

products.$.name

String

Name of the product being viewed

products.$.category

String

Category of the product

products.$.subcategory

String

Sub-category of the product

products.$.brand

String

Brand associated with the product

products.$.variant

Object

Variant of the product

products.$.price

Number

Price of the product being viewed

products.$.currency

String

Currency code associated with the transaction

products.$.discount

Number

Discount on the price of product being viewed

products.$.quantity

Number

Quantity of a product

products.$.position

Number

Position in the product list

products.$.url

String

URL of the product page

products.$.image_url

String

Image url of the product

Order Completed

Property

Type

Description

order_id

String

Order/transaction ID

cart_id

String

Cart ID to which the product was added

total_cart_price

Number

Revenue without discounts and coupons added in.

total_discount

Number

Value of discounts and coupons added in.

total_order_amount

Number

Revenue associated with the transaction (excluding shipping, tax, including discounts)

shipping_charges

Number

Shipping cost associated with the cart.

additional_charges

Number

Additional charges like packaging, tax (if not included in the total_cart_price or shipping_charges), etc

coupon

String

Coupon applied with the transaction

currency

String

Currency code associated with the transaction

products

Array

List of displayed products

products.$.product_id

String

Product ID displayed on the list

products.$.sku

String

SKU of the product being viewed

products.$.name

String

Name of the product being viewed

products.$.category

String

Category of the product

products.$.subcategory

String

Sub-category of the product

products.$.brand

String

Brand associated with the product

products.$.variant

Object

Variant of the product

products.$.price

Number

Price of the product being viewed

products.$.net_amount

Number

Price after discount

products.$.currency

String

Currency code associated with the transaction

products.$.discount

Number

Discount on the price of product being viewed

products.$.quantity

Number

Quantity of a product

products.$.position

Number

Position in the product list

products.$.url

String

URL of the product page

products.$.image_url

String

Image url of the product

Order Updated

Property

Type

Description

order_id

String

Order/transaction ID

total_cart_price

Number

Revenue without discounts and coupons added in.

total_discount

Number

Value of discounts and coupons added in.

total_order_amount

Number

Revenue associated with the transaction (excluding shipping, tax, including discounts)

shipping_charges

Number

Shipping cost associated with the cart.

additional_charges

Number

Additional charges like packaging, tax (if not included in the total_cart_price or shipping_charges), etc

coupon

String

Coupon applied with the transaction

currency

String

Currency code associated with the transaction

products

Array

List of displayed products

products.$.product_id

String

Product ID displayed on the list

products.$.sku

String

SKU of the product being viewed

products.$.name

String

Name of the product being viewed

products.$.category

String

Category of the product

products.$.subcategory

String

Sub-category of the product

products.$.brand

String

Brand associated with the product

products.$.variant

Object

Variant of the product

products.$.price

Number

Price of the product being viewed

products.$.currency

String

Currency code associated with the transaction

products.$.discount

Number

Discount on the price of product being viewed

products.$.quantity

Number

Quantity of a product

products.$.position

Number

Position in the product list

products.$.url

String

URL of the product page

products.$.image_url

String

Image url of the product

Order Cancelled

Property

Type

Description

order_id

String

Order/transaction ID

total_cart_price

Number

Revenue without discounts and coupons added in.

total_discount

Number

Value of discounts and coupons added in.

total_order_amount

Number

Revenue associated with the transaction (excluding shipping, tax, including discounts)

shipping_charges

Number

Shipping cost associated with the cart.

additional_charges

Number

Additional charges like packaging, tax (if not included in the total_cart_price or shipping_charges), etc

coupon

String

Coupon applied with the transaction

currency

String

Currency code associated with the transaction

products

Array

List of displayed products

products.$.product_id

String

Product ID displayed on the list

products.$.sku

String

SKU of the product being viewed

products.$.name

String

Name of the product being viewed

products.$.category

String

Category of the product

products.$.subcategory

String

Sub-category of the product

products.$.brand

String

Brand associated with the product

products.$.variant

Object

Variant of the product

products.$.price

Number

Price of the product being viewed

products.$.currency

String

Currency code associated with the transaction

products.$.discount

Number

Discount on the price of product being viewed

products.$.quantity

Number

Quantity of a product

products.$.position

Number

Position in the product list

products.$.url

String

URL of the product page

products.$.image_url

String

Image url of the product