Ecommerce

EcommerceTracker

Defines the tracker class for the ecommerce semantic package

Example

To track an event using the ecommerce package, you can use the corresponding method on the tracker instance:

Bird.tracker.ecommerce.checkoutUpdated(event_props, event_opts);

Extends

• Tracker

Methods

cartUpdated()

cartUpdated(props?: EcommerceCartUpdatedProperties, opts?: BirdEventTrackingOptions): void

Parameters

• props?: EcommerceCartUpdatedProperties

• opts?: BirdEventTrackingOptions

Returns

void

cartViewed()

cartViewed(props?: EcommerceCartViewedProperties, opts?: BirdEventTrackingOptions): void

Parameters

• props?: EcommerceCartViewedProperties

• opts?: BirdEventTrackingOptions

Returns

void

checkoutAbandoned()

checkoutAbandoned(props?: EcommerceCheckoutAbandonedProperties, opts?: BirdEventTrackingOptions): void

Parameters

• props?: EcommerceCheckoutAbandonedProperties

• opts?: BirdEventTrackingOptions

Returns

void

checkoutUpdated()

checkoutUpdated(props?: EcommerceCheckoutUpdatedProperties, opts?: BirdEventTrackingOptions): void

Parameters

• props?: EcommerceCheckoutUpdatedProperties

• opts?: BirdEventTrackingOptions

Returns

void

collectionViewed()

collectionViewed(props?: EcommerceCollectionViewedProperties, opts?: BirdEventTrackingOptions): void

Parameters

• props?: EcommerceCollectionViewedProperties

• opts?: BirdEventTrackingOptions

Returns

void

orderCanceled()

orderCanceled(props?: EcommerceOrderCanceledProperties, opts?: BirdEventTrackingOptions): void

Parameters

• props?: EcommerceOrderCanceledProperties

• opts?: BirdEventTrackingOptions

Returns

void

orderConfirmed()

orderConfirmed(props?: EcommerceOrderConfirmedProperties, opts?: BirdEventTrackingOptions): void

Parameters

• props?: EcommerceOrderConfirmedProperties

• opts?: BirdEventTrackingOptions

Returns

void

orderFulfilled()

orderFulfilled(props?: EcommerceOrderFulfilledProperties, opts?: BirdEventTrackingOptions): void

Parameters

• props?: EcommerceOrderFulfilledProperties

• opts?: BirdEventTrackingOptions

Returns

void

productViewed()

productViewed(props?: EcommerceProductViewedProperties, opts?: BirdEventTrackingOptions): void

Parameters

• props?: EcommerceProductViewedProperties

• opts?: BirdEventTrackingOptions

Returns

void

---

EcommerceCartUpdatedProperties

Properties for ecommerce/cart-updated event

Indexable

[k: string]: unknown

Properties

Property	Type
cart_id?	string
checkout_url?	string
currency?	string
customer_email?	string
customer_phone?	string
product_ids?	string[]
product_names?	string[]
product_skus?	string[]
total_price?	number
total_quantity?	number

---

EcommerceCartViewedProperties

Properties for ecommerce/cart-viewed event

Indexable

[k: string]: unknown

Properties

Property	Type
cart_id?	string
checkout_url?	string
currency?	string
customer_email?	string
customer_phone?	string
product_ids?	string[]
product_names?	string[]
product_skus?	string[]
total_price?	number
total_quantity?	number

---

EcommerceCheckoutAbandonedProperties

Properties for ecommerce/checkout-abandoned event

Indexable

[k: string]: unknown

Properties

Property	Type
checkout_id?	string
checkout_url?	string
currency?	string
customer_email?	string
customer_phone?	string
product_categories?	string[]
product_ids?	string[]
product_names?	string[]
product_skus?	string[]
total_price?	number

---

EcommerceCheckoutUpdatedProperties

Properties for ecommerce/checkout-updated event

Indexable

[k: string]: unknown

Properties

Property	Type
checkout_id?	string
checkout_url?	string
currency?	string
customer_email?	string
customer_phone?	string
product_categories?	string[]
product_ids?	string[]
product_names?	string[]
product_skus?	string[]
total_price?	number

---

EcommerceCollectionViewedProperties

Properties for ecommerce/collection-viewed event

Indexable

[k: string]: unknown

---

EcommerceOrderCanceledProperties

Properties for ecommerce/order-canceled event

Indexable

[k: string]: unknown

Properties

Property	Type
currency?	string
customer_email?	string
customer_phone?	string
financial_status?	string
order_canceled_at?	string
order_created_at?	string
order_id?	string
order_number?	string
order_updated_at?	string
order_url?	string
product_categories?	string[]
product_ids?	string[]
product_names?	string[]
product_skus?	string[]
reason?	string
total_price?	number

---

EcommerceOrderConfirmedProperties

Properties for ecommerce/order-confirmed event

Indexable

[k: string]: unknown

Properties

Property	Type
currency?	string
customer_email?	string
customer_phone?	string
financial_status?	string
order_created_at?	string
order_id?	string
order_number?	string
order_updated_at?	string
order_url?	string
product_categories?	string[]
product_ids?	string[]
product_names?	string[]
product_skus?	string[]
total_price?	number

---

EcommerceOrderFulfilledProperties

Properties for ecommerce/order-fulfilled event

Indexable

[k: string]: unknown

Properties

Property	Type
currency?	string
customer_email?	string
customer_phone?	string
financial_status?	string
fulfillment_status?	string
order_closed_at?	string
order_created_at?	string
order_id?	string
order_number?	string
order_processed_at?	string
order_updated_at?	string
order_url?	string
product_categories?	string[]
product_ids?	string[]
product_names?	string[]
product_skus?	string[]
total_price?	number

---

EcommerceProductViewedProperties

Properties for ecommerce/product-viewed event

Indexable

[k: string]: unknown

Properties

Property	Type
price?	number
product_image_url?	string
product_url?	string