Template data

Every order-related email template (Invoices, Order received, Order shipped, Tracking numbers, Refunds, Order comments, …) renders the same set of objects. Rather than repeat them on each template page, the shared types are documented once here.

Types

Type Description
Order The root object (order) passed to every order email.
Item A line item in order.items[].
Address Billing, shipping and business addresses.
Summary Totals and payment summary (order.summary).
Tax A tax line in order.taxes[] and order.summary.taxes[].
CustomField A custom field on the order or on an item.
Discount A discount in order.discounts[].
Refund A refund in order.refunds[] (and the refund template variable).

How to use

Each template page lists the variables it receives and links to the types above. Start from the template you're editing — e.g. Invoices — then drill into a type for its full field list.

Was this article helpful?