Checkout Transfer
This guide details how to use the Aurora Checkout Transfer process.
Introduction
The Aurora checkout transfer process provides a mechanism for preloading the Aurora basket and transferring a user from a 3rd party app to Aurora in order to utilise the Aurora checkout process
Checkout Transfer
To utilise the Aurora checkout process, simply make a request to the following endpoint within the users browser session:
/checkout/transfer
The checkout transfer endpoint can be used to:
- Set the session currency
- Add one or more items to the users basket session
Request Parameters
The following request parameters are available:
| Field Name | Description |
|---|---|
| currency | Currency ISO value for the order i.e. GBP |
| item_id_X | ID for item X |
| item_sku_X | SKU for item X |
| item_ean_X | EAN for item X |
| item_quantity_X | Number of units ordered for item X |
Where the item SKU is specified, Aurora with ignore the item ID and EAN.
If no SKU is specific, Aurora will first attempt to identify the item SKU using the item EAN and ID with the following order of precedence:
- Variation EAN
- Product EAN
- Variation ID
- Product ID
When using the endpoint to add both products and variations, we recommend that item IDs are not used to identify products as these may not be unique across products and variations.
Examples
Add by product or variation reference:
/checkout/transfer?currency=GBP&item_sku_1=PROD123456&item_quantity_1=2
Add by product or variation EAN:
/checkout/transfer?currency=GBP&item_ean_1=EAN123456&item_quantity_1=1
Add by product or variation ID:
/checkout/transfer?currency=GBP&item_id_1=123456&item_quantity_1=3
Add multiple items:
/checkout/transfer?currency=GBP&item_sku_1=PROD123456&item_quantity_1=2&item_sku_2=PROD78999&item_quantity_2=3
Settings
There are several Checkout Transfer settings that can be defined within:
Aurora > Store > Settings > Frontend > Checkout Transfer
| Setting Name | Description | Default |
|---|---|---|
| Order Source | The order source to be used for orders created via the checkout transfer process. The order source will not be used where no checkout transfer cookie details are defined. | Checkout Transfer |
| Cookie Name | The cookie name to be set when the checkout transfer process is used. No cookie will be set if there is no name defined. | |
| Cookie Value | The cookie value to be set when the checkout transfer process is used. |
Updated over 2 years ago