Difference between revisions of "Liquid Template Variables - order"
From Spiffy Stores Knowledge Base
m |
|||
| Line 256: | Line 256: | ||
Returns the note that was attached to the order. | Returns the note that was attached to the order. | ||
| − | == <code>order.attributes</code> | + | == <code>order.attributes</code> == |
| − | Returns any attributes which where attached to the order. | + | Returns any attributes which where attached to the order when it was created. |
| + | |||
| + | Each of the keys refers to the unique name that was specified cart form input field that was created in the '''Cart.liquid''' template. | ||
| + | |||
| + | See the [[Asking your customer for additional information#Cart_Attributes|Cart Attributes]] section. | ||
Example usage: | Example usage: | ||
| − | <pre>{{ order.attributes. | + | <pre> |
| + | {{ order.attributes.gift_note }} | ||
| + | {{ order.attributes.child_name }} | ||
| + | </pre> | ||
| + | |||
| + | All of the attributes can also be enumerated, providing both the key and the value for each attribute. | ||
| + | |||
| + | <pre> | ||
| + | {% for attribute in order.attributes %} | ||
| + | <p> Key: {{ attribute.first }} - Value: {{ attribute.last }}</p> | ||
| + | {% endfor %} | ||
| + | </pre> | ||
== <code>order.metafields</code> == | == <code>order.metafields</code> == | ||
Revision as of 11:22, 19 August 2018
The Liquid template variable order has the following attributes:
Contents
- 1 order.id
- 2 order.customer
- 3 order.email
- 4 order.currency
- 5 order.credit
- 6 order.cancelled
- 7 order.cancelled_at
- 8 order.cancel_reason
- 9 order.cancel_reason_label
- 10 order.created_at
- 11 order.customer_url
- 12 order.discounts
- 13 order.discount_price
- 14 order.financial_status
- 15 order.financial_status_label
- 16 order.fulfilment_status
- 17 order.fulfilment_status_label
- 18 order.line_items
- 19 order.name
- 20 order.order_number
- 21 order.shipping_address
- 22 order.billing_address
- 23 order.shipping_methods
- 24 order.shipping_price
- 25 order.subtotal_price
- 26 order.taxes_included
- 27 order.tax_lines
- 28 order.tax_price
- 29 order.included_tax_price
- 30 order.total_price
- 31 order.surcharge_price
- 32 order.surcharge_rate
- 33 order.surcharge_description
- 34 order.transactions
- 35 order.unique_gateway
- 36 gateway
- 37 shipping_method
- 38 order_quantity
- 39 line_items
- 40 fulfilled_line_items
- 41 unfulfilled_line_items
- 42 order.note
- 43 order.attributes
- 44 order.metafields
- 45 Further Reference
order.id
Returns the unique internal number of the order.
This is normally only for internal usage.
order.customer
Return the customer who placed this order.
order.email
Returns the email address associated with the order.
order.currency
Return the currency used for this order.
{{ order.currency }} => 'AUD'
order.credit
Return the amount of credit that has been applied to this order from the customer's account credit.
order.cancelled
Returns true if the order has been cancelled.
order.cancelled_at
Returns the date and time that the order was cancelled.
{{ order.cancelled_at | date: "%B %d, %Y %I:%M%p" }}
order.cancel_reason
Returns one of the following cancellation reasons, if the order was cancelled.
- Customer changed/cancelled order
- Items unavailable
- Fraudulent order
- Other
order.cancel_reason_label
Returns one of the following cancellation reasons, if the order was cancelled.
- Customer changed/cancelled order
- Items unavailable
- Fraudulent order
- Other
order.created_at
Returns the date and time that the order was created.
{{ order.created_at | date: "%B %d, %Y %I:%M%p" }}
order.customer_url
Returns the URL of the customer's account page.
{{ order.name | link_to: order.customer_url }}
=>
http://mystore.spiffystores.com/customers/account/orders/cd260181d310e4b13669872e54e76da8
order.discounts
Returns an array of discounts that have been applied to this order.
{% for discount in order.discounts %}
Code: {{ discount.code }}
Savings: {{ discount.savings | money }}
{% endfor %}
=>
Code: SELLOUT10
Savings: $45.50
order.discount_price
Returns the total amount of discounts that have been applied to this order.
order.financial_status
Returns the financial status of an order. The possible values are:
- pending
- authorized
- paid
- partially_paid
- refunded
- partially_refunded
- voided
order.financial_status_label
Returns the display text for the financial status of an order. The possible values are:
- Pending
- Paid
- Partially Paid
- Cancelled
order.fulfilment_status
Returns the display text for the financial status of an order. The possible values are:
- unshipped
- partial
- shipped
order.fulfilment_status_label
Returns the display text for the fulfillment status of an order. The possible values are:
- Unshipped
- Partial
- Shipped
order.line_items
order.name
Returns the name of the order using the format set in the Standards & formats section of the Preferences settings of your Spiffy Stores toolbox.
{{ order.name }} => #100234
order.order_number
This is the number of the order.
{{ order.order_number }} => 1234
order.shipping_address
Returns the shipping address of the order.
order.billing_address
Returns the billing address of the order.
order.shipping_methods
order.shipping_price
Returns the amount of shipping included in the order.
order.subtotal_price
Returns the total amount of the order less discounts.
This amount will not include any additional taxes or shipping costs.
order.taxes_included
order.tax_lines
Returns an array of tax_line objects for the order.
{% for tax_line in order.tax_lines %}
Tax ({{ tax_line.title }} {{ tax_line.rate | times: 100 }}%): {{ tax_line.price | money }}
{% endfor %}
=>
Tax (GST 10.0%): $25
order.tax_price
Returns the total amount of tax for the order.
order.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.
order.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.
order.surcharge_price
Returns the amount of any payment surcharges that have been applied to this order.
order.surcharge_rate
Returns the payment surcharge rate that has been applied to the order.
{{ order.surcharge_rate }} => 0.025
order.surcharge_description
Returns a description of the payment surcharge that has been applied to this order.
{{ order.surcharge_description }} => 'Surcharge on payment by Visa card (1.0%)'
order.transactions
order.unique_gateway
gateway
Returns the name of the payment gateway that was used.
shipping_method
Returns a the shipping method used for the order.
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.
order.note
Returns the note that was attached to the order.
order.attributes
Returns any attributes which where attached to the order when it was created.
Each of the keys refers to the unique name that was specified cart form input field that was created in the Cart.liquid template.
See the Cart Attributes section.
Example usage:
{{ order.attributes.gift_note }}
{{ order.attributes.child_name }}
All of the attributes can also be enumerated, providing both the key and the value for each attribute.
{% for attribute in order.attributes %}
<p> Key: {{ attribute.first }} - Value: {{ attribute.last }}</p>
{% endfor %}
order.metafields
Return the metafields for the order.
Metafields can only be managed using the Spiffy Stores API.