Populating email templates with variable details

You can use variables to automatically populate email templates with order properties like products, prices, and rental period.

In this article:

Order variables
Products and line items
Document variables
Customer variables
Company variables
Custom field variables

Order variables

{{order.number}}

{{order.barcode.image}}
{{order.status}}
{{order.startsAt}}
{{order.stopsAt}}
{{order.deposit}}
{{order.depositType}}
{{order.depositValue}}
{{order.discount}}
{{order.discountPercentage}}
{{order.price}}
{{order.grandTotal}}
{{order.totalTax}}
{{order.grandTotalWithTax}}
{{order.totalDiscount}}
{{order.couponCode}}

{{order.couponDiscount}}

{{order.couponPercentage}}

{{order.startLocation.name}}
{{order.startLocation.address}}

{{order.startLocation.addressLine1}}

{{order.startLocation.addressLine2}}

{{order.startLocation.city}}

{{order.startLocation.country}}

{{order.startLocation.zipcode}}

{{order.stopLocation.name}}
{{order.stopLocation.address}}

{{order.stopLocation.addressLine1}}

{{order.stopLocation.addressLine2}}

{{order.stopLocation.city}}

{{order.stopLocation.country}}

{{order.stopLocation.zipcode}}

Products and line items

To show information about the products on an order, you need to wrap the variables between {{#order.lines}} and {{/order.lines}}. The information is displayed for every product on the order.

For example:

{{#order.lines}}
    {{quantity}} x {{title}} | {{displayPrice}}
{{/order.lines}}

Document variables

{{document.name}}
{{document.number}}
{{document.date}}
{{document.deposit}}
{{document.depositHeld}}
{{document.depositPaid}}
{{document.depositRefunded}}
{{document.depositToRefund}}
{{document.paid}}
{{document.prefix}}
{{document.prefixWithNumber}}
{{document.reference}}
{{document.status}}
{{document.discount}}
{{document.discountPercentage}}
{{document.toBePaid}}
{{document.price}}
{{document.grandTotal}}
{{document.grandTotalWithTax}}
{{document.couponDiscount}}
{{document.totalDiscount}}

Customer variables

Show information about your customers.

{{customer.name}}
{{customer.mainAddress}}
{{customer.avatarUrl}}
{{customer.email}}
{{customer.number}}
{{customer.discountPercentage}}
{{customer.depositType}}
{{customer.depositValue}}

Company variables

These variables display information about your company.

{{company.name}}
{{company.address}}
{{company.addressLine1}}
{{company.addressLine2}}
{{company.city}}
{{company.country}}
{{company.email}}
{{company.financialLine1}}
{{company.financialLine2}}
{{company.phone}}
{{company.zipcode}}

Employee variables

These variables display information about the Booqable user who's sending the email.

{{employee.name}}
{{employee.firstName}}
{{employee.lastName}}
{{employee.avatarUrl}}
{{employee.email}}

Custom field variables

You can use variables in your email templates to quickly populate your emails with custom field data.

Variables for custom fields have the following structure:

{{context.custom_fields.field_id}}

You'll need to replace the context and the field_id to target the correct custom field:

The context can be order, customer, or product.
To find the field_id, go to Settings > Custom fields and view a custom field:

Custom field variables for customers and orders

So putting it all together, a variable for a customer's address could look like this:

{{customer.custom_fields.contact_address}}

And a variable for order packing notes could look like this:

{{order.custom_fields.packing_notes}}

Custom field variables for products

Like other email variables for products, custom fields for products are always added in an order line section. This section renders product lines for all products on an order. It begins with {{#order.lines}} and ends with {{/order.lines}}.

Here's an example:

{{#order.lines}}
{{product.custom_fields.tubes_tires}}
{{/order.lines}}