DocsAdminStore ConfigurationEmailsEmail object reference

Order Status Update Email Template

Order status update email triggers when the status of an order changes.

Object properties

order
object
id
integer
new_status
string
new_formatted_status
string
total
object
value
float
formatted
string
refund
object
value
float
formatted
string
date_placed
object
value
integer
formatted
string
payment_method
string
link
string
customer_name
string
downloadable_products
array[object]
name
string
options
string
quantity
integer
link
string
thumbnail
string
attribute_lines
array[object]
name
string
value
string
products
array[object]
name
string
sku
string
price
string
quantity
integer
thumbnail
string
brand
string
attribute_lines
array[object]
name
string
value
string
tracking
array[object]
id
string
shipping_method
string
link
string
unshipped_products
array[object]
name
string
sku
string
price
string
quantity
integer
thumbnail
string
brand
string
attribute_lines
array[object]
name
string
value
string
ready_for_pickup_products
array[object]
name
string
sku
string
price
string
quantity
integer
thumbnail
string
brand
string
attribute_lines
array[object]
name
string
value
string
picked_up_products
array[object]
name
string
sku
string
price
string
quantity
integer
thumbnail
string
brand
string
attribute_lines
array[object]
name
string
value
string
pickup_methods
array
store
object
name
string
domain_name
string
logo
object
title
string
name
string
url
string
ssl_path
string
cdn_path
string
image_directory
string
img_path
string
path_normal
string

Path to the store (i.e., domain + protocol)

path
string
address
string
language
object
code
string
direction
string

Left to right or right to left, depending on the language

customer
object
first_name
string
full_name
string
email
string
group
array[object]
name
string
misc
object
year
integer
translations
object
en
object
title
string
hello
string
message
string
details_title
string
order_total
string
date_placed
string
payment_method
string
total_refund
string
products_shipped
string
products_to_be_shipped
string
tracking_title
string
downloadable_items_title
string
quantity
string
download
string
tracking_label
string
no_tracking_numbers
string
check_status
string
go_shopping
string

Example

{
  "order": {
    "id": 1,
    "new_status": "Awaiting Fulfillment",
    "total": {
      "value": 10,
      "formatted": "$10.00 USD"
    },
    "refund": {
      "value": 0,
      "formatted": null
    },
    "date_placed": {
      "value": 1614615796,
      "formatted": "03/01/2121"
    },
    "payment_method": "Store Credit",
    "link": "#status-link",
    "customer_name": "John Cena",
    "downloadable_products": {
      "name": "Journal",
      "options": null,
      "quantity": 1,
      "link": "#downloadable-link"
    },
    "products": {
      "name": "Sample Product",
      "sku": "FA44",
      "quantity": 11
    },
    "tracking": {
      "id": "123BC",
      "shipping_method": "DHL",
      "link": "#example.com"
    }
  },
  "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": null,
    "language": {
      "code": "en",
      "direction": "ltr"
    }
  },
  "customer": {
    "first_name": "John",
    "full_name": "John Jr",
    "email": "john.f@example.com"
  },
  "misc": {
    "year": 2023
  },
  "translations": {
    "en": {
      "title": "Order status changed",
      "hello": "Hi",
      "message": "The status of your order #id has changed to <strong>{{status}}</strong>.",
      "details_title": "Order details",
      "order_total": "Order total:",
      "date_placed": "Date placed:",
      "payment_method": "Payment method:",
      "total_refund": "Total refunded:",
      "products_shipped": "Products shipped",
      "products_to_be_shipped": "Products to be shipped",
      "tracking_title": "Tracking information",
      "downloadable_items_title": "Downloadable items",
      "quantity": "Qty:",
      "download": "Download file",
      "tracking_label": "Tracking Link",
      "no_tracking_numbers": "No tracking numbers are assigned to your order yet",
      "check_status": "Check order status",
      "go_shopping": "Go shopping"
    }
  }
}