Customize order receipt emails

Order receipt emails are powered through Twig templates. There is no user interface for customizing the email content. In most cases email require inline styling and full HTML. This is where Twig excels.

The order receipt email, which customers receive, is controlled through the commerce_order_receipt theme hook. The following information is available to the theme hook

  • The order, as order_entity
  • Billing information, as billing_information
  • Shipping information, as shipping_information
  • Payment method information as payment_method
  • Order total sumary as totals

The default commerce-order-receipt.html.twig can be found in the commerce_order module.

The email can be customized by overriding the Twig template in your theme just as you would any other template (see Drupal's Twig Template docs).

Or in your custom module:

Copy commerce-order-receipt.html.twig to my_module/templates/my-module-order-receipt.

Then register it in my_module.module.

/**
 * Implements hook_theme().
 */
function my_module_theme($existing, $type, $theme, $path) {
  return [
    'commerce_order_receipt' => [
      'template' => 'my-module-order-receipt',
      'base hook' => 'commerce_order_receipt',
    ],
  ];
}

You must also make sure your Drupal site is sending emails in HTML properly. Out of the box, Drupal does not do this. See Sending HTML emails on how to ensure emails are being formatted properly, and that your theme's template is being used to render the emails.

If your Drupal site is not using your theme to render emails, it may not pick up your overridden template.

Found errors? Think you can improve this documentation? edit this page