Skip to Content

OrderDrop

The order object represents the order in an email template. It exposes order details such as order number, line items, totals, shipping, and payment status for building transactional emails.

Usage Example

{%- comment -%} Show order summary in a confirmation email {%- endcomment -%} <p>Thank you for your order #{{ order.order_number }}!</p> {% for line in order.line_items %} <p>{{ line.title }} &times; {{ line.quantity }}: {{ line.line_price | money }}</p> {% endfor %} <p><strong>Total: {{ order.total_price | money_with_currency }}</strong></p>

id

Returns the order id.

order_number

Returns the order number.

reference_number

Returns the reference.

is_cancelled

Returns true if this order was cancelled.

created_at

Date when this order was created.

confirmed_at

Date when this order was confirmed.

fulfilled_at

Date when this order was fulfilled.

customer

Customer linked to this order if any.

discounts

Order discount lines

tags

Order tags.

financial_status

Returns paid if order is paid, otherwise not_paid.

subtotal_price

Returns the subtotal.

total_price

Returns the total.

total_net_price

Returns the net total.

total_tax

Returns the total tax.

tax_lines

Returns the tax lines.

customer_note

Returns the customer note.

is_fulfilled

Returns true if order is fulfilled.

is_shipped

Returns true if order is shipped.

order_status

Returns the order status.

payment_methods

Returns the payment methods for this order.

payment_fee

Returns the total payment fee.

shipping_methods

Returns the shipping methods for this order.

shipping_price

Returns the total shipping costs.

drop_point

Returns the customer selected drop point. This is not necessarily the same where the order was shipped to.

items

Returns the order line items.

physical_items

Returns physical (non-digital, non-bundle) order line items.

shipping_address

Returns the shipping address for this order.

billing_address

Returns the billing address for this order.

shipments

Returns the shipments for this order.

returns

Returns the returns for this order.