Order Email Template

Order email triggers when a customer or store admin creates an order.

Object properties

PropertyTypeDescription
orderobject
order.idinteger
order.customer_messagestring
order.customer_idinteger
order.date_placedobject
order.date_placed.formattedstring
order.date_placed.valueinteger
order.account_order_status_urlstring
order.pickup_methodsarrayList of pickup method names for the order
order.shippingobject
order.shipping.methodsarray
order.shipping.addressobject
order.shipping.address.emailstring
order.shipping.address.phonestring
order.shipping.address.first_namestring
order.shipping.address.last_namestring
order.shipping.address.companystring
order.shipping.address.countrystring
order.shipping.address.citystring
order.shipping.address.statestring
order.shipping.address.zipstring
order.shipping.address.address_linesarray
order.shipping.address.custom_fieldsarray
order.shipping.address.custom_fields[].labelstring
order.shipping.address.custom_fields[].valuestring
order.productsarray
order.products[].namestring
order.products[].quantityinteger
order.products[].skustring
order.products[].address_linesarray
order.products[].address_custom_fieldsarrayContains the label and value for custom form fields on the address.
order.products[].address_custom_fields[].labelstring
order.products[].address_custom_fields[].valuestring
order.products[].address_idinteger
order.products[].optionsobject
order.products[].options.Sizestring
order.products[].download_urlstring
order.products[].thumbnailstring
order.products[].brandstring
order.products[].typestringProduct type
order.products[].eventobject
order.products[].event.namestring
order.products[].event.dateobject
order.products[].event.date.valueinteger
order.products[].event.date.formattedstring
order.products[].priceobject
order.products[].price.valuefloat
order.products[].price.formattedstring
order.products[].totalobject
order.products[].total.valuefloat
order.products[].total.formattedstring
order.products[].preorderobject
order.products[].preorder.is_preorderboolean
order.products[].preorder.messagestring
order.products[].preorder.dateobject
order.products[].preorder.date.valueinteger
order.products[].preorder.date.formattedstring
order.products[].attribute_linesarrayA list of strings that represents product variant options.
order.products[].configurable_fieldsarrayObject array with properties name and value.
order.products[].configurable_fields[].namestring
order.products[].configurable_fields[].valuestring
order.products[].pickupobjectPickup information for the product
order.products[].pickup.idstring
order.products[].pickup.emailstring
order.products[].pickup.phonestring
order.products[].pickup.instructionsstring
order.products[].pickup.namestring
order.products[].pickup.locationobject
order.products[].pickup.location.idstring
order.products[].pickup.location.namestring
order.products[].pickup.location.addressstring
order.products[].pickup.location.citystring
order.products[].pickup.location.statestring
order.products[].pickup.location.zipstring
order.products[].pickup.location.countrystring
order.products[].pickup.operating_hoursobject
order.products[].pickup.operating_hours.sundayobject
order.products[].pickup.operating_hours.sunday.is_openboolean
order.products[].pickup.operating_hours.sunday.opening_timeobject
order.products[].pickup.operating_hours.sunday.opening_time.formattedstring
order.products[].pickup.operating_hours.sunday.closing_timeobject
order.products[].pickup.operating_hours.sunday.closing_time.formattedstring
order.products[].pickup.operating_hours.mondayobject
order.products[].pickup.operating_hours.monday.is_openboolean
order.products[].pickup.operating_hours.monday.opening_timeobject
order.products[].pickup.operating_hours.monday.opening_time.formattedstring
order.products[].pickup.operating_hours.monday.closing_timeobject
order.products[].pickup.operating_hours.monday.closing_time.formattedstring
order.products[].pickup.operating_hours.tuesdayobject
order.products[].pickup.operating_hours.tuesday.is_openboolean
order.products[].pickup.operating_hours.tuesday.opening_timeobject
order.products[].pickup.operating_hours.tuesday.opening_time.formattedstring
order.products[].pickup.operating_hours.tuesday.closing_timeobject
order.products[].pickup.operating_hours.tuesday.closing_time.formattedstring
order.products[].pickup.operating_hours.wednesdayobject
order.products[].pickup.operating_hours.wednesday.is_openboolean
order.products[].pickup.operating_hours.wednesday.opening_timeobject
order.products[].pickup.operating_hours.wednesday.opening_time.formattedstring
order.products[].pickup.operating_hours.wednesday.closing_timeobject
order.products[].pickup.operating_hours.wednesday.closing_time.formattedstring
order.products[].pickup.operating_hours.thursdayobject
order.products[].pickup.operating_hours.thursday.is_openboolean
order.products[].pickup.operating_hours.thursday.opening_timeobject
order.products[].pickup.operating_hours.thursday.opening_time.formattedstring
order.products[].pickup.operating_hours.thursday.closing_timeobject
order.products[].pickup.operating_hours.thursday.closing_time.formattedstring
order.products[].pickup.operating_hours.fridayobject
order.products[].pickup.operating_hours.friday.is_openboolean
order.products[].pickup.operating_hours.friday.opening_timeobject
order.products[].pickup.operating_hours.friday.opening_time.formattedstring
order.products[].pickup.operating_hours.friday.closing_timeobject
order.products[].pickup.operating_hours.friday.closing_time.formattedstring
order.products[].pickup.operating_hours.saturdayobject
order.products[].pickup.operating_hours.saturday.is_openboolean
order.products[].pickup.operating_hours.saturday.opening_timeobject
order.products[].pickup.operating_hours.saturday.opening_time.formattedstring
order.products[].pickup.operating_hours.saturday.closing_timeobject
order.products[].pickup.operating_hours.saturday.closing_time.formattedstring
order.paymentobject
order.payment.is_testboolean
order.payment.provider_namestring
order.payment.offline_payment_messagestring
order.payment.gateway_amountobjectPrice value. Provided only if the payment method is offline.
order.payment.gateway_amount.formattedstring
order.payment.gateway_amount.valuefloat
order.payment.payment_methodstringPayment method name
order.payment.providerobject
order.payment.provider.namestringPayment provider name
order.billingobject
order.billing.is_managed_by_amazonboolean
order.billing.addressobject
order.billing.address.emailstring
order.billing.address.phonestring
order.billing.address.first_namestring
order.billing.address.last_namestring
order.billing.address.companystring
order.billing.address.countrystring
order.billing.address.citystring
order.billing.address.statestring
order.billing.address.zipstring
order.billing.address.address_linesarray
order.billing.address.custom_fieldsarray
order.billing.address.custom_fields[].labelstring
order.billing.address.custom_fields[].valuestring
order.total_rowsarray
order.total_rows[].labelstring
order.total_rows[].priceobject
order.total_rows[].price.valuefloat
order.total_rows[].price.formattedstring
order.total_rows[].shipping_discountsarray
order.total_costobject
order.total_cost.formattedstring
order.total_cost.valuefloat
order.metaobject
order.meta.mandate_urlstringLink to the confirmation page in Stripe
order.meta.mandate_tagstringShort name of the payment document
order.meta.mandate_idstringUnique identifier for the payment mandate
order.meta.shipping_addresses_numinteger
order.meta.show_immediate_downloadboolean
storeobject
store.namestring
store.domain_namestring
store.logoobject
store.logo.titlestring
store.logo.namestring
store.logo.urlstring
store.ssl_pathstring
store.cdn_pathstring
store.image_directorystring
store.img_pathstring
store.path_normalstringPath to the store (i.e., domain + protocol)
store.pathstring
store.addressstring
store.languageobject
store.language.codestring
store.language.directionstringLeft to right or right to left, depending on the language
customerobject
customer.first_namestring
customer.full_namestring
customer.emailstring
customer.grouparray
customer.group[].namestring
miscobject
misc.yearinteger
translationsobject
translations.enobject
translations.en.comment_labelstring
translations.en.order_id_linestring
translations.en.view_summarystring
translations.en.sepastringA link to SEPA mandate and also receive this link embedded on email confirmation.
translations.en.shipment_to_multiple_addressesstring
translations.en.shipping_immediate_downloadstring
translations.en.shipping_address_labelstring
translations.en.immediate_downloadstring
translations.en.emailstring
translations.en.billing_address_managed_by_amazonstring
translations.en.billing_address_labelstring
translations.en.pending_paymentstring
translations.en.how_to_paystring
translations.en.pay_for_order_helpstring
translations.en.order_totalstring
translations.en.cart_itemsstring
translations.en.skustring
translations.en.quantitystring
translations.en.item_pricestring
translations.en.item_totalstring
translations.en.payment_methodstring
translations.en.no_payment_taken_in_test_modestring
translations.en.download_filesstring
translations.en.preorderstring
translations.en.download_available_after_paymentstring
translations.en.shipped_tostring
translations.en.shipping_discountstring
translations.en.thanks_for_your_orderstring
translations.en.your_order_containsstring
translations.en.shipping_methodstring
translations.en.shipping_to_addressstring
translations.en.your_order_will_be_shipped_bystring
translations.en.total_coststring
translations.en.itemsstring
translations.en.totalstring
translations.en.pricestring
translations.en.email_addressstring

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"
}
}
}