@chordcommerce/analytics
Version:
Chord Commerce event tracking
2,340 lines (2,339 loc) • 133 kB
TypeScript
/**
* Shared the cart with one or more friends
*/
export interface CartShared {
/**
* Shopping cart ID
*/
cart_id?: string;
/**
* Products displayed in the product list
*/
products?: CartSharedProduct[];
/**
* Recipient of the sharing
*/
recipient?: string;
/**
* Message that the sender sent
*/
share_message?: string;
/**
* Method of sharing
*/
share_via?: string;
[property: string]: any;
}
/**
* The product
*/
export interface CartSharedProduct {
/**
* Name of the product
*/
name: string;
/**
* Product ID displayed on the list
*/
product_id: string;
[property: string]: any;
}
/**
* User viewed their shopping cart
*/
export interface CartViewed {
/**
* Shopping cart ID
*/
cart_id?: string;
/**
* Currency code of the transaction (for example, "USD")
*/
currency?: string;
/**
* Products in the order
*/
products: CartViewedProduct[];
/**
* Revenue ($) with discounts and coupons added in
*/
value?: number;
[property: string]: any;
}
/**
* The product
*/
export interface CartViewedProduct {
/**
* Product affiliation to designate a supplying company or brick and mortar store location
* (for example, "Google Store")
*/
affiliation?: string;
/**
* Brand associated with the product
*/
brand?: string;
/**
* Product belongs to a bundle
*/
bundle?: boolean;
/**
* Product category
*/
category?: string;
/**
* Coupon code associated with a product (for example, "MAY_DEALS_3")
*/
coupon?: string;
/**
* Short description of the product
*/
description?: string;
/**
* Image URL of the product
*/
image_url?: string;
/**
* Database ID of the line item
*/
line_item_id?: string;
/**
* Name of the product
*/
name: string;
/**
* Option values of the product variant
*/
option_values?: string[];
/**
* Position in the product list (for example, 3)
*/
position?: number;
/**
* Price ($) of the product
*/
price?: number;
/**
* Database ID of the product
*/
product_id: string;
/**
* Quantity of the product
*/
quantity?: number;
/**
* SKU of the product variant
*/
sku?: string;
/**
* Slug of the product, often used in URLs (for example, "product-red")
*/
slug?: string;
/**
* URL of the product page
*/
url?: string;
/**
* Name of the product variant
*/
variant?: string;
[property: string]: any;
}
/**
* User abandoned the checkout process
*/
export interface CheckoutAbandoned {
/**
* Store or affiliation from which this transaction occurred (for example, "Google Store")
*/
affiliation?: string;
/**
* Checkout provider (for example, "stripe")
*/
checkout_type?: string;
/**
* Transaction coupon redeemed with the transaction
*/
coupon?: string;
/**
* Currency code of the transaction (for example, "USD")
*/
currency?: string;
/**
* Total discount associated with the transaction
*/
discount?: number;
/**
* URL to return to the cart if a cart recovery promotion is available
*/
discounted_order_cart_url?: string;
/**
* Email address associated with the order
*/
email?: string;
/**
* URL to return to the cart
*/
order_cart_url?: string;
/**
* Order/transaction ID
*/
order_id?: string;
/**
* Order number (for example, "CHORD-000111222")
*/
order_name?: string;
/**
* Phone number associated with the order
*/
phone?: string;
products?: CheckoutAbandonedProduct[];
/**
* Revenue ($) associated with the transaction (excluding shipping and tax)
*/
revenue?: number;
/**
* Shipping cost associated with the transaction
*/
shipping?: number;
/**
* Total tax associated with the transaction
*/
tax?: number;
/**
* Revenue ($) with discounts and coupons added in
*/
value?: number;
[property: string]: any;
}
/**
* The product
*/
export interface CheckoutAbandonedProduct {
/**
* Product affiliation to designate a supplying company or brick and mortar store location
* (for example, "Google Store")
*/
affiliation?: string;
/**
* Brand associated with the product
*/
brand?: string;
/**
* Product belongs to a bundle
*/
bundle?: boolean;
/**
* Product category
*/
category?: string;
/**
* Coupon code associated with a product (for example, "MAY_DEALS_3")
*/
coupon?: string;
/**
* Short description of the product
*/
description?: string;
/**
* Image URL of the product
*/
image_url?: string;
/**
* Database ID of the line item
*/
line_item_id?: string;
/**
* Name of the product
*/
name?: string;
/**
* Option values of the product variant
*/
option_values?: string[];
/**
* Position in the product list (for example, 3)
*/
position?: number;
/**
* Price ($) of the product
*/
price?: number;
/**
* Database ID of the product
*/
product_id?: string;
/**
* Quantity of the product
*/
quantity?: number;
/**
* SKU of the product variant
*/
sku?: string;
/**
* Slug of the product, often used in URLs (for example, "product-red")
*/
slug?: string;
/**
* URL of the product page
*/
url?: string;
/**
* Name of the product variant
*/
variant?: string;
[property: string]: any;
}
/**
* Products in the order
*/
export interface CheckoutStarted {
/**
* Store or affiliation from which this transaction occurred (for example, "Google Store")
*/
affiliation?: string;
/**
* Checkout provider (for example, "stripe")
*/
checkout_type?: string;
/**
* Transaction coupon redeemed with the transaction
*/
coupon?: string;
/**
* Currency code of the transaction (for example, "USD")
*/
currency?: string;
/**
* Total discount associated with the transaction
*/
discount?: number;
/**
* Order/transaction ID
*/
order_id?: string;
/**
* Order number (for example, "CHORD-000111222")
*/
order_name?: string;
/**
* Products in the order
*/
products: CheckoutStartedProduct[];
/**
* Revenue ($) associated with the transaction (excluding shipping and tax)
*/
revenue?: number;
/**
* Shipping cost associated with the transaction
*/
shipping?: number;
/**
* Total tax associated with the transaction
*/
tax?: number;
/**
* Revenue ($) with discounts and coupons added in
*/
value?: number;
[property: string]: any;
}
/**
* The product
*/
export interface CheckoutStartedProduct {
/**
* Product affiliation to designate a supplying company or brick and mortar store location
* (for example, "Google Store")
*/
affiliation?: string;
/**
* Brand associated with the product
*/
brand?: string;
/**
* Product belongs to a bundle
*/
bundle?: boolean;
/**
* Product category
*/
category?: string;
/**
* Coupon code associated with a product (for example, "MAY_DEALS_3")
*/
coupon?: string;
/**
* Short description of the product
*/
description?: string;
/**
* Image URL of the product
*/
image_url?: string;
/**
* Database ID of the line item
*/
line_item_id?: string;
/**
* Name of the product
*/
name: string;
/**
* Option values of the product variant
*/
option_values?: string[];
/**
* Position in the product list (for example, 3)
*/
position?: number;
/**
* Price ($) of the product
*/
price?: number;
/**
* Database ID of the product
*/
product_id: string;
/**
* Quantity of the product
*/
quantity?: number;
/**
* SKU of the product variant
*/
sku?: string;
/**
* Slug of the product, often used in URLs (for example, "product-red")
*/
slug?: string;
/**
* URL of the product page
*/
url?: string;
/**
* Name of the product variant
*/
variant?: string;
[property: string]: any;
}
/**
* User completed a checkout step
*/
export interface CheckoutStepCompleted {
/**
* Checkout transaction ID
*/
checkout_id?: string;
/**
* String representing the payment method chosen
*/
payment_method?: string;
/**
* String representing the shipping the method chosen
*/
shipping_method?: string;
/**
* Number representing a step in the checkout process
*/
step: number;
[property: string]: any;
}
/**
* User viewed a checkout step
*/
export interface CheckoutStepViewed {
/**
* Checkout transaction ID
*/
checkout_id?: string;
/**
* String representing the payment method chosen
*/
payment_method?: string;
/**
* String representing the shipping the method chosen
*/
shipping_method?: string;
/**
* Number representing a step in the checkout process
*/
step: number;
[property: string]: any;
}
/**
* User clicked on a collection
*/
export interface CollectionClicked {
/**
* Brand of the collection
*/
brand?: string;
/**
* Database ID of the collection
*/
collection_id?: string;
/**
* Short description of the collection
*/
description?: string;
/**
* Image URL of the collection
*/
image_url?: string;
/**
* Slug of the collection, often used in URLs (for example, "spring-collection")
*/
slug?: string;
/**
* Title of the collection
*/
title?: string;
/**
* URL of the collection page for the collection
*/
url?: string;
[property: string]: any;
}
/**
* Coupon was applied on a user's shopping cart or order
*/
export interface CouponApplied {
/**
* Cart ID, if applicable
*/
cart_id?: string;
/**
* Coupon ID
*/
coupon_id?: string;
/**
* Coupon name
*/
coupon_name?: string;
/**
* Monetary discount applied through the coupon
*/
discount?: number;
/**
* Order/transaction ID, if applicable
*/
order_id?: string;
[property: string]: any;
}
/**
* Coupon was denied from a user's shopping cart or order
*/
export interface CouponDenied {
/**
* Cart ID, if applicable
*/
cart_id?: string;
/**
* Coupon ID
*/
coupon_id?: string;
/**
* Coupon name
*/
coupon_name?: string;
/**
* Order/transaction ID, if applicable
*/
order_id?: string;
/**
* Reason the coupon was denied
*/
reason?: string;
[property: string]: any;
}
/**
* User entered a coupon on a shopping cart or order
*/
export interface CouponEntered {
/**
* Cart ID, if applicable
*/
cart_id?: string;
/**
* Coupon ID
*/
coupon_id?: string;
/**
* Coupon name
*/
coupon_name?: string;
/**
* Order/transaction ID, if applicable
*/
order_id?: string;
[property: string]: any;
}
/**
* User removed a coupon from a cart or order
*/
export interface CouponRemoved {
/**
* Cart ID, if applicable
*/
cart_id?: string;
/**
* Coupon ID
*/
coupon_id?: string;
/**
* Coupon name
*/
coupon_name?: string;
/**
* Monetary discount applied through the coupon
*/
discount?: number;
/**
* Order/transaction ID, if applicable
*/
order_id?: string;
[property: string]: any;
}
/**
* Email entered in a form on the website
*/
export interface EmailCaptured {
/**
* Email address added to the form
*/
email?: string;
/**
* HTML component within the UX (for example, "footer")
*/
placement_component?: string;
/**
* Page of website (or "sitewide" for whole website)
*/
placement_page?: string;
[property: string]: any;
}
/**
* Gift card was applied on a user's shopping cart or order
*/
export interface GiftCardApplied {
/**
* Database ID of the gift card
*/
gift_card_id?: string;
/**
* Last characters of the gift card
*/
gift_card_last_characters?: string;
[property: string]: any;
}
/**
* Gift card was denied from a user's shopping cart or order
*/
export interface GiftCardDenied {
/**
* Database ID of the gift card
*/
gift_card_last_characters?: string;
/**
* Reason the gift card was denied
*/
reason?: string;
[property: string]: any;
}
/**
* User entered a gift card on a cart or order
*/
export interface GiftCardEntered {
/**
* Database ID of the gift card
*/
gift_card_last_characters?: string;
[property: string]: any;
}
/**
* User removed a gift card from a cart or order
*/
export interface GiftCardRemoved {
/**
* Database ID of the gift card
*/
gift_card_id?: string;
/**
* Last characters of the gift card
*/
gift_card_last_characters?: string;
[property: string]: any;
}
/**
* Notify waitlist that product variant is back in stock
*/
export interface ItemRestocked {
/**
* Product affiliation to designate a supplying company or brick and mortar store location
* (for example, "Google Store")
*/
affiliation?: string;
/**
* Whether the variant can be backordered
*/
backorderable?: boolean;
/**
* Brand associated with the product
*/
brand?: string;
/**
* Product belongs to a bundle
*/
bundle?: boolean;
/**
* Product category
*/
category?: string;
/**
* Coupon code associated with a product (for example, "MAY_DEALS_3")
*/
coupon?: string;
/**
* Currency code of the transaction (for example, "USD")
*/
currency?: string;
/**
* Short description of the product
*/
description?: string;
/**
* Email address to notify when the product is back in stock
*/
email?: string;
/**
* Image URL of the product
*/
image_url?: string;
/**
* Name of the product
*/
name?: string;
/**
* Option values of the product variant
*/
option_values?: string[];
/**
* Position in the product list (for example, 3)
*/
position?: number;
/**
* Price ($) of the product
*/
price?: number;
/**
* Database ID of the product
*/
product_id?: string;
/**
* Quantity of the product
*/
quantity?: number;
/**
* SKU of the product variant
*/
sku?: string;
/**
* Slug of the product, often used in URLs (for example, "product-red")
*/
slug?: string;
/**
* ID of waitlist signup
*/
stock_request_id?: string;
/**
* Quantity of the variant currently available (for example, 5000)
*/
total_on_hand?: number;
/**
* URL of the product page
*/
url?: string;
/**
* Name of the product variant
*/
variant?: string;
/**
* Database ID of the product variant
*/
variant_id?: string;
[property: string]: any;
}
/**
* User submits the login form
*/
export interface LoginStarted {
/**
* The email of the user
*/
email?: string;
[property: string]: any;
}
/**
* User clicked on a navigation link
*/
export interface NavigationClicked {
/**
* Name of menu or category where navigation link was clicked (for example, "Support")
*/
category?: string;
/**
* Navigation label clicked (for example, "Contact")
*/
label?: string;
/**
* Navigation HTML component within the UX (for example, "footer")
*/
navigation_placement?: string;
/**
* Navigation label clicked (for example, "Contact")
*/
navigation_title?: string;
/**
* URL of navigation link destination
*/
navigation_url?: string;
[property: string]: any;
}
/**
* User cancelled the order
*/
export interface OrderCancelled {
/**
* Store or affiliation from which this transaction occurred (for example, "Google Store")
*/
affiliation?: string;
/**
* Order metadata "campaign_id"
*/
campaign_id?: number;
/**
* Channel where order was placed (for example, "chord")
*/
channel?: string;
/**
* Checkout provider (for example, "stripe")
*/
checkout_type?: string;
/**
* Transaction coupon redeemed with the transaction
*/
coupon?: string;
/**
* Currency code of the transaction (for example, "USD")
*/
currency?: string;
/**
* Total discount associated with the transaction
*/
discount?: number;
/**
* Email address associated with the order
*/
email?: string;
/**
* First name in the shipping address for the order
*/
first_name?: string;
/**
* Order contains a subscription
*/
has_subscription?: boolean;
/**
* Order contains a subscription
*/
is_recurring?: boolean;
/**
* Last name in the shipping address for the order
*/
last_name?: string;
/**
* Metadata of the order
*/
metadata?: {
[key: string]: any;
};
/**
* Date and time order was placed
*/
order_date?: string;
/**
* Order/transaction ID
*/
order_id: string;
/**
* Phone number associated with the order
*/
phone?: string;
/**
* Products in the order
*/
products: OrderCancelledProduct[];
/**
* URL for customer to share to receive referral credit
*/
purl_link?: string;
/**
* ID for referral that customer used to place the order
*/
referral_identifier_id?: string;
/**
* Revenue ($) associated with the transaction (excluding shipping and tax)
*/
revenue: number;
/**
* Shipping cost associated with the transaction
*/
shipping?: number;
/**
* City in the shipping address for the order
*/
shipping_city?: string;
/**
* Country in the shipping address for the order
*/
shipping_country?: string;
shipping_method_details?: OrderCancelledShippingMethodDetails;
/**
* State in the shipping address for the order
*/
shipping_state?: string;
/**
* Zipcode in the shipping address for the order
*/
shipping_zipcode?: string;
/**
* Total tax associated with the transaction
*/
tax?: number;
/**
* Order metadata "template_id"
*/
template_id?: number;
/**
* Revenue ($) with discounts and coupons added in.
*/
total: number;
/**
* Tracking IDs for third party integrations
*/
tracking_ids?: {
[key: string]: any;
};
[property: string]: any;
}
/**
* The product
*/
export interface OrderCancelledProduct {
/**
* Product affiliation to designate a supplying company or brick and mortar store location
* (for example, "Google Store")
*/
affiliation?: string;
/**
* Brand associated with the product
*/
brand?: string;
/**
* Product belongs to a bundle
*/
bundle?: boolean;
/**
* Number of SKUs in the bundle
*/
bundle_size?: number;
/**
* Product category
*/
category?: string;
/**
* Coupon code associated with a product (for example, "MAY_DEALS_3")
*/
coupon?: string;
/**
* Quantity sold via cross-selling
*/
cross_sold_quantity?: number;
/**
* Short description of the product
*/
description?: string;
/**
* Image URL of the product
*/
image_url?: string;
/**
* Database ID of the line item
*/
line_item_id?: string;
/**
* Name of the product
*/
name: string;
/**
* Option values of the product variant
*/
option_values?: string[];
/**
* Position in the product list (for example, 3)
*/
position?: number;
/**
* Price ($) of the product
*/
price: number;
/**
* Database ID of the product
*/
product_id: string;
/**
* Quantity of the product
*/
quantity: number;
/**
* SKU of the product variant
*/
sku: string;
/**
* Slug of the product, often used in URLs (for example, "product-red")
*/
slug?: string;
/**
* URL of the product page
*/
url?: string;
/**
* Name of the product variant
*/
variant?: string;
/**
* Metadata of the product variant
*/
variant_metadata?: {
[key: string]: any;
};
[property: string]: any;
}
export interface OrderCancelledShippingMethodDetails {
/**
* Code of shipping method chosen for the order (for example, "standard_shipping")
*/
shipping_code?: string;
/**
* Name of shipping method chosen for the order (for example, "Standard Shipping")
*/
shipping_method?: string;
[property: string]: any;
}
/**
* User completed the order
*/
export interface OrderCompleted {
/**
* Store or affiliation from which this transaction occurred (for example, "Google Store")
*/
affiliation?: string;
/**
* Order metadata "campaign_id"
*/
campaign_id?: number;
/**
* Order category
*/
category?: string;
/**
* Channel where order was placed (for example, "chord")
*/
channel?: string;
/**
* Checkout ID
*/
checkout_id?: string;
/**
* Checkout provider (for example, "stripe")
*/
checkout_type?: string;
/**
* Transaction coupon redeemed with the transaction
*/
coupon?: string;
/**
* Currency code of the transaction (for example, "USD")
*/
currency: string;
/**
* Total discount associated with the transaction
*/
discount?: number;
/**
* Email address associated with the order
*/
email?: string;
/**
* First name in the shipping address for the order
*/
first_name?: string;
/**
* Order contains a subscription
*/
has_subscription?: boolean;
/**
* Order contains a subscription
*/
is_recurring?: boolean;
/**
* Last name in the shipping address for the order
*/
last_name?: string;
/**
* Metadata of the order
*/
metadata?: {
[key: string]: any;
};
/**
* Date and time order was placed
*/
order_date: string;
/**
* Order/transaction ID
*/
order_id: string;
/**
* Phone number associated with the order
*/
phone?: string;
/**
* Products in the order
*/
products: OrderCompletedProduct[];
/**
* URL for customer to share to receive referral credit
*/
purl_link?: string;
/**
* ID for referral that customer used to place the order
*/
referral_identifier_id?: string;
/**
* Indicates whether the customer is new or returning
*/
repeat?: boolean;
/**
* Revenue ($) associated with the transaction (excluding shipping and tax)
*/
revenue: number;
/**
* Shipping cost associated with the transaction
*/
shipping?: number;
/**
* City in the shipping address for the order
*/
shipping_city?: string;
/**
* Country in the shipping address for the order
*/
shipping_country?: string;
shipping_method_details?: OrderCompletedShippingMethodDetails;
/**
* State in the shipping address for the order
*/
shipping_state?: string;
/**
* Zipcode in the shipping address for the order
*/
shipping_zipcode?: string;
/**
* Order total after discounts but before taxes and shipping
*/
subtotal?: number;
/**
* Total tax associated with the transaction
*/
tax?: number;
/**
* Order metadata "template_id"
*/
template_id?: number;
/**
* Revenue ($) with discounts and coupons added in.
*/
total: number;
/**
* Tracking IDs for third party integrations
*/
tracking_ids?: {
[key: string]: any;
};
[property: string]: any;
}
/**
* The product
*/
export interface OrderCompletedProduct {
/**
* Product affiliation to designate a supplying company or brick and mortar store location
* (for example, "Google Store")
*/
affiliation?: string;
/**
* Brand associated with the product
*/
brand?: string;
/**
* Product belongs to a bundle
*/
bundle?: boolean;
/**
* Number of SKUs in the bundle
*/
bundle_size?: number;
/**
* Product category
*/
category?: string;
/**
* Coupon code associated with a product (for example, "MAY_DEALS_3")
*/
coupon?: string;
/**
* Quantity sold via cross-selling
*/
cross_sold_quantity?: number;
/**
* Short description of the product
*/
description?: string;
/**
* Image URL of the product
*/
image_url?: string;
/**
* Database ID of the line item
*/
line_item_id?: string;
/**
* Name of the product
*/
name: string;
/**
* Option values of the product variant
*/
option_values?: string[];
/**
* Position in the product list (for example, 3)
*/
position?: number;
/**
* Price ($) of the product
*/
price: number;
/**
* Database ID of the product
*/
product_id: string;
/**
* Quantity of the product
*/
quantity: number;
/**
* Revenue ($) with discounts and coupons added in.
*/
revenue: number;
/**
* SKU of the product variant
*/
sku: string;
/**
* Slug of the product, often used in URLs (for example, "product-red")
*/
slug?: string;
/**
* URL of the product page
*/
url?: string;
/**
* Name of the product variant
*/
variant?: string;
/**
* Metadata of the product variant
*/
variant_metadata?: {
[key: string]: any;
};
[property: string]: any;
}
export interface OrderCompletedShippingMethodDetails {
/**
* Code of shipping method chosen for the order (for example, "standard_shipping")
*/
shipping_code?: string;
/**
* Name of shipping method chosen for the order (for example, "Standard Shipping")
*/
shipping_method?: string;
[property: string]: any;
}
/**
* User refunded the order
*/
export interface OrderRefunded {
/**
* Store or affiliation from which this transaction occurred (for example, "Google Store")
*/
affiliation?: string;
/**
* Order metadata "campaign_id"
*/
campaign_id?: number;
/**
* Channel where order was placed (for example, "chord")
*/
channel?: string;
/**
* Checkout provider (for example, "stripe")
*/
checkout_type?: string;
/**
* Transaction coupon redeemed with the transaction
*/
coupon?: string;
/**
* Currency code of the transaction (for example, "USD")
*/
currency?: string;
/**
* Total discount associated with the transaction
*/
discount?: number;
/**
* Email address associated with the order
*/
email?: string;
/**
* First name in the shipping address for the order
*/
first_name?: string;
/**
* Order contains a subscription
*/
has_subscription?: boolean;
/**
* Order contains a subscription
*/
is_recurring?: boolean;
/**
* Last name in the shipping address for the order
*/
last_name?: string;
/**
* Metadata of the order
*/
metadata?: {
[key: string]: any;
};
/**
* Date and time order was placed
*/
order_date?: string;
/**
* Order/transaction ID
*/
order_id: string;
/**
* Phone number associated with the order
*/
phone?: string;
/**
* Products in the order
*/
products: OrderRefundedProduct[];
/**
* URL for customer to share to receive referral credit
*/
purl_link?: string;
/**
* ID for referral that customer used to place the order
*/
referral_identifier_id?: string;
/**
* Revenue ($) associated with the transaction (excluding shipping and tax)
*/
revenue?: number;
/**
* Shipping cost associated with the transaction
*/
shipping?: number;
/**
* City in the shipping address for the order
*/
shipping_city?: string;
/**
* Country in the shipping address for the order
*/
shipping_country?: string;
shipping_method_details?: OrderRefundedShippingMethodDetails;
/**
* State in the shipping address for the order
*/
shipping_state?: string;
/**
* Zipcode in the shipping address for the order
*/
shipping_zipcode?: string;
/**
* Total tax associated with the transaction
*/
tax?: number;
/**
* Order metadata "template_id"
*/
template_id?: number;
/**
* Revenue ($) with discounts and coupons added in.
*/
total: number;
/**
* Tracking IDs for third party integrations
*/
tracking_ids?: {
[key: string]: any;
};
[property: string]: any;
}
/**
* The product
*/
export interface OrderRefundedProduct {
/**
* Product affiliation to designate a supplying company or brick and mortar store location
* (for example, "Google Store")
*/
affiliation?: string;
/**
* Brand associated with the product
*/
brand?: string;
/**
* Product belongs to a bundle
*/
bundle?: boolean;
/**
* Number of SKUs in the bundle
*/
bundle_size?: number;
/**
* Product category
*/
category?: string;
/**
* Coupon code associated with a product (for example, "MAY_DEALS_3")
*/
coupon?: string;
/**
* Quantity sold via cross-selling
*/
cross_sold_quantity?: number;
/**
* Short description of the product
*/
description?: string;
/**
* Image URL of the product
*/
image_url?: string;
/**
* Database ID of the line item
*/
line_item_id?: string;
/**
* Name of the product
*/
name: string;
/**
* Option values of the product variant
*/
option_values?: string[];
/**
* Position in the product list (for example, 3)
*/
position?: number;
/**
* Price ($) of the product
*/
price: number;
/**
* Database ID of the product
*/
product_id: string;
/**
* Quantity of the product
*/
quantity: number;
/**
* SKU of the product variant
*/
sku: string;
/**
* Slug of the product, often used in URLs (for example, "product-red")
*/
slug?: string;
/**
* URL of the product page
*/
url?: string;
/**
* Name of the product variant
*/
variant?: string;
/**
* Metadata of the product variant
*/
variant_metadata?: {
[key: string]: any;
};
[property: string]: any;
}
export interface OrderRefundedShippingMethodDetails {
/**
* Code of shipping method chosen for the order (for example, "standard_shipping")
*/
shipping_code?: string;
/**
* Name of shipping method chosen for the order (for example, "Standard Shipping")
*/
shipping_method?: string;
[property: string]: any;
}
/**
* User updated the order
*/
export interface OrderUpdated {
/**
* Store or affiliation from which this transaction occurred (for example, "Google Store")
*/
affiliation?: string;
/**
* Order metadata "campaign_id"
*/
campaign_id?: number;
/**
* Channel where order was placed (for example, "chord")
*/
channel?: string;
/**
* Checkout provider (for example, "stripe")
*/
checkout_type?: string;
/**
* Transaction coupon redeemed with the transaction
*/
coupon?: string;
/**
* Currency code of the transaction (for example, "USD")
*/
currency?: string;
/**
* Total discount associated with the transaction
*/
discount?: number;
/**
* Email address associated with the order
*/
email?: string;
/**
* First name in the shipping address for the order
*/
first_name?: string;
/**
* Order contains a subscription
*/
has_subscription?: boolean;
/**
* Order contains a subscription
*/
is_recurring?: boolean;
/**
* Last name in the shipping address for the order
*/
last_name?: string;
/**
* Metadata of the order
*/
metadata?: {
[key: string]: any;
};
/**
* Date and time order was placed
*/
order_date?: string;
/**
* Order/transaction ID
*/
order_id: string;
/**
* Phone number associated with the order
*/
phone?: string;
/**
* Products in the order
*/
products: OrderUpdatedProduct[];
/**
* URL for customer to share to receive referral credit
*/
purl_link?: string;
/**
* ID for referral that customer used to place the order
*/
referral_identifier_id?: string;
/**
* Revenue ($) associated with the transaction (excluding shipping and tax)
*/
revenue?: number;
/**
* Shipping cost associated with the transaction
*/
shipping?: number;
/**
* City in the shipping address for the order
*/
shipping_city?: string;
/**
* Country in the shipping address for the order
*/
shipping_country?: string;
shipping_method_details?: OrderUpdatedShippingMethodDetails;
/**
* State in the shipping address for the order
*/
shipping_state?: string;
/**
* Zipcode in the shipping address for the order
*/
shipping_zipcode?: string;
/**
* Total tax associated with the transaction
*/
tax?: number;
/**
* Order metadata "template_id"
*/
template_id?: number;
/**
* Revenue ($) with discounts and coupons added in.
*/
total: number;
/**
* Tracking IDs for third party integrations
*/
tracking_ids?: {
[key: string]: any;
};
[property: string]: any;
}
/**
* The product
*/
export interface OrderUpdatedProduct {
/**
* Product affiliation to designate a supplying company or brick and mortar store location
* (for example, "Google Store")
*/
affiliation?: string;
/**
* Brand associated with the product
*/
brand?: string;
/**
* Product belongs to a bundle
*/
bundle?: boolean;
/**
* Number of SKUs in the bundle
*/
bundle_size?: number;
/**
* Product category
*/
category?: string;
/**
* Coupon code associated with a product (for example, "MAY_DEALS_3")
*/
coupon?: string;
/**
* Quantity sold via cross-selling
*/
cross_sold_quantity?: number;
/**
* Short description of the product
*/
description?: string;
/**
* Image URL of the product
*/
image_url?: string;
/**
* Database ID of the line item
*/
line_item_id?: string;
/**
* Name of the product
*/
name: string;
/**
* Option values of the product variant
*/
option_values?: string[];
/**
* Position in the product list (for example, 3)
*/
position?: number;
/**
* Price ($) of the product
*/
price: number;
/**
* Database ID of the product
*/
product_id: string;
/**
* Quantity of the product
*/
quantity: number;
/**
* SKU of the product variant
*/
sku: string;
/**
* Slug of the product, often used in URLs (for example, "product-red")
*/
slug?: string;
/**
* URL of the product page
*/
url?: string;
/**
* Name of the product variant
*/
variant?: string;
/**
* Metadata of the product variant
*/
variant_metadata?: {
[key: string]: any;
};
[property: string]: any;
}
export interface OrderUpdatedShippingMethodDetails {
/**
* Code of shipping method chosen for the order (for example, "standard_shipping")
*/
shipping_code?: string;
/**
* Name of shipping method chosen for the order (for example, "Standard Shipping")
*/
shipping_method?: string;
[property: string]: any;
}
/**
* User completed the password reset process
*/
export interface PasswordResetCompleted {
/**
* Email address of the user
*/
email?: string;
/**
* ID of the user
*/
user_id?: string;
[property: string]: any;
}
/**
* User initiated the password reset process
*/
export interface PasswordResetStarted {
/**
* Email address of the user
*/
email?: string;
[property: string]: any;
}
/**
* User added payment information
*/
export interface PaymentInfoEntered {
/**
* Checkout transaction ID
*/
checkout_id?: string;
/**
* Transaction coupon redeemed with the transaction
*/
coupon?: string;
/**
* Currency code of the transaction (for example, "USD")
*/
currency?: string;
/**
* Order ID
*/
order_id?: string;
/**
* String representing the payment method chosen
*/
payment_method?: string;
/**
* Products in the order
*/
products: PaymentInfoEnteredProduct[];
/**
* String representing the shipping the method chosen
*/
shipping_method?: string;
/**
* Number representing a step in the checkout process
*/
step: number;
/**
* Revenue ($) with discounts and coupons added in
*/
value?: number;
[property: string]: any;
}
/**
* The product
*/
export interface PaymentInfoEnteredProduct {
/**
* Product affiliation to designate a supplying company or brick and mortar store location
* (for example, "Google Store")
*/
affiliation?: string;
/**
* Brand associated with the product
*/
brand?: string;
/**
* Product belongs to a bundle
*/
bundle?: boolean;
/**
* Product category
*/
category?: string;
/**
* Coupon code associated with a product (for example, "MAY_DEALS_3")
*/
coupon?: string;
/**
* Short description of the product
*/
description?: string;
/**
* Image URL of the product
*/
image_url?: string;
/**
* Database ID of the line item
*/
line_item_id?: string;
/**
* Name of the product
*/
name?: string;
/**
* Option values of the product variant
*/
option_values?: string[];
/**
* Position in the product list (for example, 3)
*/
position?: number;
/**
* Price ($) of the product
*/
price?: number;
/**
* Database ID of the product
*/
product_id?: string;
/**
* Quantity of the product
*/
quantity?: number;
/**
* SKU of the product variant
*/
sku?: string;
/**
* Slug of the product, often used in URLs (for example, "product-red")
*/
slug?: string;
/**
* URL of the product page
*/
url?: string;
/**
* Name of the product variant
*/
variant?: string;
[property: string]: any;
}
/**
* The product
*/
export interface ProductAdded {
/**
* Next date when this subscription will be actionable (renewed, expired, etc.)
*/
actionable_date?: string;
/**
* Product affiliation to designate a supplying company or brick and mortar store location
* (for example, "Google Store")
*/
affiliation?: string;
/**
* Brand associated with the product
*/
brand?: string;
/**
* Product belongs to a bundle
*/
bundle?: boolean;
/**
* ID of the current cart
*/
cart_id?: string;
/**
* Product category
*/
category?: string;
/**
* Coupon code associated with a product (for example, "MAY_DEALS_3")
*/
coupon?: string;
/**
* Currency code of the transaction (for example, "USD")
*/
currency?: string;
/**
* Short description of the product
*/
description?: string;
/**
* Subscription will stop auto-renewing after this date
*/
end_date?: string;
/**
* Image URL of the product
*/
image_url?: string;
/**
* Number of installments for the prepaid subscription
*/
installment_count?: number;
/**
* Interval number at which the subscription renews
*/
interval_length?: number;
/**
* Interval unit at which the subscription renews (for example, "month")
*/
interval_units?: string;
/**
* Database ID of the line item
*/
line_item_id?: string;
/**
* Name of the product
*/
name: string;
/**
* Option values of the product variant
*/
option_values?: string[];
/**
* Position in the product list (for example, 3)
*/
position?: number;
/**
* Whether the subscription is prepaid
*/
prepaid?: boolean;
/**
* Price ($) of the product
*/
price: number;
/**
* Database ID of the product
*/
product_id: string;
/**
* Products in the shopping cart
*/
products: ProductAddedProduct[];
/**
* Quantity of the product
*/
quantity?: number;
/**
* SKU of the product variant
*/
sku: string;
/**
* Slug of the product, often used in URLs (for example, "product-red")
*/
slug?: string;
/**
* Revenue ($) with discounts and coupons added in.
*/
total: number;
/**
* URL of the product page
*/
url?: string;
/**
* Total value of the product after quantity
*/
value: number;
/**
* Name of the product variant
*/
variant?: string;
[property: string]: any;
}
/**
* The product
*/
export interface ProductAddedProduct {
/**
* Product affiliation to designate a supplying company or brick and mortar store location
* (for example, "Google Store")
*/
affiliation?: string;
/**
* Brand associated with the product
*/
brand?: string;
/**
* Product belongs to a bundle
*/
bundle?: boolean;
/**
* Product category
*/
category?: string;
/**
* Coupon code associated with a product (for example, "MAY_DEALS_3")
*/
coupon?: string;
/**
* Short description of the product
*/
description?: string;
/**
* Image URL of the product
*/
image_url?: string;
/**
* Database ID of the line item
*/
line_item_id?: string;
/**
* Name of the product
*/
name: string;
/**
* Option values of the product variant
*/
option_values?: string[];
/**
* Position in the product list (for example, 3)
*/
position?: number;
/**
* Price ($) of the product
*/
price: number;
/**
* Database ID of the product
*/
product_id: string;
/**
* Quantity of the product
*/
quantity: number;
/**
* SKU of the product variant
*/
sku?: string;
/**
* Slug of the product, often used in URLs (for example, "product-red")
*/
slug?: string;
/**
* URL of the product page
*/
url?: string;
/**
* Name of the product variant
*/
variant?: string;
[property: string]: any;
}
/**
* User added a product to the wish list
*/
export interface ProductAddedToWishlist {
/**
* Product affiliation to designate a supplying company or brick and mortar store location
* (for example, "Google Store")
*/
affiliation?: string;
/**
* Brand associated with the product
*/
brand?: string;
/**
* Product belongs to a bundle
*/
bundle?: boolean;
/**
* Product category
*/
category?: string;
/**
* Coupon code associated with a product (for example, "MAY_DEALS_3")
*/
coupon?: string;
/**
* Currency code of the transaction (for example, "USD")
*/
currency?: string;
/**
* Short description of the product
*/
description?: string;
/**
* Image URL of the product
*/
image_url?: string;
/**
* Name of the product
*/
name: string;
/**
* Option values of the product variant
*/
option_values?: string[];
/**
* Position in the product list (for example, 3)
*/
position?: number;
/**
* Price ($) of the product
*/
price?: number;
/**
* Database ID of the product
*/
product_id: string;
/**
* Quantity of the product
*/
quantity?: number;
/**
* SKU of the product variant
*/
sku?: string;
/**
* Slug of the product, often used in URLs (for example, "product-red")
*/
slug?: string;
/**
* URL of the product page
*/
url?: string;
/**
* Revenue ($) with discounts and coupons added in
*/
value?: number;
/**
* Name of the product variant
*/
variant?: string;
/**
* Wishlist ID to which the product was added to
*/
wishlist_id?: string;
/**
* Wishlist name to which the product was added to
*/
wishlist_name?: string;
[property: string]: any;
}
/**
* The product
*/
export interface ProductClicked {
/**
* Product affiliation to designate a supplying company or brick and mortar store location
* (for example, "Google Store")
*/
affiliation?: string;
/**
* Brand associated with the product
*/
brand?: string;
/**
* Product belongs to a bundle
*/
bundle?: boolean;
/**
* Shopping cart ID
*/
cart_id?: string;
/**
* Product category
*/
category?: string;
/**
* Coupon code associated with a product (for example, "MAY_DEALS_3")
*/
coupon?: string;
/**
* Currency code of the transaction (for example, "USD")
*/
currency?: string;
/**
* Short description of the product
*/
description?: string;
/**
* Image URL of the product
*/
image_url?: string;
/**
* The ID of the list in which the item was presented to the user
*/
item_list_id?: string;
/**
* The name of the list in which the item was presented to the user
*/
item_list_name?: string;
/**
* Database ID of the line item
*/
line_item_id?: string;
/**
* Name of the product
*/
name: string;
/**
* Option values of the product variant
*/
option_values?: string[];
/**
* Position in the product list (for example, 3)
*/
position?: number;
/**
* Price ($) of the product
*/
price?: number;
/**
* Database ID of the product
*/
product_id: string;
/**
* An array including only the product clicked
*/
products?: ProductClickedProduct[];
/**
* Quantity of the product
*/
quantity?: number;
/**
* SKU of the product variant
*/
sku?: string;
/**
* Slug of the product, often used in URLs (for example, "product-red")
*/
slug?: string;
/**
* URL of the product page
*/
url?: string;
/**
* Name of the product variant
*/
variant?: string;
[property: string]: any;
}
/**
* The product
*/
export interface ProductClickedProduct {
/**
* Product affiliation to designate a supplying company or brick and mortar store location
* (for example, "Google Store")
*/
affiliation?: string;
/**
* Brand associated with the product
*/
brand?: string;
/**
* Product belongs to a bundle
*/
bundle?: boolean;
/**
* Product category
*/
category?: string;
/**
* Coupon code associated with a product (for example, "MAY_DEALS_3")
*/
coupon?: string;
/**
* Short description of the product
*/
description?: string;
/**
* Image URL of the product
*/
image_url?: string;
/**
* Database ID of the line item
*/
line_item_id?: string;
/**
* Name of the product
*/
name: string;
/**
* Option values of the product variant
*/
option_values?: string[];
/**
* Position in the product list (for example, 3)
*/
position?: number;
/**
* Price ($) of the product
*/
price?: number;
/**
* Database ID of the product