Difference between revisions of "Liquid Template Variables - order"
From Spiffy Stores Knowledge Base
(New page: 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 '''Preferenc...) |
|||
| Line 3: | Line 3: | ||
== <code>order_name</code> == | == <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> == | == <code>order_number</code> == | ||
| − | + | This is the number of the order. | |
== <code>customer</code> == | == <code>customer</code> == | ||
| − | Customer object containing the email and name of the | + | Returns a Customer object containing the email and name of the customer. |
== <code>customer.email</code> == | == <code>customer.email</code> == | ||
| − | + | Returns the email address of the customer. | |
== <code>customer.name</code> == | == <code>customer.name</code> == | ||
| − | + | Returns the full name of the customer. | |
== <code>shop_name</code> == | == <code>shop_name</code> == | ||
| − | + | Returns the name of your shop. | |
== <code>subtotal_price</code> == | == <code>subtotal_price</code> == | ||
| − | + | Returns the sub-total value of the order. | |
== <code>total_price</code> == | == <code>total_price</code> == | ||
| − | + | Returns the total of the order, which is the sub-total plus tax and shipping, if applicable. | |
== <code>tax_price</code> == | == <code>tax_price</code> == | ||
| − | + | Returns the amount of tax on the order. | |
| + | |||
| + | == <code>shipping_price</code> == | ||
| + | |||
| + | Returns the amount of shipping included in the order. | ||
| + | |||
| + | == <code>discount_price</code> == | ||
| + | |||
| + | Returns the amount of any dicounts that have been applied to the order. | ||
| + | |||
| + | == <code>discount_code</code> == | ||
| + | |||
| + | Returns the discount code that was used, if any. | ||
== <code>gateway</code> == | == <code>gateway</code> == | ||
| − | + | Returns the name of the payment gateway that was used. | |
== <code>shipping_method</code> == | == <code>shipping_method</code> == | ||
| − | ShippingMethod object | + | Returns a ShippingMethod object. ??? |
| − | |||
| − | |||
| − | |||
| − | |||
== <code>shipping_address</code> == | == <code>shipping_address</code> == | ||
| − | Shipping Address object | + | Returns a Shipping Address object. |
== <code>billing_address</code> == | == <code>billing_address</code> == | ||
| − | Billing Address object | + | Returns a Billing Address object. |
== <code>line_items</code> == | == <code>line_items</code> == | ||
| − | + | Returns an array of Line_Item objects. | |
== <code>note</code> == | == <code>note</code> == | ||
| − | + | Returns the note that was attached to the order. | |
== <code>attributes</code> == | == <code>attributes</code> == | ||
| − | + | Returns any attributes which where attached to the order. | |
| + | |||
| + | Example usage: | ||
| − | + | <pre>{{ attributes.gift-note }}</pre> | |
Revision as of 14:59, 14 May 2008
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"'.
Contents
order_name
The is the name of the order.
By default, the name is formatted as a hash (#) followed by the order number. For example,
#01234
order_number
This is the number of the order.
customer
Returns a Customer object containing the email and name of the customer.
customer.email
Returns the email address of the customer.
customer.name
Returns the full name of the customer.
shop_name
Returns the name of your shop.
subtotal_price
Returns the sub-total value of the order.
total_price
Returns the total of the order, which is the sub-total plus tax and shipping, if applicable.
tax_price
Returns the amount of tax on the order.
shipping_price
Returns the amount of shipping included in the order.
discount_price
Returns the amount of any dicounts that have been applied to the order.
discount_code
Returns the discount code that was used, if any.
gateway
Returns the name of the payment gateway that was used.
shipping_method
Returns a ShippingMethod object. ???
shipping_address
Returns a Shipping Address object.
billing_address
Returns a Billing Address object.
line_items
Returns an array of Line_Item objects.
note
Returns the note that was attached to the order.
attributes
Returns any attributes which where attached to the order.
Example usage:
{{ attributes.gift-note }}