Events
Checkout Started
user initiated the order process (a transaction is created) suggested source server, website front end properties name type description required affiliation string store or affiliation from which this transaction occurred (for example, "google store") no checkout type string checkout provider (for example, "stripe") no coupon string transaction coupon redeemed with the transaction no currency string currency code of the transaction (for example, "usd") pattern ^\[a z]{3}$ no discount number total discount associated with the transaction no order id string order/transaction id no order name string order number (for example, "chord 000111222") no products object\[] products in the order yes revenue number revenue ($) associated with the transaction (excluding shipping and tax) no shipping number shipping cost associated with the transaction no tax number total tax associated with the transaction no value number revenue ($) with discounts and coupons added in no example { "affiliation" "my plant store", "checkout type" "shopify", "coupon" "spring", "currency" "usd", "discount" 10, "order id" "345678912", "order name" "plant 567891234", "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" } ], "revenue" 5 98, "shipping" 0, "tax" 0, "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") no brand string brand associated with the product no bundle boolean product belongs to a bundle no category string product category no coupon string coupon code associated with a product (for example, "may deals 3") no description string short description of the product no image url string image url of the product no name string name of the product yes option values string\[] option values of the product variant no position integer position in the product list (for example, 3) no price number price ($) of the product no product id string database id of the product yes quantity integer quantity of the product no sku string sku of the product variant no slug string slug of the product, often used in urls (for example, "product red") no url string url of the product page no variant string name of the product variant no line item id string database id of the line item no example \[ { "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 string example \[ "purple" ]