Order Email Template
Order email triggers when a customer or store admin creates an order.
Object properties
| Property | Type | Description |
|---|---|---|
order | object | |
order.id | integer | |
order.customer_message | string | |
order.customer_id | integer | |
order.date_placed | object | |
order.date_placed.formatted | string | |
order.date_placed.value | integer | |
order.account_order_status_url | string | |
order.pickup_methods | array | List of pickup method names for the order |
order.shipping | object | |
order.shipping.methods | array | |
order.shipping.address | object | |
order.shipping.address.email | string | |
order.shipping.address.phone | string | |
order.shipping.address.first_name | string | |
order.shipping.address.last_name | string | |
order.shipping.address.company | string | |
order.shipping.address.country | string | |
order.shipping.address.city | string | |
order.shipping.address.state | string | |
order.shipping.address.zip | string | |
order.shipping.address.address_lines | array | |
order.shipping.address.custom_fields | array | |
order.shipping.address.custom_fields[].label | string | |
order.shipping.address.custom_fields[].value | string | |
order.products | array | |
order.products[].name | string | |
order.products[].quantity | integer | |
order.products[].sku | string | |
order.products[].address_lines | array | |
order.products[].address_custom_fields | array | Contains the label and value for custom form fields on the address. |
order.products[].address_custom_fields[].label | string | |
order.products[].address_custom_fields[].value | string | |
order.products[].address_id | integer | |
order.products[].options | object | |
order.products[].options.Size | string | |
order.products[].download_url | string | |
order.products[].thumbnail | string | |
order.products[].brand | string | |
order.products[].type | string | Product type |
order.products[].event | object | |
order.products[].event.name | string | |
order.products[].event.date | object | |
order.products[].event.date.value | integer | |
order.products[].event.date.formatted | string | |
order.products[].price | object | |
order.products[].price.value | float | |
order.products[].price.formatted | string | |
order.products[].total | object | |
order.products[].total.value | float | |
order.products[].total.formatted | string | |
order.products[].preorder | object | |
order.products[].preorder.is_preorder | boolean | |
order.products[].preorder.message | string | |
order.products[].preorder.date | object | |
order.products[].preorder.date.value | integer | |
order.products[].preorder.date.formatted | string | |
order.products[].attribute_lines | array | A list of strings that represents product variant options. |
order.products[].configurable_fields | array | Object array with properties name and value. |
order.products[].configurable_fields[].name | string | |
order.products[].configurable_fields[].value | string | |
order.products[].pickup | object | Pickup information for the product |
order.products[].pickup.id | string | |
order.products[].pickup.email | string | |
order.products[].pickup.phone | string | |
order.products[].pickup.instructions | string | |
order.products[].pickup.name | string | |
order.products[].pickup.location | object | |
order.products[].pickup.location.id | string | |
order.products[].pickup.location.name | string | |
order.products[].pickup.location.address | string | |
order.products[].pickup.location.city | string | |
order.products[].pickup.location.state | string | |
order.products[].pickup.location.zip | string | |
order.products[].pickup.location.country | string | |
order.products[].pickup.operating_hours | object | |
order.products[].pickup.operating_hours.sunday | object | |
order.products[].pickup.operating_hours.sunday.is_open | boolean | |
order.products[].pickup.operating_hours.sunday.opening_time | object | |
order.products[].pickup.operating_hours.sunday.opening_time.formatted | string | |
order.products[].pickup.operating_hours.sunday.closing_time | object | |
order.products[].pickup.operating_hours.sunday.closing_time.formatted | string | |
order.products[].pickup.operating_hours.monday | object | |
order.products[].pickup.operating_hours.monday.is_open | boolean | |
order.products[].pickup.operating_hours.monday.opening_time | object | |
order.products[].pickup.operating_hours.monday.opening_time.formatted | string | |
order.products[].pickup.operating_hours.monday.closing_time | object | |
order.products[].pickup.operating_hours.monday.closing_time.formatted | string | |
order.products[].pickup.operating_hours.tuesday | object | |
order.products[].pickup.operating_hours.tuesday.is_open | boolean | |
order.products[].pickup.operating_hours.tuesday.opening_time | object | |
order.products[].pickup.operating_hours.tuesday.opening_time.formatted | string | |
order.products[].pickup.operating_hours.tuesday.closing_time | object | |
order.products[].pickup.operating_hours.tuesday.closing_time.formatted | string | |
order.products[].pickup.operating_hours.wednesday | object | |
order.products[].pickup.operating_hours.wednesday.is_open | boolean | |
order.products[].pickup.operating_hours.wednesday.opening_time | object | |
order.products[].pickup.operating_hours.wednesday.opening_time.formatted | string | |
order.products[].pickup.operating_hours.wednesday.closing_time | object | |
order.products[].pickup.operating_hours.wednesday.closing_time.formatted | string | |
order.products[].pickup.operating_hours.thursday | object | |
order.products[].pickup.operating_hours.thursday.is_open | boolean | |
order.products[].pickup.operating_hours.thursday.opening_time | object | |
order.products[].pickup.operating_hours.thursday.opening_time.formatted | string | |
order.products[].pickup.operating_hours.thursday.closing_time | object | |
order.products[].pickup.operating_hours.thursday.closing_time.formatted | string | |
order.products[].pickup.operating_hours.friday | object | |
order.products[].pickup.operating_hours.friday.is_open | boolean | |
order.products[].pickup.operating_hours.friday.opening_time | object | |
order.products[].pickup.operating_hours.friday.opening_time.formatted | string | |
order.products[].pickup.operating_hours.friday.closing_time | object | |
order.products[].pickup.operating_hours.friday.closing_time.formatted | string | |
order.products[].pickup.operating_hours.saturday | object | |
order.products[].pickup.operating_hours.saturday.is_open | boolean | |
order.products[].pickup.operating_hours.saturday.opening_time | object | |
order.products[].pickup.operating_hours.saturday.opening_time.formatted | string | |
order.products[].pickup.operating_hours.saturday.closing_time | object | |
order.products[].pickup.operating_hours.saturday.closing_time.formatted | string | |
order.payment | object | |
order.payment.is_test | boolean | |
order.payment.provider_name | string | |
order.payment.offline_payment_message | string | |
order.payment.gateway_amount | object | Price value. Provided only if the payment method is offline. |
order.payment.gateway_amount.formatted | string | |
order.payment.gateway_amount.value | float | |
order.payment.payment_method | string | Payment method name |
order.payment.provider | object | |
order.payment.provider.name | string | Payment provider name |
order.billing | object | |
order.billing.is_managed_by_amazon | boolean | |
order.billing.address | object | |
order.billing.address.email | string | |
order.billing.address.phone | string | |
order.billing.address.first_name | string | |
order.billing.address.last_name | string | |
order.billing.address.company | string | |
order.billing.address.country | string | |
order.billing.address.city | string | |
order.billing.address.state | string | |
order.billing.address.zip | string | |
order.billing.address.address_lines | array | |
order.billing.address.custom_fields | array | |
order.billing.address.custom_fields[].label | string | |
order.billing.address.custom_fields[].value | string | |
order.total_rows | array | |
order.total_rows[].label | string | |
order.total_rows[].price | object | |
order.total_rows[].price.value | float | |
order.total_rows[].price.formatted | string | |
order.total_rows[].shipping_discounts | array | |
order.total_cost | object | |
order.total_cost.formatted | string | |
order.total_cost.value | float | |
order.meta | object | |
order.meta.mandate_url | string | Link to the confirmation page in Stripe |
order.meta.mandate_tag | string | Short name of the payment document |
order.meta.mandate_id | string | Unique identifier for the payment mandate |
order.meta.shipping_addresses_num | integer | |
order.meta.show_immediate_download | boolean | |
store | object | |
store.name | string | |
store.domain_name | string | |
store.logo | object | |
store.logo.title | string | |
store.logo.name | string | |
store.logo.url | string | |
store.ssl_path | string | |
store.cdn_path | string | |
store.image_directory | string | |
store.img_path | string | |
store.path_normal | string | Path to the store (i.e., domain + protocol) |
store.path | string | |
store.address | string | |
store.language | object | |
store.language.code | string | |
store.language.direction | string | Left to right or right to left, depending on the language |
customer | object | |
customer.first_name | string | |
customer.full_name | string | |
customer.email | string | |
customer.group | array | |
customer.group[].name | string | |
misc | object | |
misc.year | integer | |
translations | object | |
translations.en | object | |
translations.en.comment_label | string | |
translations.en.order_id_line | string | |
translations.en.view_summary | string | |
translations.en.sepa | string | A link to SEPA mandate and also receive this link embedded on email confirmation. |
translations.en.shipment_to_multiple_addresses | string | |
translations.en.shipping_immediate_download | string | |
translations.en.shipping_address_label | string | |
translations.en.immediate_download | string | |
translations.en.email | string | |
translations.en.billing_address_managed_by_amazon | string | |
translations.en.billing_address_label | string | |
translations.en.pending_payment | string | |
translations.en.how_to_pay | string | |
translations.en.pay_for_order_help | string | |
translations.en.order_total | string | |
translations.en.cart_items | string | |
translations.en.sku | string | |
translations.en.quantity | string | |
translations.en.item_price | string | |
translations.en.item_total | string | |
translations.en.payment_method | string | |
translations.en.no_payment_taken_in_test_mode | string | |
translations.en.download_files | string | |
translations.en.preorder | string | |
translations.en.download_available_after_payment | string | |
translations.en.shipped_to | string | |
translations.en.shipping_discount | string | |
translations.en.thanks_for_your_order | string | |
translations.en.your_order_contains | string | |
translations.en.shipping_method | string | |
translations.en.shipping_to_address | string | |
translations.en.your_order_will_be_shipped_by | string | |
translations.en.total_cost | string | |
translations.en.items | string | |
translations.en.total | string | |
translations.en.price | string | |
translations.en.email_address | string |
Example
{ "order": { "id": 1, "customer_message": "Order custom message", "customer_id": 11, "date_placed": { "formatted": "11th Feb 2021", "value": 1613060604 }, "account_order_status_url": null, "pickup_methods": [ "Store Pickup", "Curbside Pickup" ], "shipping": { "methods": null, "address": { "email": "customer@example.com", "phone": 112233445566, "first_name": "John", "last_name": "Wick", "company": "MyCompany", "country": null, "city": null, "state": null, "zip": 1622, "address_lines": null, "custom_fields": null } }, "products": [ { "name": "Sample Product", "quantity": 2, "sku": "SF42", "address_lines": null, "address_custom_fields": null, "address_id": 0, "options": { "Size": "XL" }, "download_url": "https://example.com/download/file.pdf", "thumbnail": "/test.jpg", "brand": "Nike", "type": "physical", "event": { "name": "Summer Sale Event", "date": { "value": 1640995200, "formatted": "Jan 1, 2022" } }, "price": { "value": 250.1, "formatted": 250.1 }, "total": { "value": "250.1,", "formatted": 250.1 }, "preorder": { "is_preorder": false, "message": "Available for pre-order", "date": { "value": 1640995200, "formatted": "Jan 1, 2022" } }, "attribute_lines": null, "configurable_fields": null, "pickup": { "id": "pickup_123", "email": "pickup@store.com", "phone": "+1234567890", "instructions": "Please call when you arrive", "name": "Main Store Location", "location": { "id": "loc_456", "name": "Downtown Store", "address": "123 Main St", "city": "New York", "state": "NY", "zip": "10001", "country": "US" }, "operating_hours": { "sunday": { "is_open": true, "opening_time": { "formatted": "10:00" }, "closing_time": { "formatted": "18:00" } }, "monday": { "is_open": true, "opening_time": { "formatted": "09:00" }, "closing_time": { "formatted": "20:00" } }, "tuesday": { "is_open": true, "opening_time": { "formatted": "09:00" }, "closing_time": { "formatted": "20:00" } }, "wednesday": { "is_open": true, "opening_time": { "formatted": "09:00" }, "closing_time": { "formatted": "20:00" } }, "thursday": { "is_open": true, "opening_time": { "formatted": "09:00" }, "closing_time": { "formatted": "20:00" } }, "friday": { "is_open": true, "opening_time": { "formatted": "09:00" }, "closing_time": { "formatted": "21:00" } }, "saturday": { "is_open": true, "opening_time": { "formatted": "10:00" }, "closing_time": { "formatted": "19:00" } } } } } ], "payment": { "is_test": false, "provider_name": "PaymentMethod", "offline_payment_message": "Please pay at store", "gateway_amount": { "formatted": "$100.00", "value": 100.0 }, "payment_method": "Credit Card", "provider": { "name": "Stripe" } }, "billing": { "is_managed_by_amazon": false, "address": { "email": "customer@example.com", "phone": 112233445566, "first_name": "John", "last_name": "Wick", "company": "MyCompany", "country": null, "city": null, "state": null, "zip": 1622, "address_lines": null, "custom_fields": null } }, "total_rows": [ { "label": "Total,", "price": { "value": "250.1,", "formatted": 250.1 }, "shipping_discounts": null } ], "total_cost": { "formatted": "100.0$,", "value": 100 }, "meta": { "mandate_url": "https://stripe.com/mandate/123456", "mandate_tag": "SEPA Direct Debit", "mandate_id": "mandate_123456789", "shipping_addresses_num": 1, "show_immediate_download": false } }, "store": { "name": "My Dev Store 97434969", "domain_name": "my-dev-store-97434969.store.bcdev", "logo": { "title": [ "= My Dev Store 97434969 =" ], "name": "avatar-2020_1612860757__16350.jpeg", "url": "https://valeryderived-cloud-dev-vm.store.bcdev/store/f1kr2akw96/product_images/avatar-2020_1612860757__16350.jpeg" }, "ssl_path": "https://my-dev-store-97434969.store.bcdev", "cdn_path": "https://valeryderived-cloud-dev-vm.store.bcdev/store/f1kr2akw96", "image_directory": "product_images", "img_path": "https://valeryderived-cloud-dev-vm.store.bcdev/r08d84bb67d250c7624502ed76d8e0bafb1a5cacf/g-themes/ClassicNext/images", "path_normal": "https://my-dev-store-97434969.store.bcdev", "path": "https://my-dev-store-97434969.store.bcdev", "address": "123 Fake St, Dallas, TX 75225", "language": { "code": "en", "direction": "ltr" } }, "customer": { "first_name": "John,", "full_name": "John Jr", "email": "john.f@example.com" }, "misc": { "year": 2021 }, "translations": { "en": { "comment_label": "Order Instructions/Comments", "order_id_line": "Your order ID is <strong>#{{id}}</strong>.", "view_summary": "A summary of your order is shown below. To view the status of your order <a href='link'>click here</a>.", "sepa": "SEPA Direct Debit Mandate", "shipment_to_multiple_addresses": "(Order will be shipped to multiple addresses)", "shipping_immediate_download": "Immediate download after completion of payment.", "shipping_address_label": "Shipping Address", "immediate_download": "Immediate Download", "email": "Email", "billing_address_managed_by_amazon": "Managed by Amazon", "billing_address_label": "Billing Address", "pending_payment": "Your order requires payment before it can be finalized. Details on how to pay are shown below.", "how_to_pay": "Your order requires payment before it can be finalized. Details on how to pay are shown below.", "pay_for_order_help": "Once you've provided payment your order will be completed.", "order_total": "The outstanding balance of your order is amount", "cart_items": "Cart Items", "sku": "SKU", "quantity": "Qty", "item_price": "Item Price", "item_total": "Item Total", "payment_method": "Payment Method", "no_payment_taken_in_test_mode": "<b>Please Note</b>: No money was taken for this order, because the payment provider is in test mode.", "download_files": "Download Files", "preorder": "This product is available for pre-order only", "download_available_after_payment": "Items available for immediate download after completion of payment", "shipped_to": "Items shipped to address", "shipping_discount": "price off using code Coupon Code", "thanks_for_your_order": "Thanks for Your Order", "your_order_contains": "Your Order Contains...", "shipping_method": "Shipping Method", "shipping_to_address": "Shipping to Address", "your_order_will_be_shipped_by": "Your Order Will Be Shipped By...", "total_cost": "Total Cost", "items": "Items", "total": "Total", "price": "Price", "email_address": "Email Address" } } }