getBasketInfo

Overview

Permission Required: None

Method Call: /ajax/Ajax_Basket/getBasketInfo

Aurora Demo Example URL: https://demo.auroracommerce.com/

Aurora Demo Example JavaScript:

• templates/example.com/_js/productdetails.js

📘

The getBasketInfo method allows you to fetch a summary of the Basket's values (cost, item count, etc).

Method Description

Request Parameters

None 

Response Variables

getBasketDetails

Overview

Permission Required: None

Method Call: /ajax/Ajax_Basket/getBasketDetails

Aurora Demo Example URL: https://demo.auroracommerce.com/

Aurora Demo Example JavaScript:

• templates/example.com/_js/basket.js

Related Aurora Demo Templates:

• templates/example.com/basket/basket.tpl.html

📘

The getBasketDetails method allow you to:

• Remove an item from the basket.
• Fetch the current basket contents using a dedicated Front-end template for it's presentation (basket/basket.tpl.html).
• Get the list of currently available shipping options/methods.
• Update the visitor's shipping settings.

Setting the Shipping Methods

Getting the Available Shipping Methods

Before you can chose a shipping method, you must first find all of the available ones to present to the customer. These methods can be found using this endpoint and looking to the contents of the "delivery_options" return variable.

This variable will contain an array of all available shipping options based on the user's current basket and settings. This accounts for all of the supported matrix, such as total order value, weight, dimensions and more.

👍

If this variable contains only a single shipping option, then it is suggested that you simply auto-select this for the customer and avoid even presenting them with a choice as there is none to make.

This kind of flow is often used for services like Collect+ and Click & Collect, where there are no options for the customer to consider (other than the desire to use said service in the first place).

🚧

If you omit the delivery_option parameter completely, Aurora will attempt to default this for you, but this may not always result in the desired behaviour, if (for example) there are multiple possible options to be selected from (in this case Aurora will simply select the first). Due to this, it is suggested you provide this value.

Home Delivery

To tell Aurora that the customer wishes to use a home delivery service, call this endpoint as demonstrated below.

/ajax/Ajax_Basket/getBasketDetails?shipping_country=1&delivery_option=33&delivery_type=home

🚧

The delivery_option of 33 is an example and should be a shipping rule ID, as configured for "Home Delivery" under Aurora's Shipping Rules.

Collect in Store (also called 'Click and Collect' or 'Pay and Collect') Delivery

To tell Aurora that the customer wishes to use a Click and Collect delivery service, call this endpoint as demonstrated below.

/ajax/Ajax_Basket/getBasketDetails?shipping_country=1&delivery_option=66&delivery_type=store&delivery_store_type=physical&collect_in_store=1&store_id=71&delivery_store_id=71

🚧

The delivery_option of 66 is an example and should be a shipping rule ID, as configured for "Pay and Collect" under Aurora's Shipping Rules.

The store_id must be a valid Store ID from the Aurora Back-end, as configured under Orders > Shipping > Stores.

Reserve and Collect Delivery

To tell Aurora that the customer wishes to use a Reserve and Collect delivery service, call this endpoint as demonstrated below.

/ajax/Ajax_Basket/getBasketDetails?shipping_country=1&delivery_option=77&delivery_type=reserve_and_collect&delivery_store_type=physical&store_id=71&delivery_store_id=71

🚧

The delivery_option of 77 is an example and should be a shipping rule ID, as configured for "Reserve and Collect" under Aurora's Shipping Rules.

The store_id must be a valid Store ID from the Aurora Back-end, as configured under Orders > Shipping > Stores.

Collect+ (Collect Plus) Delivery

To tell Aurora that the customer wishes to use a Collect+ delivery service, call this endpoint as demonstrated below.

/ajax/Ajax_Basket/getBasketDetails?shipping_country=1&delivery_option=55&delivery_type=collect_plus&collect_plus_delivery=1

🚧

The delivery_option of 55 is an example and should be a shipping rule ID, as configured for "Collect Plus" under Aurora's Shipping Rules.

Method Description

Request Parameters

Response Variables

The data returned by the getDropdownBasket method is contained within an indexed array. The table below details what is held in each of the array elements by their index value.

getDropdownBasket

Overview

Permission Required: None

Method Call: /ajax/Ajax_Basket/getDropdownBasket

Aurora Demo Example URL: https://demo.auroracommerce.com/

Aurora Demo Example JavaScript:

• templates/example.com/_js/generic.js

Related Aurora Demo Templates:

• templates/example.com/basket/dropdownbasket.tpl.html

📘

The getDropdownBasket method allow you to:

- remove an item from the basket.
- fetch the current basket contents using a dedicated Front-end template for it's presentation (basket/dropdownbasket.tpl.html).

Method Description

Request Parameters

Response Variables

The data returned by the getDropdownBasket method is contained within an indexed array. The table below details what is held in each of the array elements by their index value.

showLoyaltyPoints

Overview

Permission Required: None

Method Call: /ajax/Ajax_Basket/showLoyaltyPoints

Aurora Demo Example URL: https://demo.auroracommerce.com/

Aurora Demo Example JavaScript:

• templates/example.com/_js/basket.js

Related Aurora Demo Templates:

• templates/example.com/basket/ajax-loyalty-points.tpl.html

📘

The showLoyaltyPoints method allow you to fetch the Loyalty Points information for the current User using a dedicated Front-end template for it's presentation (basket/ajax-loyalty-points.tpl.html).

Method Description

Request Parameters

None

Response Variables

The data returned by the showLoyaltyPoints method is plain HTML content and is not JSON Encoded in any way. The return data can simply be used directly in a page for presentation of the current User's Loyalty Point information, as described by the 'basket/ajax-loyalty-points.tpl.html' Front-end Template.

addToBasket

Overview

Permission Required: None

Method Call: /ajax/Ajax_Basket/addToBasket

Aurora Demo Example URL: https://demo.auroracommerce.com/

Aurora Demo Example JavaScript:

• None

 Related Aurora Demo Templates:

• None

📘

The addToBasket method allow you to:

- Add an item to the basket
- Update item quantity if the item is already in the basket

Method Description

Request Parameters

Response Variables

The data returned by the addToBasket method is always 1

addToBasketDropdown

Overview

Permission Required: None

Method Call: /ajax/Ajax_Basket/addToBasketDropdown

Aurora Demo Example URL: https://demo.auroracommerce.com/

Aurora Demo Example JavaScript:

• None

 Related Aurora Demo Templates:

• None

📘

The addToBasketDropdown method allows you to:

• Add an item/items to the basket
• Add variations of an item to the basket
• Add bundles to the basket
• Retrieve the rendered basket dropdown template contents

Method Description

Request Parameters

Response Variables

The data returned by the addToBasketDropdown method is contained within an indexed array. The table below details what is held in each of the array elements by their index value.

Example Usage

The following requests can be performed on https://demo.auroracommerce.com with the products set up in that environment.

Add single product

📘

Please note that you can also use the array syntax under Add multiple products/Add multiple variations to add a single product/variation.

$.post('/ajax/Ajax_Basket/addToBasketDropdown', {
  'all_fields': ''
    + 'product_id=32602&'   // Silver And Navy Stud Earrings
 // + 'product_quantity=2&' // Optionally provide quantity
}).then(() => { window.location.replace('/basket') });

Add multiple products

$.post('/ajax/Ajax_Basket/addToBasketDropdown', {
  'all_fields': ''
    + 'product_id[]=32602&'        // Silver And Navy Stud Earrings
    + 'product_id[]=32603&'        // Silver And Navy Jewel Necklace
 // + 'product_quantity[32602]=2&' // Optional quantity for earrings
 // + 'product_quantity[32603]=2&' // Optional quantity for necklace
}).then(() => { window.location.replace('/basket') });

Add single variation

$.post('/ajax/Ajax_Basket/addToBasketDropdown', {
  'all_fields': ''
    + 'variation_id=5379&'  // Black Cord Button Pinafore Dress - Size 6
 // + 'product_quantity=2&' // Optionally provide quantity
}).then(() => { window.location.replace('/basket') });

Add multiple variations

$.post('/ajax/Ajax_Basket/addToBasketDropdown', {
  'all_fields': ''
    + 'variation_id[5379]=3&' // Black Cord Button Pinafore Dress - Size 6 - Qty 3
    + 'variation_id[5368]=1&' // Bottle Green Bodycon Dress - Size 8 - Qty 1
}).then(() => { window.location.replace('/basket') });

Add multiple products and variations

$.post('/ajax/Ajax_Basket/addToBasketDropdown', {
  'all_fields': ''
    + 'product_id[]=32602&'        // Silver And Navy Stud Earrings
    + 'product_id[]=32603&'        // Silver And Navy Jewel Necklace
    + 'product_quantity[32603]=2&' // Qty 2 of Necklace
    + 'variation_id[5379]=3&'      // Black Cord Button Pinafore Dress - Size 6 - Qty 3
    + 'variation_id[5368]=1&'      // Bottle Green Bodycon Dress - Size 8 - Qty 1
}).then(() => { window.location.replace('/basket') });

Add a bundle

📘

Note that you cannot add multiple products or variations when adding a bundle. These must take place across two requests.

$.post('/ajax/Ajax_Basket/addToBasketDropdown', {
  'all_fields': ''
    + 'product_id=32602&'           // The main bundle product ID
    + 'bundle_id=51&'               // The bundle ID
    + 'bundle_product_ids[]=32602&' // List the bundle products
    + 'bundle_product_ids[]=32603&' // ...
}).then(() => { window.location.replace('/basket') });