QuillObjects
Order
The order object for confirmation pages, email templates, and customer account history.
The order object holds a completed purchase with its line items, totals, addresses, and payment details. It is available on the order confirmation page, in email notification templates, and inside the customer.orders array when a customer is logged in.
<h1>Order {{ order.name }}</h1>
<p>Placed on {{ order.created_at | date: '%d %B %Y' }}</p>Core properties
| Property | Type | Description |
|---|---|---|
order.id | number | The unique order ID |
order.order_number | number | The order number (e.g. 1042) |
order.name | string | The display name (e.g. #1042) |
order.email | string | The email address on the order |
order.created_at | string | When the order was placed |
order.currency | string | Three-letter currency code |
order.note | string | Customer note left at checkout |
order.tags | array | Tags assigned to this order |
order.cancelled | boolean | Whether the order has been cancelled |
order.cancelled_at | string | When it was cancelled (nil if not cancelled) |
order.cancel_reason | string | The reason given for cancellation |
Financial properties
All prices are in the smallest currency unit. Use the money filter to display them.
| Property | Type | Description |
|---|---|---|
order.total_price | number | The final total including tax and shipping |
order.subtotal_price | number | Total before tax and shipping |
order.total_tax | number | Total tax amount |
order.total_discounts | number | Total discount amount |
order.total_shipping | number | Shipping cost |
order.gift_card_amount | number | Amount paid by gift card |
order.refund_amount | number | Amount refunded, if any |
order.financial_status | string | Payment status (see below) |
Financial status values: pending, authorized, paid, partially_paid, refunded, partially_refunded, voided.
<p>Subtotal: {{ order.subtotal_price | money }}</p>
<p>Shipping: {{ order.total_shipping | money }}</p>
<p>Tax: {{ order.total_tax | money }}</p>
{% if order.gift_card_amount > 0 %}
<p>Gift card: -{{ order.gift_card_amount | money }}</p>
{% endif %}
<p>Total: {{ order.total_price | money }}</p>Fulfillment
| Property | Type | Description |
|---|---|---|
order.fulfillment_status | string | Current status: unfulfilled, partial, fulfilled, restocked |
order.shipping_method | object | The chosen shipping method |
order.shipping_method.name | string | Name of the shipping method |
{% case order.fulfillment_status %}
{% when 'fulfilled' %}
<span class="badge badge--success">Shipped</span>
{% when 'partial' %}
<span class="badge badge--warning">Partially Shipped</span>
{% else %}
<span class="badge">Processing</span>
{% endcase %}Line items
The order.line_items array contains every product in the order:
| Property | Type | Description |
|---|---|---|
item.product_id | number | The product ID |
item.variant_id | number | The variant ID |
item.title | string | Product title |
item.variant_title | string | Variant title (e.g. "Large / Black") |
item.sku | string | SKU code |
item.quantity | number | Number of units ordered |
item.price | number | Unit price |
item.line_price | number | Price times quantity |
item.total_discount | number | Discount on this line item |
item.image | string | Product image URL |
item.url | string | Link to the product page |
{% for item in order.line_items %}
<div class="order-item">
{% if item.image %}
<img src="{{ item.image | img_url: '100x100' }}" alt="{{ item.title }}" />
{% endif %}
<div>
<p>{{ item.title }}</p>
{% if item.variant_title %}
<p class="variant">{{ item.variant_title }}</p>
{% endif %}
<p>{{ item.quantity }} x {{ item.price | money }}</p>
</div>
</div>
{% endfor %}Addresses
| Property | Type | Description |
|---|---|---|
order.shipping_address | address | Where the order is being shipped |
order.billing_address | address | The billing address |
Each address has the same fields as the Address object: first_name, last_name, name, company, address1, address2, city, province, zip, country, country_code, and phone.
<h3>Ship to</h3>
<p>
{{ order.shipping_address.first_name }} {{ order.shipping_address.last_name }}<br />
{{ order.shipping_address.address1 }}<br />
{{ order.shipping_address.city }}, {{ order.shipping_address.zip }}<br />
{{ order.shipping_address.country }}
</p>Discounts
| Property | Type | Description |
|---|---|---|
order.discount_codes | array | Discount codes applied to the order |
Each discount code has code, amount, and type:
{% for discount in order.discount_codes %}
<p>Discount: {{ discount.code }} ({{ discount.amount | money }} off)</p>
{% endfor %}Tax lines
| Property | Type | Description |
|---|---|---|
order.tax_lines | array | Tax breakdown by rate |
Each tax line has title, price, rate, and rate_percentage:
{% for tax in order.tax_lines %}
<p>{{ tax.title }} ({{ tax.rate_percentage }}%): {{ tax.price | money }}</p>
{% endfor %}Transactions
| Property | Type | Description |
|---|---|---|
order.transactions | array | Payment transactions on this order |
Each transaction has id, amount, status, provider, kind, and created_at:
{% for txn in order.transactions %}
<p>{{ txn.kind | capitalize }}: {{ txn.amount | money }} via {{ txn.provider }}</p>
{% endfor %}Channel and region
| Property | Type | Description |
|---|---|---|
order.channel | string | The sales channel this order came from |
order.region | string | The region the customer ordered from |
Customer
| Property | Type | Description |
|---|---|---|
order.customer | customer | The customer who placed the order |
{% if order.customer %}
<p>Order by {{ order.customer.name }} ({{ order.customer.email }})</p>
{% endif %}