AdminStore ConfigurationEmailsEmail object reference

Order Status Update Email Template

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

Object properties

PropertyTypeDescription
orderobject
order.idinteger
order.new_statusstring
order.new_formatted_statusstring
order.totalobject
order.total.valuefloat
order.total.formattedstring
order.refundobject
order.refund.valuefloat
order.refund.formattedstring
order.date_placedobject
order.date_placed.valueinteger
order.date_placed.formattedstring
order.payment_methodstring
order.linkstring
order.customer_namestring
order.downloadable_productsarray
order.downloadable_products[].namestring
order.downloadable_products[].optionsstring
order.downloadable_products[].quantityinteger
order.downloadable_products[].linkstring
order.downloadable_products[].thumbnailstring
order.downloadable_products[].attribute_linesarray
order.downloadable_products[].attribute_lines[].namestring
order.downloadable_products[].attribute_lines[].valuestring
order.productsarray
order.products[].namestring
order.products[].skustring
order.products[].pricestring
order.products[].quantityinteger
order.products[].thumbnailstring
order.products[].brandstring
order.products[].attribute_linesarray
order.products[].attribute_lines[].namestring
order.products[].attribute_lines[].valuestring
order.trackingarray
order.tracking[].idstring
order.tracking[].shipping_methodstring
order.tracking[].linkstring
order.unshipped_productsarray
order.unshipped_products[].namestring
order.unshipped_products[].skustring
order.unshipped_products[].pricestring
order.unshipped_products[].quantityinteger
order.unshipped_products[].thumbnailstring
order.unshipped_products[].brandstring
order.unshipped_products[].attribute_linesarray
order.unshipped_products[].attribute_lines[].namestring
order.unshipped_products[].attribute_lines[].valuestring
order.ready_for_pickup_productsarray
order.ready_for_pickup_products[].namestring
order.ready_for_pickup_products[].skustring
order.ready_for_pickup_products[].pricestring
order.ready_for_pickup_products[].quantityinteger
order.ready_for_pickup_products[].thumbnailstring
order.ready_for_pickup_products[].brandstring
order.ready_for_pickup_products[].attribute_linesarray
order.ready_for_pickup_products[].attribute_lines[].namestring
order.ready_for_pickup_products[].attribute_lines[].valuestring
order.picked_up_productsarray
order.picked_up_products[].namestring
order.picked_up_products[].skustring
order.picked_up_products[].pricestring
order.picked_up_products[].quantityinteger
order.picked_up_products[].thumbnailstring
order.picked_up_products[].brandstring
order.picked_up_products[].attribute_linesarray
order.picked_up_products[].attribute_lines[].namestring
order.picked_up_products[].attribute_lines[].valuestring
order.pickup_methodsarray
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.titlestring
translations.en.hellostring
translations.en.messagestring
translations.en.details_titlestring
translations.en.order_totalstring
translations.en.date_placedstring
translations.en.payment_methodstring
translations.en.total_refundstring
translations.en.products_shippedstring
translations.en.products_to_be_shippedstring
translations.en.tracking_titlestring
translations.en.downloadable_items_titlestring
translations.en.quantitystring
translations.en.downloadstring
translations.en.tracking_labelstring
translations.en.no_tracking_numbersstring
translations.en.check_statusstring
translations.en.go_shoppingstring

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