$aurora_user

Array()

N/A

A Container holding all of a User's details for the currently logged-in user.

For more information regarding this data, please see the Global Template Variables article.

$store_credit_balance

Float

Selected

The Store Credit balance for the User currently logged into the site.

$user

Array()

N/A

Contain most of the $aurora_user variable and more.

More about this you can read here.

$new_user

Boolean

N/A

Indicates whether the current user has just signed-up from the Member Sign-up form or not.

This value will be TRUE the first time the Summary page is loaded after initial registration from the Members Sign-up page and then be FALSE thereafter.

$my_address

Array()

A Container holding the address that is considered by Aurora to be the User's 'current' address.

This is often simply the address used for the User's most recent Order.

$my_address.address_1

String

$my_address.address_2

String

$my_address.town

String

$my_address.postcode

String

$my_address.country_name

String

$cancelled_status

Integer

The Internal Aurora ID used to identify the ''Cancelled" Order Status, as configured in the Aurora Back-end under Orders > Statuses > Order Statuses.

This is helpful when listing recently placed orders to tell if an order has been cancelled or not.

$recent_orders

Array( $order )

An array of recently ordered items, as detailed in the $order declaration in this table.

$cancel_orders

Array( $order )

An array of recently cancelled orders, as detailed in the $ordered_item declaration in this table.

$order

Array()

A Container describing a single Order Line within a recent customer order.

$order.id

Integer

The Internal Aurora ID used to identify an Order.

$order.date_created

Date String

e.g. "2015-08-24 15:35:48".

$order.date_shipped

Date String

e.g. "2015-08-24 15:35:48".

$order.order_status

Integer

The Internal Aurora ID used to identify an Order Status.

$ordered_item.status

Array()

A Container holding the descriptive information regarding the order's current status.

$order.status.status_name

String

The Order Status' name, as configured in the Aurora Back-end under Orders > Statuses > Order Statuses.

$order.status.status_description

String

The Order Status' general description, as configured in the Aurora Back-end under Orders > Statuses > Order Statuses.

$order.status.status_name_frontend

String

The Order Status' name to be used on the Front-end, as configured in the Aurora Back-end under Orders > Statuses > Order Statuses.

$order.order_live

[ 0 or 1 ]

0 (Zero) if the order is not considered 'live' and 1 if it is.

This field is not used by all clients.

It is often used for some clients where they have a specific need for it. E.g. some clients may have Orders marked as Live in order to indicate they are ready to be sent to some 3rd party system.

$order.payment_type

String

A simple string value to describe the means by which the order was paid for, e.g. "telephone", "ebay", "card"

$order.is_phone_order

[ 0 or 1 ]

1 if Aurora believe this Order was placed over the phone and 0 (Zero) otherwise.

$order.sent_to_metapack

[ 0 or 1 ]

0 (Zero) if the order has not yet been sent to Meta Pack and 1 if it has.

$order.store_id

Integer

The Internal Aurora ID used to identify a Store Location to which the order will be shipped.

$order.sent_review_reminder

[ 0 or 1 ]

0 (Zero) if no review reminder has been sent for the order and 1 if it has.

This field is not used by all clients.

This requires a one-off configuration process to be performed by Aurora Commerce in order to have these reminders sent out at all.

$order.customer_selected_delivery_date

Date String

e.g. "2015-08-24 15:35:48".

$order.courier_id

Integer

The Internal Aurora ID used to identify a Shipping Courier.

$order.tracking_number

String

$order.vat_percentage

Float

The global Tax rate applicable to the order at the time the order was placed.

The Tax rate applied to each product in an order can differ from that of the main order, e.g. where one item is perhaps exempt from Tax, but all others are not.

$order.shipping_cost

Float

Default

The shipping cost, excluding tax.

$order.shipping_tax

Float

Default

The tax on the shipping.

$order.shipping_name

String

$order.shipping_type

Integer

The Internal Aurora ID used to identify a Shipping Method.

$order.shipping_courier

Integer

$order.order_total

Float

Default

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"

$order.order_subtotal

Float

Default

The total cost of the Items ordered, not including Shipping, Discounts or Tax.

$order.order_tax

Float

Default

The proportion of the $order_total field that is attributed to Tax.

$order.coupon_code

String

The Coupon Code that was used with the order (if any).

$order.coupon_discount

Float

Default

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.

$order.order_discount

Float

Default

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.

$order.bundle_discount

Float

Default

The total discount attributed to bundles included in the Basket.

$order.price_break_discount

Float

Default

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.

$order.loyalty_discount

Float

Default

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.

$order.shipping_discount

Float

Default

Any reductions to the Shipping Cost applied by Promotions is included here.

$order.total_discount

Float

Default

The total discount applied to the order as a result of all Promotions, Coupons, Loyalty Points and other related system.

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.

$order.loyalty_points_earned

Integer

$order.loyalty_points_used

Integer

$order.invoice_notes

String

The notes added to the order by an Administrative User in the Back-end under the Orders > View section.

$order.customer_notes

String

The notes provided by the customer at purchase.

This field is not used by all clients.

This must be added to the checkout form in the Front-end's Checkout Template if desired.

$order.is_mobile_order

[ 0 | 1 ]

Whether or not the order was placed via the Mobile Version of the site.

This does not represent whether an order was placed using a mobile device, only whether the mobile site was being used at the time, i.e. a customer using the normal site on a mobile device will still be registered as having placed a normal order and not a mobile one.

$ordered_item.date_delivery_estimate

Date String

e.g. "2015-08-24 15:35:48".

$order.custom_shipping_cost

Float

Default

The shipping cost, including Tax, applied to this order as a custom value by an Administrator.

This value can only be set using the Aurora Back-end via the Orders > New Order section.

$order.custom_shipping_label

String

The shipping label/description applied to this order as a custom value by an Administrator.

This value can only be set using the Aurora Back-end via the Orders > New Order section.

$order.refund_allowed

[ 0 or 1 ]

Whether or not the order can still be refunded.

You may wish to decide whether a refund is permitted by some other means, e.g. the age or status of an order, but this method is set by a few systems, including Meta Pack.

$order.shipping_amount

Float

Default

$order.order_total_gbp

Float

Default

$order.shipping_amount_gbp

Float

Default

$order.shipping_cost_gbp

Float

Default

$order.shipping_tax_gbp

Float

Default

$order.order_discount_gbp

Float

Default

$order.coupon_discount_gbp

Float

Default

$order.total_discount_gbp

Float

Default

$order.return_reference

String

If a return has been issued, this will hold the reference assigned to said return.

$order.order_payment

Float

Default

The total value of the order, including shipping and with discounts deducted.

$order.tracking_url

String

The tracking URL for the Shipping Method used, as configured in the Aurora Back-end under Orders > Shipping > Couriers when combined with the order's individual $tracking_code value.

$order.delivery_address

$customer_address

A Container holding the address information provided for shipping, as detailed in the $customer_address declaration in this table.

$ordered_item.invoice_address

$customer_address

A Container holding the address information provided for billing, as detailed in the $customer_address declaration in this table.

$customer_address.title

String

The is the User/Customer title, e.g. Mr, Mrs, etc.

$customer_address.firstname

String

$customer_address.lastname

String

$customer_address.address_1

String

$customer_address.address_2

String

$customer_address.town

String

$customer_address.county

String

$customer_address.postcode

String

$customer_address.country

Integer

$order.transaction

Array()

A Container holding some of the related transaction information pertaining to the payment method for with the order.

$transaction.card_number

Numeric String

This will contain the last 4 digits of the card number provided at purchase, when available and relevant.

$transaction.card_name

String

$transaction.card_expiry

MMYY

$transaction.card_type

String

$order.ordered_items

Array( $ordered_item )

An array of the recently ordered items, as detailed in this $ordered_item declaration in the table.

$ordered_item.ordered_item_id

Integer

The Internal Aurora ID used to identify an Order Item/Line.

$ordered_item.product_id

Integer

The Internal Aurora ID used to identify a Product.

$ordered_item.product_price

Float

Default

$ordered_item.product_quantity

Integer

The number of items ordered by this Basket Line.

$ordered_item.product_description

String

This is a serialised array of product details to be displayed in the basket. This can (but will not always) include any of the following:

_ Product Name (At the time the product was purchased)
_ Variation Details (Size, Colour, etc)
_ Additional Product Descriptions (Custom options selected by the customer)
_ Bundle Information (If a bundle was selected)

To extract this variable for use in Aurora Front-end Template, using the following line.

<br>{assign var='descriptions' value=$line.product_description|unserialize}<br>

$ordered_item.product_despatch_date

Date String

e.g. "2015-08-24 15:35:48".

The shipping information for each individual Order Line canary from that of the main order and even from line to line.

This can occur when orders are part-dispatched for any reason.

$ordered_item.product_price_gbp

Float

Default

$ordered_item.product

Array()

For more detail regarding the fields available within this variable,please see the Product Details article.

$ordered_item.additional_fields

Array( String )

$ordered_item.product_name

String

$ordered_item.tracking_number

String

The shipping information for each individual Order Line canary from that of the main order and even from line to line.

This can occur when orders are part-dispatched for any reason.

$ordered_item.tracking_url

String

The shipping information for each individual Order Line canary from that of the main order and even from line to line.

This can occur when orders are part-dispatched for any reason.

$ordered_item.courier_name

String

The name of the courier assign to this Order Line during dispatching.

The shipping information for each individual Order Line canary from that of the main order and even from line to line.

This can occur when orders are part-dispatched for any reason.

$minimum_order_required

Float

Minimum order of user's groups.

$order_limit

String

If isset GET variable with key 'limit' it will return the value if not it will be null