Members: Store Credit
The Store Credit feature is used to apply credit to customer accounts, which can then be redeemed by them when making future purchases on your store.
This article describes the features available to you in the Member's area of Aurora for use with Store Credit.
If you are looking for more information on how to use Store Credit in Aurora, please see the Store Credit support article.
Introduction
The Store Credit feature is used to apply credit to customer accounts, which can then be redeemed by them when making future purchases on your store. The Member's Store Credit page is available only to logged in users and displays the Credit Note history (funds added and spent on the account) for a User.
This page can be navigated to as follows: My Account > Store Credit.
Where to access the Store Credit Page
Please see the example provided by the Aurora Demo Store below:
https://demo.auroracommerce.com/members/store-credit
Where to find the Store Credit Page Templates
The template that should be used to control the content of the Store Credit Page should be placed into your template directory and named as follows:
templates/your-template-dir/members/store-credit.tpl.html
Variables available in the Store Credit page
The following is a list of variables that can be accessed by the Aurora Front-end Templates.
| Variable name | Type | Description |
|---|---|---|
| $pageType | Array ( String ) | Determine the main area of the site you are on. Please refer to Global Template Variables article for more information. |
| $tracking | Array ( String ) | An array of Affiliate and Traffic Tracking Codes to the Aurora Front-end. |
| $credit_notes | Array ( $credit_note ) | An array of Credit Notes. |
| $store_credit_balance | Float | The sum of all credit notes' amounts. |
| $credit_note | Container | An array containing the details for a single Credit Note. |
| $credit_note.id | Int | The Internal Unique ID of the Credit Note. |
| $credit_note.user_id | Int | The Internal Unique ID of the User to whom the notes belong. |
| $credit_note.order_id | Int | The Internal Unique ID of the Order related to the Credit Note. |
| $credit_note.note_reference | String | |
| $credit_note.note_description | String | Short description of the Credit Note. |
| $credit_note.note_amount | Decimal | The amount of the Credit Note. |
| $credit_note.currency_id | Int | The Internal Unique ID of the Currency related to the Credit Note. |
| $credit_note.exchange_rate | Float | The exchange rate from the Default Currency to the Display Currency the Credit Note was issued in. |
| $credit_note.date_created | String | The date on which the note was created. Example "2015-05-22 14:32:00". |
| $credit_note.admin_name | String | Name of the administrator who created the note in format "FirstName LastName". |
Updated over 2 years ago