Notifications & Templates
On the main Notifications & Templates page you can activate/deactivate templates. Templates can be searched by keyword or filtered by template key and locale.
Templates can be created for a variety of Checkout events and include:
- Order invoices
- Return stick notes
- Shipment return documents
- Order confirmation/cancellation emails
- Order invoice emails
- Shipment emails
- Product undeliverable emails
- Product return emails
- Password reset emails
- Customer bank account updates/reminders
Available Templates
The following templates are available in the SCAYLE Panel.
| Template Key | Purpose |
|---|---|
order-invoice-pdf | See order-invoice-mail |
partial-invoice-pdf | See shipment-mail |
corrective-invoice-pdf | See products-return-mail |
package-return-stick-note-pdf | See return-pickup-mail |
shipment-return-document-pdf | See products-return-mail |
order-confirmation-mail | Email queued when the order has been completed. |
order-cancellation-mail | Email queued during the transition from Aborted to Cancelled. This can vary in wording and content depending on the reason that led to the order being cancelled (e.g., Out of Stock, Customer Cancellation, RatePay Cancellation). |
order-invoice-mail (+ order-invoice-pdf) | Email queued during the transition of the order from Shipped to Invoiced. Can include a full Invoice PDF as an attachment (for countries where this is a requirement). |
shipment-mail (+ partial-invoice-pdf) | Email queued after the successful handling of a Shipment Message. This can include a Partial Invoice PDF as an attachment (for countries where this is a requirement). |
products-undeliverable-mail | Triggered on the closing of a Return Window. It aims to notify the customer that one or more of their items has not been delivered successfully (due to issues locating the address, customer not being at home, etc.). |
products-return-mail (+ corrective-invoice-pdf, + shipment-return-document-pdf) | Email queued during the closing of a Return Window. It can include a Corrective Invoice PDF as an attachment (for countries where this is a requirement). |
return-pickup-mail (+ package-return-stick-note-pdf) | To inform a user about a return pickup time and place. |
password-reset-mail | To send to a user a requested password reset link. |
customer-password-change-mail | To inform a user about the password being successfully changed. |
customer-mail-change-mail | To inform a user about an account email being changed. |
customer-bank-account-update-mail | Email triggered when the IBAN on Customer account is changed. |
customer-bank-account-reminder-mail | Triggered on the closing of the Return Window and then again every 7 days for a limited amount of time. Is only applicable for customers that have received returns for orders, yet have not provided a usable IBAN with which refunds can be provided. |
Template Activation/Deactivation
Templates can be activated/deactivated using the toggle button.
The system checks that there is only one active template for a given shop_id, key, and locale. All other templates are set to inactive automatically in the background.
It is possible to set all templates to inactive. However, if no template is active, Checkout uses a fallback template. This means, for example, that an email will always be sent to a customer even if all email templates are deactivated in the SCAYLE Panel.
If no template is active, Checkout uses a fallback template.
Checkout Templates page
New Template
To create a new template, select New Document Template. On the New Template page, the required fields are as follows:
- Internal name: string for the internal template name. Dates or versions can be added here (see screenshot above)
- Template key: dropdown item is automatically selected for the corresponding Checkout action (order invoice, order confirmation, password reset, etc.)
- Template type: mail or PDF (normally you would select the shop/country language)
- Locale: country/language selection
- Document subject: subject of document
- Document body: main text/body (HTML)
- Include placeholders
- Click the expand icon to preview
When all fields are complete, click Save to add the template.
New Template Preview
New Template
Placeholders
Placeholders are added to the body using mustache syntax. For example, for a personal greeting, the billing first name could be added with {{data.addresses.billing.name.first}}. You can view and copy the placeholders by clicking the Placeholder List button.
All placeholders are also listed in the dropdown table below.
| Placeholder | Description |
|---|---|
{{data.addresses.billing.additionalLine}} | Boolean variable - Used to identify if Additional line is configured for Billing Address. |
{{data.addresses.billing.city}} | City of the customer used in the Billing address |
{{data.addresses.billing.houseNumber}} | House Number of the customer used in the Billing address |
{{data.addresses.billing.isDiverseSalutation}} | Boolean variable - Used to identify if gerder of the customer is Diverse |
{{data.addresses.billing.isFemaleSalutation}} | Boolean variable - Used to identify if gerder of the customer is Female |
{{data.addresses.billing.isMaleSalutation}} | Boolean variable - Used to identify if gerder of the customer is Male |
{{data.addresses.billing.name.first}} | First name of the customer used in the Billing address |
{{data.addresses.billing.name.last}} | Last name of the customer used in the Billing address |
{{data.addresses.billing.street}} | Street Name of the customer used in the Billing address |
{{data.addresses.billing.zip}} | Zip code of the customer used in the Billing address |
{{data.addresses.shipping.additionalLine}} | Boolean variable - Used to identify if Additional line is configured for Shipping Address. |
{{data.addresses.shipping.city}} | City of the customer used in the Shipping address |
{{data.addresses.shipping.houseNumber}} | House Number of the customer used in the Shipping address |
{{data.addresses.shipping.isFemaleSalutation}} | Boolean variable - Used to identify if gender of the customer is Diverse in shipping adress |
{{data.addresses.shipping.isMaleSalutation}} | Boolean variable - Used to identify if gender of the customer is Female in shipping adress |
{{data.addresses.shipping.name.first}} | First name of the customer used in the Shipping address |
{{data.addresses.shipping.name.last}} | Last name of the customer used in the Shipping address |
{{data.addresses.shipping.street}} | Street Name of the customer used in the Shipping address |
{{data.addresses.shipping.zip}} | Zip code of the customer used in the Shipping address |
{{data.app.name}} | Name of the shop - used in the subjects and only in email when app/shop name needs to be referred. |
{{data.config.contacts.mail_customer_service}} | Email id of the Customer service is displayed - Can be configured in Application/Template Contacts |
{{data.config.contacts.mail_from}} | Email id using which all emails are sent to customers - Can be configured in Application/Template Contacts |
{{data.config.contacts.phone_customer_service}} | Phone number of the customer service is displayed - Can be configured in Application/Template Contacts |
{{data.config.routes.account_area_route}} | Account Area of the shop - E.g., /a/orders - Can be configured in Routes and Domains |
{{data.config.routes.checkout_domain}} | CO Domain of the shop - E.g., https://checkout.aboutyou-staging.de - Can be configured in Routes and Domains |
{{data.config.routes.contact_route}} | Contact Route of the shop - E.g., /h/contact - Can be configured in Routes and Domains |
{{data.config.routes.faq_route}} | FAQ Route of the shop - E.g., /h - Can be configured in Routes and Domains |
{{data.config.routes.imprint_route}} | Imprint Route of the shop - E.g., /imprint - Can be configured in Routes and Domains |
{{data.config.routes.privacy_statement_route}} | Privacy statement route of the shop - E.g., /privacy-policy - Can be configured in Routes and Domains |
{{data.config.routes.shop_domain}} | Shop Domain of the shop - E.g., /a/orders - Can be configured in Routes and Domains |
{{data.config.routes.static_cdn_domain}} | CDN domain of the shop - E.g., /a/orders - Can be configured in Routes and Domains |
{{data.config.routes.terms_of_service_route}} | Service route of the shop - E.g., /a/orders - Can be configured in Routes and Domains |
{{data.config.routes.terms_of_use_route}} | Terms of use of the shop - E.g., /terms-and-conditions - Can be configured in Routes and Domains |
{{data.customer.id}} | Number - ID of the Shop customer. When a customer wants to CO as a guest, this id is displayed instead of name.For E.g., {{#data.customer.isGuest}}{{data.customer.id}}{{/data.customer.isGuest}}` |
{{data.customer.isDiverse}} | Boolean variable - Used to identify if gender of the customer is Diverse in shipping adress |
{{data.customer.isFemale}} | Boolean variable - Used to identify if gender of the customer is Female in shipping adress |
{{data.customer.isMale}} | Boolean variable - Used to identify if gender of the customer is Male in shipping adress |
{{data.customer.name.first}} | Displays first name of the customer. |
{{data.environment.isStaging}} | Boolean Variable - used to identify if the environment is staging |
{{data.loyaltyProgram.basic}} | Used to identify if a loyalty program is avaiable for a shop |
{{data.loyaltyProgram.full}} | used to identify the type of loyaly program selected for customer and a shop |
{{data.mailType}} | |
{{data.order.activationDate}} | Used to identify the Order date |
{{data.order.deliveryEstimates.max}} | Used to identify if maximum date by which an order can be delivered. |
{{data.order.deliveryEstimates.min}} | Used to identify if minimum date by which an order can be delivered. |
{{data.order.invoiceKey}} | |
{{data.order.key}} | |
{{data.order.totals.brutto}} | Amount - Used to display Total gross value of the order without shipping costs |
{{data.order.totals.bruttoWithServiceCosts}} | Amount - Used to display Total gross value of the order with Shipping costs |
{{data.order.totals.giftCard}} | Amount - Used to display Total gift card value of the order |
{{data.order.totals.netto}} | Amount - Used to display Total Nett value of the order (Without taxes) |
{{data.order.totals.shipping}} | Amount - Used to display Total Shipping cost for an order |
{{data.order.totals.tax}} | Amount - Used to display Total tax value of the order |
{{data.order.totals.withoutValueVoucher}} | Amount - Used to display Total gross value of the order with out Voucher amount inclusion |
{{data.order.voucher.percent}} | |
{{data.order.voucher.value}} | Amount - Used to display the voucher value for an order |
{{data.payment.dueDate}} | Date - Date on which payment is due for an order - Used in conjunction with Payment methods |
{{data.payment.isAccounting}} | Boolean Variable - Used to identify if the payment method is acounting , Commonly used to display a payment method in the emails |
{{data.payment.isComputopCreditcardDinersclub}} | Boolean Variable - Used to identify if the payment method is Computop Creditcard Diner club , Commonly used to display a payment method in the emails |
{{data.payment.isComputopCreditcardDiscover}} | Boolean Variable - Used to identify if the payment method is Computop credit card Discover , Commonly used to display a payment method in the emails |
{{data.payment.isCreditCard}} | Boolean Variable - Used to identify if the payment method is Credit card , Commonly used to display a payment method in the emails |
{{data.payment.isDirectDebit}} | Boolean Variable - Used to identify if the payment method is Credit card , Commonly used to display a payment method in the emails |
{{data.payment.isGiftCard}} | Boolean Variable - Used to identify if the payment method is Credit card , Commonly used to display a payment method in the emails |
{{data.payment.isGiftCardOnly}} | Boolean Variable - Used to identify if the payment method is Credit card , Commonly used to display a payment method in the emails |
{{data.payment.isInvoice}} | Boolean Variable - Used to identify if the payment method is invoice , Commonly used to display a payment method in the emails |
{{data.payment.isKlarnaBankTransfer}} | Boolean Variable - Used to identify if the payment method is Klarna bank transfer , Commonly used to display a payment method in the emails |
{{data.payment.isKlarnaDirectDebit}} | Boolean Variable - Used to identify if the payment method is Klarna direct debit , Commonly used to display a payment method in the emails |
{{data.payment.isKlarnaInstallments}} | Boolean Variable - Used to identify if the payment method is Klarna installments , Commonly used to display a payment method in the emails |
{{data.payment.isKlarnaPayLater}} | Boolean Variable - Used to identify if the payment method is Klarna pay later, Commonly used to display a payment method in the emails |
{{data.payment.isKlarnaPayNow}} | Boolean Variable - Used to identify if the payment method is Klarna paynow , Commonly used to display a payment method in the emails |
{{data.payment.isPaydirekt}} | Boolean Variable - Used to identify if the payment method is paydireckt , Commonly used to display a payment method in the emails |
{{data.payment.isPayPal}} | Boolean Variable - Used to identify if the payment method is PayPal , Commonly used to display a payment method in the emails |
{{data.payment.isSofortueberweisung}} | Boolean Variable - Used to identify if the payment method is Sofort Payment , Commonly used to display a payment method in the emails |
{{data.payment.isYapital}} | Boolean Variable - Used to identify if the payment method is Yapital , Commonly used to display a payment method in the emails |
{{data.payment.name}} |
Template Placeholders
Edit/Delete Template
To edit a template:
- Select it from the main Templates page
- Click Edit
- Make changes and click Save
To delete a template:
- Selecting the menu icon (three vertical dots) to the right of the template and click Delete.
Preview Template
Preview the mail or pdf template by selecting the menu icon (three vertical dots) to the right of the template. A menu will open to enter an order and customer number to generate the preview based on actual data.
Preview a template
Further education - SCAYLE Academy
You may also find it interesting to visit our 'Checkout notifications' course available on the SCAYLE Academy platform.
