Order Complete
This article describes all of the data available to the templates on the Order Complete page.
Overview
The purpose of this page is to inform the customer that their order has gone through, and what to do next. It should be used to:
- keep them on the site by providing links to useful areas
- upsell more items
- provide a summary of their order
- pass on data to 3rd parties to help with tracking
Tracking Currency
The tracking variables described in the "Variables available on the Order Complete page" section can be returned in one of two currencies:
- The currency the order was placed in
- Pound Sterling (GBP)
If your tracking should always pass on its values in GBP, then the "Use GBP tracking values" setting should be set in the Aurora Back-end under Store > Settings > Payment Providers. If it is not set, then the tracking values will be provided in the currency the order was place in.
Variables available on the Order Complete page
| Variable Name | Type | Currency | Description |
|---|---|---|---|
| $order | Container | Contains the Order details in the selected currency. Please see the "tracking_order" variable described below for a list of available variables. | |
| $order.payment_cost_display | String | The Order Payment Cost in the view currency at the time the order was placed. | |
| $order.total_discount_display | String | The Order Total Discount in the view currency at the time the order was placed. | |
| $order_currency | String | The currency code for the view currency at the time the order was placed. | |
| $order_charged_currency | String | The currency code for the charged currency at the time the order was placed. | |
| $order.shipping_tax_and_cost_display | Float | The Order Shipping Tax & Shipping Cost in the view currency at the time the order was placed. | |
| $order.order_total_display | Float | The Order Total in the view currency at the time the order was placed. | |
| $order_in_gbp | Container | Contains the Order details in GBP. Please see the "tracking_order" variable described below for a list of available variables. | |
| $tracking_order | Container | Contains the Order details in either the selected currency or GBP, based on the configuration of the "Use GBP tracking values" setting in the Aurora Back-end in the Store -> Settings -> Payment Providers section. | |
| $tracking_order.id | Integer | The Internal ID Aurora used to identify an Order. | |
| $tracking_order.new_customer | String Boolean | This represents whether or not Aurora believes this customer to be a new or existing customer. This is "true" if the customer is a 'new' one. | |
| $tracking_order.firstname | String | The first name given by the customer for the purposes of billing. | |
| $tracking_order.lastname | String | The last name given by the customer for the purposes of billing. | |
| $tracking_order.address_1 | String | The first line of the address given by the customer for the purposes of billing. | |
| $tracking_order.order_discount | Float | Selected | GBP | The 'Order' discount represents the amount of the discount applied to an order that can be attributed to some Basket Promotions that do not have Coupons assigned to them. |
| $tracking_order.loyalty_discount | Float | Selected | GBP | The 'Loyalty' discount represents the amount of the discount applied to an order that can be attributed to the spending of Loyalty Points to pay for an order. |
| $tracking_order.price_break_discount | Float | Selected | GBP | The 'Price Break' discount represents the amount of the discount applied to an order that can be attributed to the application of Price Breaks to an order. |
| $tracking_order.coupon_discount | Float | Selected | GBP | The 'Coupon' discount represents the amount of the discount applied to an order that can be attributed to the application of a Coupon to an order. |
| $tracking_order.shipping_discount | Float | Selected | GBP | Any reductions to the Shipping Cost applied by Promotions is included here. |
| $tracking_order.total_discount | Float | Selected | GBP | The total discount applied to the order as a result of all Promotions, Coupons, Loyalty Points and other related systems. This value does not include the discounts applied to shipping as these are dealt with by simply reducing the shipping value at the basket. To see what value was discounted in this way, please see the "shipping_discount" field. |
| $tracking_order.order_total | Float | Selected | GBP | The total value of the order without shipping or discounts. The amount paid by a customer would be "order_total" + "shipping_cost" + "shipping_tax" - "total_discounts" |
| $tracking_order.payment_cost | Float | Selected | GBP | The total value of the order, including shipping and with discounts deducted. |
| $tracking_order.shipping_cost | Float | Selected | GBP | The shipping cost, excluding tax. |
| $tracking_order.shipping_tax | Float | Selected | GBP | The tax on the shipping. |
| $tracking_ordered_items | Array [ $basket_item ] | An array of basket items for the current page. Please refer to the Basket article for further details regarding the variables available in the $basket_item Container. | |
| $ordered_items | Array [ $basket_item ] | An array of basket items for the current page. Please refer to the Basket article for further details regarding the variables available in the $basket_item Container. | |
| $ordered_items.total_discount_display | String | Selected | GBP | The item total discount amount in the view currency at the time the order was placed. |
| $ordered_items.basket_total_discount | Float | Selected | GBP | The item total discount numerical amount (no currency sign) in the view currency at the time the order was placed. |
| $ordered_items.basket_price_inc_discount_display | String | Selected | GBP | The item total minus the discount amount in the view currency at the time the order was placed. |
| $ordered_items.basket_price_display | String | Selected | GBP | The item total in the view currency at the time the order was placed. |
| $delivery_address | Container | A Container holding all of a Shipping/Delivery Address details. | |
| $delivery_address.firstname | String | The first name given by the customer for the purposes of shipping. | |
| $delivery_address.lastname | String | The last name given by the customer for the purposes of shipping. | |
| $delivery_address.address_1 | String | The first line of the address given by the customer for the purposes of shipping. | |
| $delivery_type | String | The name of the shipping/delivery method selected for the order. | |
| $estimated_delivery_time | String Date | The estimated delivery date based on the shipping service and products selected within the order, e.g. 21st July, 2015. You can decide what date format to output this in, e.g. {$estimated_delivery_time|strtotime|date:"dS F Y"} | |
| $applied_loyalty_points | Integer | The number of Loyalty Points used to discount the order. | |
| $total_loyalty_points | Integer | The number of Loyalty Points the customer currently has in total. | |
| $basket_loyalty_points | Integer | The number of Loyalty Points the customer has gained as a result of the order placed. | |
| $transaction_info | Container [ $transaction ] | This holds the available transaction details for the current order, as described by the '$transaction' array under Order Transaction Variables. | |
| $transactions | Array [ $transaction ] | An array of all successful payment transactions for the current order, as described by the '$transaction' array under Order Transaction Variables. | |
| $additional_fields | Array [ String] | A list of the Order Additional Fields names and values that were provided by the customer during checkout. |
Order Transaction Variables
| Variable Name | Type | Description |
|---|---|---|
| $transaction | Container | Contains a single transactions details. |
| $transaction.transaction_type | String | The type of transaction taken, e.g. "paypal", etc. |
| $transaction.amount | String | The transaction amount in the charged currency |
| $transaction.amount_display | String | The transaction amount in the view currency. |
| $transaction.card_type | String | The type of card used, e.g. "visa", "debit", etc. |
| $transaction.card_number | 4 Characters | The last four digits of the card number used. The whole card number is not stored by Aurora. |
| $transaction.card_name | String | The name on the card used. |
| $transaction.paypal_transaction_id | String | The PayPal transaction ID for the customers reference, if this transaction was in fact a PayPal transaction. |
| $transaction.additional_data | Array [ $additional_transaction_data ] | An array of additional fields stored against the transactions for the current order, as described by the '$additional_transaction_data' array. |
| $additional_transaction_data.field_name | String | The name of the field. |
| $additional_transaction_data.field_value | String | The value the field has been assigned. |
| $additional_transaction_data.date_created | Date (e.g. 2017-10-24T13:42:40+01:00) | The date the value was first assigned to the transaction. |
Pre-built Conversion Tracking Codes
Please see the following list of providers that the Aurora Demo site already has example integrations for:
- Google Analytics
- Google Adwords
- Webgains
- Affiliate Window
- eVisit Analyst
- LinkShare
- NexTag
- Rakuten Marketing
You can use the example templates found in the Aurora Demo templates for the above systems where relevant to begin your own Tagging integrations.
Related Aurora Demo Example Templates
example.com/checkout/order-complete.tpl.html
Updated about 1 year ago