Order
The order object describes a placed order, including its customer, line items, addresses, status, and pricing details.
Usage Example
{%- comment -%} Show order summary {%- endcomment -%}
<p>Order #{{ order.order_number }}<br>
Status: {{ order.order_status }}<br>
Total: {{ order.total }}</p>
{%- comment -%} List order line items {%- endcomment -%}
<ul>
{% for item in order.items %}
<li>{{ item.title }} × {{ item.quantity }}</li>
{% endfor %}
</ul>Properties
billing_address
Returns the billing address for this order.
created_at
Date when this order was created.
customer
Customer linked to this order if any.
customer_note
Returns the customer note.
discounts
Order discount lines.
drop_point
Returns the customer selected drop point. This is not necessarily the same where the order was shipped to.
financial_status
Returns paid if order is paid, otherwise not_paid.
id
Returns the order id.
is_cancelled
Returns true if this order was cancelled.
is_fulfilled
Returns true if order is fulfilled.
is_shipped
Returns true if order is shipped.
items
Returns the order line items.
num_items
Returns the amount of line items in this order.
order_number
Returns the order number.
order_status
Returns the order status.
payment_fee
Returns the total payment fee.
payment_methods
Returns the payment methods for this order.
physical_items
Returns the order line items.
receipt_url
Returns the link for the receipt.
reference_number
Returns the reference.
returns
Returns the returns for this order.
shipments
Returns the shipments for this order.
shipping_address
Returns the shipping address for this order.
shipping_methods
Returns the shipping methods for this order.
shipping_price
Returns the total shipping costs.
subtotal_price
Returns the subtotal.
tags
Order tags.
tax_lines
Returns the tax lines.
total
Returns the total.
total_net_price
Returns the net total.
total_tax
Returns the total tax.