--- title: Order Cancelled slug: tracking-plan/order-cancelled docTags: createdAt: 2026-01-21T23:00:52.588Z --- User cancelled 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)
| yes | | **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** ```json { "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** ```json [ { "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** ```json [ "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.**