OrderDrop

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

id

Returns the order id.

order_number

Returns the order numner.

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

financial_status

Returns paid if order is paid, otherwise not_paid.

subtotal_price

Returns the subtotal.

total

Returns the total.

currency

Returns the order currency.

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