Shipment Shipped

order shipment has been shipped suggested source server properties name type description required email string email address associated with the order no order number string order number (for example, "chord 000111222") no shipment object shipment details no example { "email" "customer\@example com", "order number" "chord 000111222", "shipment" { "additional tax total" 2, "address" { "street" "123 main st", "city" "anytown", "state" "ca", "country" "usa", "zip" "12345" }, "adjustment total" 5, "carrier" "ups", "cost" 15, "external tracking url" "https //example com/track/your/shipment/here", "fulfilled by" "amazon fulfillment", "included tax total" 1 5, "label url" "https //example com/shipment/label/here", "number" "ship 000123456", "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", "variant metadata" { "size" "small" } } ], "promo total" 10, "pushed" true, "state" "shipped", "tracking" "1z999aa10123456784", "tracking detail" "delivered, front door/porch" } } shipment object shipment details properties name type description required additional tax total number shipment additional tax total no address object shipment address no adjustment total number adjustment total no carrier string name of carrier (for example, "ups") no cost number cost associated with shipment no external tracking url string tracking url for customer to track shipment no fulfilled by string name of fulfillment provider no included tax total number included tax total no label url string shipment label url no number string shipment number no products object\[] products in the shipment no promo total number total discount from promotions no pushed boolean shipment has been successfully fulfilled no state string shipment state (for example, "shipped") no tracking string tracking number for shipment no tracking detail string latest tracking update for shipment (for example, "delivered, front door/porch") no example { "address" { "address1" "123 elm street", "address2" "suite 456", "city" "springfield", "company" "acme corp", "country" "usa", "name" "john doe", "phone" "555 1234", "state" "il", "zipcode" "62704" }, "products" \[ { "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 } ] } shipment address object shipment address properties name type description required address1 string street address (line 1) address2 string street address (line 2) city string city company string company country string country name string name phone string phone number state string state zipcode string zipcode example { "address1" "123 elm street", "address2" "suite 456", "city" "springfield", "company" "acme corp", "country" "usa", "name" "john doe", "phone" "555 1234", "state" "il", "zipcode" "62704" } shipment products\[] array products in the shipment 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") brand string brand associated with the product bundle boolean product belongs to a bundle category string product category coupon string coupon code associated with a product (for example, "may deals 3") description string short description of the product image url string image url of the product name string name of the product option values string\[] option values of the product variant position integer position in the product list (for example, 3) price number price ($) of the product product id string database id of the product quantity integer quantity of the product sku string sku of the product variant slug string slug of the product, often used in urls (for example, "product red") url string url of the product page variant string name of the product variant line item id string database id of the line item variant metadata object metadata of the product variant 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 } ] shipment products\[] option values\[] array option values of the product variant option value (for example, "red") item type string example \[ "purple" ] shipment products\[] variant metadata object metadata of the product variant no properties