Templates
Templates define the layout and content of emails and PDF documents generated by the system. Use document templates for order confirmations, quotes and other PDFs. Use email templates to control the subject, recipients and body of automated emails.
Before you begin
- You need the Configuration role to view this page.
- You need Owner access on the Configuration role to create or delete templates.
View templates
Go to Shops & Channels > Templates to see a table of all templates.
| Column | Description |
|---|---|
| ID | Template ID |
| Name | Template name (localized) |
| Type | Email or Document |
| Date Created | When created (sortable) |
| Date Updated | When last modified (sortable) |
Click any row to open the template detail page. The detail page has two tabs: Details and Logs.
Create a template
- Click New Template.
- Set the Type to either Email or Document. This cannot be changed after creation.
- Enter a Name in at least one language.
- Enter the Content using the HTML code editor. Templates use Mustache/Handlebars syntax to insert dynamic data.
- Click Format Code to auto-format your template code.
- Optionally, add a Custom query (GraphQL) to fetch data and Query variables (JSON) with Mustache expressions to pass dynamic values into the query.
Email templates can pull live data from the platform using GraphQL queries. Use this to include order line items, pricing and customer details in confirmation emails without hardcoding content.
- Click Save.
Configure a document template
Document templates generate PDF files for orders and quotes. The detail page shows the Details tab with a right sidebar containing General, Document and Properties sections.
The General section contains the type, name and content editor with the GraphQL query and variables.
In the Document section, configure the output settings:
| Field | Description |
|---|---|
| File name | Output filename for the generated PDF (localized, with language selector) |
| Default order PDF | Toggle to use this template as the default PDF attached to order emails |
| Default Quotation PDF | Toggle to use this template as the default PDF attached to quote emails |
The Properties section displays the template ID, created date and last modified date.
Configure an email template
Email templates control automated email messages. The detail page shows the Details tab with a right sidebar containing General, Email, Attachments and Properties sections.
The General section contains the type, name and content editor, identical to document templates.
Set email recipients and sender
In the Email section, configure who receives the email and how it appears.
| Field | Description |
|---|---|
| Subject | Email subject line (localized). Supports Mustache variables for dynamic content. |
| From email | Sender email address |
| From name | Sender display name (localized) |
| To | Recipient list. Supports dynamic recipients using Mustache expressions. |
| CC | CC recipient list |
| BCC | BCC recipient list |
To add recipients to the To, CC or BCC fields, click Add recipients. Each recipient appears as a chip. Click the X on a chip to remove it.
Attach documents to an email template
In the Attachments section, link document templates that should be attached to the email as PDFs.
- Click Add attachment to open the template picker (filtered to document templates).
- Select the document template you want to attach.
To remove an attachment, select it using the checkbox and click Remove.
View template error logs
Switch to the Logs tab to see error logs for this template.
| Column | Description |
|---|---|
| Id | Error log ID |
| Error type | Type of error (sortable) |
| Date Created | When the error occurred (sortable) |
Click a row to view the full error details, including the error message, template ID, topic name, field name, event instance and stack trace.
Duplicate a template
Each row has a Duplicate action in the context menu. This creates a copy with "(Copy)" appended to the name. For email templates, attachments are also copied.
Filter templates
| Filter | Type | Description |
|---|---|---|
| Types | Checkboxes | Email, Document |
Delete templates
- Select one or more templates using the checkboxes.
- Use the delete action.
- Confirm the deletion.
Related pages
- Event Actions - link templates to event triggers
- Order Statuses - configure order workflow statuses