Email Variable Reference

This page is not yet complete.

The Order variables are exported and made available to Order Confirmation emails and notifications, and to the Additional Content & Scripts section that is available under Preferences -> Checkout & Payment"'.

order_name

The is the name of the order.

By default, the name is formatted as a hash (#) followed by the order number. For example,

#01234

order_number

This is the number of the order.

1234

order_date

This is the date of the order.

12th September, 2008

order_time

This is the time of the order.

14:39

customer

Returns a customer object containing the email and name of the customer.

shop_name

Returns the name of your shop.

total_price

Returns the total of the order, which is the subtotal plus tax and shipping, if applicable.

If the order total includes taxes which are not applicable for export orders, then these taxes are not included in the total price for the order.

tax_price

Returns the total amount of tax for the order.

tax_label

Returns the type of tax for the order.

GST

included_tax_price

Returns the amount of taxes included in the order subtotal price. Included taxes occur when the amount of tax is included as part of an item's price as opposed to taxes which are added to the item's price.

shipping_price

Returns the amount of shipping included in the order.

subtotal_price

Returns the total amount of the order less discounts.

This amount will not include any additional taxes or shipping costs.

discounts_savings

Returns the amount of any discounts that have been applied to the order (as a negative amount).

discount_price

Returns the amount of any discounts that have been applied to the order.

discount_code

Returns the discount code that was used, if any.

gateway

Returns the name of the payment gateway that was used.

shipping_method

Returns a the shipping method used for the order.

shipping_address

Returns a shipping address object.

billing_address

Returns a billing address object.

order_quantity

Returns the total number of items in the order.

line_items

Returns an array of Line_Item objects.

fulfilled_line_items

Returns an array of fulfilled Line_Item objects.

unfulfilled_line_items

Returns an array of Line_Item objects that have not been fulfilled.

note

Returns the note that was attached to the order.

attributes (Not Currently Implemented)

Returns any attributes which where attached to the order.

Example usage:

{{ attributes.gift-note }}

cancelled

Returns true if the order has been cancelled.

cancelled_at

Returns the date and time that the order was cancelled.

{{ order.cancelled_at | date: "%B %d, %Y %I:%M%p" }}

cancel_reason

The reason the order was cancelled.

financial_status

Returns the financial status of an order. The possible values are:

• pending
• authorized
• paid
• partially_paid
• refunded
• partially_refunded
• voided

financial_status_label

Returns the display text for the financial status of an order. The possible values are:

• Pending
• Paid
• Partially Paid
• Cancelled

fulfillment_status

Returns the display text for the financial status of an order. The possible values are:

• unshipped
• partial
• shipped

fulfillment_status_label

Returns the display text for the fulfillment status of an order. The possible values are:

• Unshipped
• Partial
• Shipped

order.metafields

Return the metafields for the order.

Metafields can only be managed using the Spiffy Stores API.