Ecommerce

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

Example

Android

val properties = EcommerceCheckoutUpdatedProperties(
    checkoutId = checkoutId
)
bird.tracker.ecommerce.checkoutUpdated(properties)

Swift

Web

Methods

checkoutUpdated()

Android

val properties = EcommerceCheckoutUpdatedProperties(
    checkoutId = checkoutId
)
bird.tracker.ecommerce.checkoutUpdated(properties)

Swift

Web

EcommerceCheckoutUpdatedProperties

Property	Type
checkout_id?	String
checkout_url?	String
currency?	String
customer_email?	String
customer_phone?	String
items?	Array<Map<String, Any?>>
product_categories?	Array
product_ids?	Array
product_names?	Array
product_skus?	Array
total_price?	Number

checkoutAbandoned()

Android

val properties = EcommerceCheckoutAbandonedProperties(
    billingAddress = billingAddress
)
bird.tracker.ecommerce.checkoutAbandoned(properties)

Swift

Web

EcommerceCheckoutAbandonedProperties

Property	Type
billing_address?	Map<String, Any?>
checkout_id?	String
checkout_url?	String
currency?	String
customer_email?	String
customer_phone?	String
items?	Array<Map<String, Any?>>
product_categories?	Array
product_ids?	Array
product_names?	Array
product_skus?	Array
total_price?	Number

orderConfirmed()

Android

val properties = EcommerceOrderConfirmedProperties(
    billingAddress = billingAddress
)
bird.tracker.ecommerce.orderConfirmed(properties)

Swift

Web

EcommerceOrderConfirmedProperties

Property	Type
billing_address?	Map<String, Any?>
currency?	String
customer_email?	String
customer_phone?	String
financial_status?	String
items?	Array<Map<String, Any?>>
order_created_at?	String
order_id?	String
order_number?	String
order_updated_at?	String
order_url?	String
product_categories?	Array
product_ids?	Array
product_names?	Array
product_skus?	Array
shipping_address?	Map<String, Any?>
total_price?	Number

orderCanceled()

Android

val properties = EcommerceOrderCanceledProperties(
    billingAddress = billingAddress
)
bird.tracker.ecommerce.orderCanceled(properties)

Swift

Web

EcommerceOrderCanceledProperties

Property	Type
billing_address?	Map<String, Any?>
currency?	String
customer_email?	String
customer_phone?	String
financial_status?	String
items?	Array<Map<String, Any?>>
order_canceled_at?	String
order_created_at?	String
order_id?	String
order_number?	String
order_updated_at?	String
order_url?	String
product_categories?	Array
product_ids?	Array
product_names?	Array
product_skus?	Array
reason?	String
shipping_address?	Map<String, Any?>
total_price?	Number

orderFulfilled()

Android

val properties = EcommerceOrderFulfilledProperties(
    billingAddress = billingAddress
)
bird.tracker.ecommerce.orderFulfilled(properties)

Swift

Web

EcommerceOrderFulfilledProperties

Property	Type
billing_address?	Map<String, Any?>
currency?	String
customer_email?	String
customer_phone?	String
financial_status?	String
fulfillment_status?	String
fulfillments?	Array<Map<String, Any?>>
items?	Array<Map<String, Any?>>
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?	Array
product_ids?	Array
product_names?	Array
product_skus?	Array
shipping_address?	Map<String, Any?>
total_price?	Number

cartViewed()

Android

val properties = EcommerceCartViewedProperties(
    cartId = cartId
)
bird.tracker.ecommerce.cartViewed(properties)

Swift

Web

EcommerceCartViewedProperties

Property	Type
cart_id?	String
checkout_url?	String
currency?	String
customer_email?	String
customer_phone?	String
items?	Array<Map<String, Any?>>
product_ids?	Array
product_names?	Array
product_skus?	Array
total_price?	Number
total_quantity?	Number

cartUpdated()

Android

val properties = EcommerceCartUpdatedProperties(
    cartId = cartId
)
bird.tracker.ecommerce.cartUpdated(properties)

Swift

Web

EcommerceCartUpdatedProperties

Property	Type
cart_id?	String
checkout_url?	String
currency?	String
customer_email?	String
customer_phone?	String
items?	Array<Map<String, Any?>>
product_ids?	Array
product_names?	Array
product_skus?	Array
total_price?	Number
total_quantity?	Number

productViewed()

Android

val properties = EcommerceProductViewedProperties(
    price = price
)
bird.tracker.ecommerce.productViewed(properties)

Swift

Web

EcommerceProductViewedProperties

Property	Type
price?	Number
product_id?	Any
product_image_url?	String
product_name?	Any
product_sku?	Any
product_url?	String

collectionViewed()

Android

val properties = EcommerceCollectionViewedProperties(
    collectionId = collectionId
)
bird.tracker.ecommerce.collectionViewed(properties)

Swift

Web

EcommerceCollectionViewedProperties

Property	Type
collection_id?	Any
collection_name?	Any