Events
Order Refunded
user refunded the order suggested source server properties name type description required affiliation string store or affiliation from which this transaction occurred (for example, "google store") no campaign id integer order metadata "campaign id" no channel string channel where order was placed (for example, "chord") 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 email string email address associated with the order no first name string first name in the shipping address for the order no has subscription boolean order contains a subscription no is recurring boolean order contains a subscription no last name string last name in the shipping address for the order no metadata object metadata of the order no order date string date and time order was placed no order id string order/transaction id yes phone string phone number associated with the order no products object\[] products in the order yes purl link string url for customer to share to receive referral credit no referral identifier id string id for referral that customer used to place the order no revenue number revenue ($) associated with the transaction (excluding shipping and tax) no shipping number shipping cost associated with the transaction no shipping city string city in the shipping address for the order no shipping country string country in the shipping address for the order no shipping method details object no shipping state string state in the shipping address for the order no shipping zipcode string zipcode in the shipping address for the order no tax number total tax associated with the transaction no template id integer order metadata "template id" no total number revenue ($) with discounts and coupons added in yes tracking ids object tracking ids for third party integrations no example { "affiliation" "my plant store", "campaign id" 12345, "channel" "online", "checkout type" "shopify", "coupon" "spring", "currency" "usd", "discount" 10, "email" "customer\@example com", "first name" "john", "has subscription" false, "is recurring" false, "last name" "doe", "metadata" {}, "order date" "2024 03 25t09 20 00z", "order id" "345678912", "phone" "123 456 7890", "products" \[ { "affiliation" "my plant store", "brand" "green thumb nurseries", "bundle" false, "bundle size" 0, "category" "outdoor plants", "coupon" "spring", "cross sold quantity" 0, "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", "variant metadata" { "size" "small" } } ], "purl link" "https //example com/referral", "referral identifier id" "ref123", "revenue" 5 98, "shipping" 10, "shipping city" "springfield", "shipping country" "us", "shipping method details" { "shipping code" "standard shipping", "shipping method" "standard shipping" }, "shipping state" "il", "shipping zipcode" "62704", "tax" 5, "template id" 67890, "total" 30 98, "tracking ids" {} } metadata object metadata of the order no properties 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 yes product id string database id of the product yes quantity integer quantity of the product yes sku string sku of the product variant yes 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 bundle size integer number of skus in the bundle no cross sold quantity integer quantity sold via cross selling no variant metadata object metadata of the product variant 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" ] products\[] variant metadata object metadata of the product variant no properties shipping method details object properties name type description required shipping code string code of shipping method chosen for the order (for example, "standard shipping") shipping method string name of shipping method chosen for the order (for example, "standard shipping") tracking ids object tracking ids for third party integrations no properties