Admin: /* total_price */

2019-11-14T04:12:47Z

total_price

Admin: /* attributes (Not Currently Implemented) */

2018-08-20T05:23:10Z

attributes (Not Currently Implemented)

Admin: Created page with "This page is not yet complete. The Order variables are exported and made available to Order Confirmation emails and notifications, and to the ''Additional Content & Scripts''..."

2016-02-12T01:33:28Z

Created page with "This page is not yet complete. The Order variables are exported and made available to Order Confirmation emails and notifications, and to the ''Additional Content & Scripts''..."

New page

This page is not yet complete.

The Order variables are exported and made available to Order Confirmation emails and notifications, and to the ''Additional Content & Scripts'' section that is available under '''Preferences -> Checkout & Payment"'.

== <code>order_name</code> ==

The is the name of the order.

By default, the name is formatted as a hash (#) followed by the order number. For example,

<pre>#01234</pre>

== <code>order_number</code> ==

This is the number of the order.

<pre>1234</pre>

== <code>order_date</code> ==

This is the date of the order.

<pre>12th September, 2008</pre>

== <code>order_time</code> ==

This is the time of the order.

<pre>14:39</pre>

== <code>customer</code> ==

Returns a [[ Liquid Template Variables - customer | customer object ]] containing the email and name of the customer.

== <code>shop_name</code> ==

Returns the name of your shop.

== <code>total_price</code> ==

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.

== <code>tax_price</code> ==

Returns the total amount of tax for the order.

== <code>tax_label</code> ==

Returns the type of tax for the order.

<pre>GST</pre>

== <code>included_tax_price</code> ==

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.

== <code>shipping_price</code> ==

Returns the amount of shipping included in the order.

== <code>subtotal_price</code> ==

Returns the total amount of the order less discounts.

This amount will not include any additional taxes or shipping costs.

== <code>discounts_savings</code> ==

Returns the amount of any discounts that have been applied to the order (as a negative amount).

== <code>discount_price</code> ==

Returns the amount of any discounts that have been applied to the order.

== <code>discount_code</code> ==

Returns the discount code that was used, if any.

== <code>gateway</code> ==

Returns the name of the payment gateway that was used.

== <code>shipping_method</code> ==

Returns a the shipping method used for the order.

== <code>shipping_address</code> ==

Returns a [[ Liquid Template Variables - address | shipping address object]].

== <code>billing_address</code> ==

Returns a [[ Liquid Template Variables - address | billing address object]].

== <code>order_quantity</code> ==

Returns the total number of items in the order.

== <code>line_items</code> ==

Returns an array of Line_Item objects.

== <code>fulfilled_line_items</code> ==

Returns an array of fulfilled Line_Item objects.

== <code>unfulfilled_line_items</code> ==

Returns an array of Line_Item objects that have not been fulfilled.

== <code>note</code> ==

Returns the note that was attached to the order.

== <code>attributes</code> (Not Currently Implemented) ==

Returns any attributes which where attached to the order.

Example usage:

<pre>{{ attributes.gift-note }}</pre>

== <code>cancelled</code> ==

Returns ''true'' if the order has been cancelled.

== <code>cancelled_at</code> ==

Returns the date and time that the order was cancelled.

<pre>{{ order.cancelled_at | date: "%B %d, %Y %I:%M%p" }}</pre>

== <code>cancel_reason</code> ==

The reason the order was cancelled.

== <code> financial_status </code> ==

Returns the financial status of an order. The possible values are:

* pending
* authorized
* paid
* partially_paid
* refunded
* partially_refunded
* voided

== <code>financial_status_label</code> ==

Returns the display text for the financial status of an order. The possible values are:

* Pending
* Paid
* Partially Paid
* Cancelled

== <code>fulfillment_status</code> ==

Returns the display text for the financial status of an order. The possible values are:

* unshipped
* partial
* shipped

== <code>fulfillment_status_label</code> ==

Returns the display text for the fulfillment status of an order. The possible values are:

* Unshipped
* Partial
* Shipped

== <code>order.metafields</code> ==

Return the [[Liquid Template Variables - metafields|metafields]] for the order.

Metafields can only be managed using the Spiffy Stores API.

@@ Line 39: / Line 39: @@
 == <code>total_price</code> ==
-Returns the total of the order, which is the subtotal plus tax and shipping, if applicable.
+Returns the total of the order, which is the subtotal plus tax and shipping, if applicable, including any credits.
 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.

@@ Line 115: / Line 115: @@
 Returns the note that was attached to the order.
-== <code>attributes</code>  (Not Currently Implemented) ==
+== <code>attributes</code> ==
 Returns any attributes which where attached to the order.

Email Variable Reference - Revision history

Admin: /* total_price */

Admin: /* attributes (Not Currently Implemented) */

Admin: Created page with "This page is not yet complete. The Order variables are exported and made available to Order Confirmation emails and notifications, and to the ''Additional Content & Scripts''..."