$basketReference

String

This is the Basket Reference for the current user's session.

$basket

Array [ $basket_item ]

An array of basket items for the current page.

$basket_item

Container

A container holding all of a basket items details.

$basket_item.product_id

Integer

The internal ID Aurora uses to identify a product.

$basket_item.user_ip

String

The IP of the user accessing the website.

$basket_item.user_cookie

String

The cookie value that Aurora uses to track a users presence on the website.

$basket_item.product_quantity

Integer

The quantity of the product featured on the current basket line.

$basket_item.product_price

Float

Default

The standard price of the product including applicable Tax, as listed on the Front-end.

$basket_item.product_tax

Float

Default

The tax payable on the standard price of the product.

$basket_item.basket_price

Float

Selected

The price of the product including applicable Tax, as it is featured in the basket.

The 'basket price' can differ from the standard product price for a variety of reasons, mostly involving Basket Promotions and custom product 'add-ons'.

$basket_item.basket_tax

Float

Selected

The tax payable on the basket price of the product.

$basket_item.vat_rate

Float

The rate of tax payable on the product, represented as a percentage.

$basket_item.product_discount

Float

Default

The discount applicable to this basket line in total.

This is not the discount per item, but per line.

For example, if the product quantity is 2 and the product discount is 10, then that is 5 per item to a total of 10 and not 10 per item to a total of 20.

You cannot simply calculate the discount per item by dividing the "Discount" field by the "Quantity" field as this can result in 'lost' funds in the event the total discount is not evenly (to the penny) divisible by the number of products.

For example, for a "Buy Two Get One Free" offer where the products costs £2, the discount would be £2 for the line, but theoretically £0.6666666 per item and so the price cannot be presented including discount 'per item' due to the floating point issue encountered here.

Note: Where necessary Aurora's internal systems accounts for this by listing items separately and having the last item have one entire penny more discount and all others on less, but this is not commonly required.

$basket_item.product_stock

Integer

The current stock level for the product as a whole (including all variations).

$basket_item.variation_stock

Integer

The current stock level for the specific product variation featured in the basket.

$basket_item.product

Container

A container holding all of a Product details.

$basket_item.product_fields

Array [ String ]

An array of additional fields applicable for the products featured in the current basket line.

This array is a Key/Value pairing where the Key is the 'clean' name of the field in question. These values are identical to that, which is usually available on the Product Details page, e.g. $basket_item.product_fields.colour, $basket_item.product_fields.brand, etc.

$basket_item.stock_response

Array

Contains all the stock information based on the product.

Please see the example below in the "Example Stock Response Use" section of this in use.

$basket_item.stock_response.available_stock

Integer

This is a subtraction between actual_stock + pre_order_stock.

$basket_item.stock_response.allow_purchase

Boolean

Allow the product to be purchased.

$basket_item.stock_response.allow_in_basket

Boolean

Allow the product to be in the basket.

$basket_item.stock_response.actual_stock

Integer

Actual stock of the product.

$basket_item.stock_response.pre_order_stock

Integer

Preorder stock.

$basket_item.product_bundles_data

Array

Contains all product bundles data items for the basket item.

$basket_item.bundle_name

String

Contains the item's bundle name if applicable

$errors

Array[ String ]

List of generic basket errors. Can be displayed using such code:

<br />{if $errors}<br /> <div class="errorbox"><br /> <h2>{site_text page="Global" part="Warning: Error has occurred"}</h2><br /> {foreach from = $errors item="error"}<br /> <li>{$error}</li><br /> {/foreach}<br /> </div><br />{/if}<br />

$free_shipping_spend

Float

Selected

This is how much more the visitor needs to spend before their basket will qualify for free shipping.

$free_shipping_available

[ TRUE | FALSE ]

This denotes whether free shipping is available at all.

TRUE means it is available and FALSE means it is not.

$basket_error_message

String

This error is placed when the limitation of a card and renewal cards is not to be placed in one order. The variable is translated and could be used it plain.

Example:

<br />{if $basket_error_message} <h3>{$basket_error_message}</h3>{/if}<br />

Template usage in basket/index.tpl.html.

The check is performed when one of the products (new card, renewal card) is added to Basket.

If the limitation is not met, this variable will have the translated message.