Child pages
  • Gift Card/Certificate
Skip to end of metadata
Go to start of metadata

Gift Card/Certificate

Extension page: http://ecommerce.aheadworks.com/magento-extensions/gift-card-certificate.html


The Gift Card/Certificate extension enables customers to buy gift certificates and send them to friends via e-mail.

Installation

1. Backup your web directory and store database.

 Click to view details

You can make backup copies with any tool you find appropriate

If you are going to use the native Magento backup function, navigate to System -> Tools -> Backups and perform System and Database backups

 2. Log in to the Magento backend

 3. Disable compilation

 Click to view details

Navigate to System -> Tools -> Compilation.

If Compiler status is Disabled, you can skip to the next step

If Compiler is enabled, disable it.

IMPORTANT: after the extension is installed, you can enable the compilation again; IT IS CRUCIAL that you use "Run Compilation Process" function, not just "Enable button"

Icon

Installing an extension with the Compilation enabled will result in store downtime.

 4. Flush store cache

 Click to view details

You can flush the store cache in 2 ways:

  • via the backend:

Navigate to System -> Cache Management menu, and click Flush Magento Cache button

  • via filesystem:

On your server, navigate to Magento root folder, then proceed to /var/cache/; delete all the content there.

 5. Download the extension package from your account and extract the downloaded archive

 6. Copy the content of /Step_1/ folder to your store's root directory

If you are using a custom theme,

Icon
 read the instructions here.

The extension comes with 2 design packages: /base/default/ and /rwd/default/ .

In case you are using a custom theme, it is recommended to copy the design files to your current theme's folders. In case there are several themes in use at the same store, the design files must be copied to each of them.

  • Find this folder in the package: /step_1/app/design/frontend/base/default/ ; copy its content to /app/design/frontend/[your_package]/[your_theme]/
  • Find this folder in the package: /step_1/skin/frontend/base/default/ ; copy its content to /skin/frontend/[your_package]/[your_theme]/

 7. Copy the content of /Step_2/ folder to your store's root directory

 8. Flush store cache again; log out from the backend and log in again.

Zero Checkout

Providing you want to let your customers to checkout solely with gift card balance (paying for the whole order with the gift card) the Zero Subtotal Checkout should be enabled.

To enable Zero Subtotal Checkout navigate to your Magento backend System > Configuration > Sales> Payment Methods > Zero Subtotal Checkout and set 'Enabled' field to 'Yes'.

Now your customer can checkout with the gift card balance solely.


Configuration

You can configure the extension's general settings in  System-> Configuration-> aheadWorks Extensions-> Gift Card (or, Customers-> Gift Cards-> Settings).

General Settings tab:

Enabled - defines if the Gift Card/Certificate extension should be enabled for particular store view;

Expires After (Days) - defines the general expiration period for the gift cards. Note, this option can be overriden in Gift Card product settings;

Allow Gift Message - this option can be overriden in Gift Card product settings;

Display Email Delivery Date - defines if customers will have an opportunity to schedule the Gift Card sending date;

Refund Processing - defines how the refund is handled in case a Gift Card was used on an order. There are 3 supported scenarios:

    • Disabled - if an order is refunded, the Gift Card amount is not returned to the balance;
    • Amount on Gift Card first - the amount is returned to the Gift Card balance in full, the remaining refund amount is returned in currency;
    • Other Amounts First - the currency amounts are returned in full, the remaining refund amount is added back to the Gift Card balance.

Coupon Code Settings tab:

In this tab you can configure the Gift Card code format. Note, the extension generates all the Card Codes automatically, per options below:

Code Length - defines the number of characters in the generated Gift Card codes (Excluding prefix, suffix and separators);

Code Format - Alphabetical / Numeric/ Alphanumeric;

Code Prefix - inserted before the generated code;

Code Suffix - added after the generated code;

Code Separator - the character that will be used as a code separator. Note: Space character is not allowed;

Insert Separator Every X Characters - defines the number of characters split by the Code Separator.


Email Settings tab:

In this tab, you can select the notifications Sender , and the Notification Template.

More notification templates can created under System > Transactional Emails.


Creating a Gift Card product

The extension adds a new product type (AW Gift Card).

Creating products of that type is mostly similar to setting up a standard Simple items, see below for details on extension-specific options.

 

Edit Product-> Prices screen:

Amounts - here, you can create a number of pre-defined gift card amounts. You can also define a Website for each of these amounts.

Allow Open Amount = Yes/No - besides the pre-defined Gift Card values, the extension allows purchasing cards with custom (user-defined) values. This option enables/ disables such possibility for a given Card item.

The range of allowed custom values can be controlled via Open Amount Min Value and Open Amount Max Value options.


Edit Product-> Gift Card Information screen:

Card Type - this option defines the card type:

  • Virtual - the card code is delivered via email;
  • Physical - the card is supposed to be a physical product shipped to a recipient. No email notification will be sent;
  • Combined - the card is a physical product, doubled with an email notification.

The Expires After (days)Allow Message, Display Email Delivery Date and Email Template options are duplicates of the correspondent General Settings options, and allow overriding the general configuration for a given Card item.


Gift Card import/export

Exporting gift cards

Gift Card/Certificate extension introduces gift card import/export functionality.

The list of all the gift cards available at the store can be exported from the Customers > Gift Cards > Manage Gift Cards section.

The list of the gift cards can be exported to both CSV and XML lists depending on the store administrator preferences.

The exported list of the gift cards will have the following gift card information available: Code, Website, Created At, Expiration Date, Active, Status, Balance, Sender Name, Sender Email, Recipient Name, Recipient Email, Message, Email Delivery Date.

Icon
 Click to see how the CSV file contents...

The first line is the header.

The second line is the actual gift card code with all the necessary data filled in.

Importing gift cards

The list of the gift cards can be imported from the Customers > Gift Cards > Import Gift Cards section.

 

Icon

When importing a list of gift cards consider the following:

  • The gift cards can only be imported from the CSV file;
  • The CSV file MUST have the same format as the list of exported gift cards (first line - header, the second and the following are the gift card codes, the gift card attributes must come in the same order);
  • If the gift cards you import do not have all the information necessary to fill in all 13 gift card attributes - leave empty quotes ("") in place of the attribute missing;
  • The dates in the list you are importing must be of the backend locale format (for example: Nov 19, 2015 for English locale, but 19.11.2015 for Deutsch locale);
  • If the gift card code in the import list already exists at the store none of it's attributes will be overwritten;

 


Managing Gift Cards

You can manage the existent gift cards, and even manually create new ones*, via Customers-> Gift Cards-> Manage Gift Cards grid.

Here, you can track the status of all the existent cards, and update any of them (update balance, expiration date, check updates history).

*NOTE: if you are creating a new Gift Card through the grid, the Card Code will be generated automatically after you specify the required values and save the card.


Using CMS

By default, the Gift Card application form is placed in the Shopping Cart screen. You can also call this form in other positions via CMS. The code should look like this:


 

Uninstallation 

1. Disable compilation, in case it is enabled.

2. Login to your FTP, navigate to app/etc/modules/

3. Open the file AW_Giftcard.xml and change the following line: 

from

to

Now your Magento is unaware of the existence of the extension.

4.Clear the cache under var/cache

5.Make sure that the site is working properly, otherwise roll back the changes and apply to our technical support.

6. To clean the database, backup your database and then run the following queries in MySQL: 

Icon
 Click to see how to do this

Executing the above queries will remove all the module's DB records, and convert the existent Gift Card products to Simple items.

Note, if you are using the table with prefixes, you must specify them in all table names. 

If you are not sure how to do that or expect any troubles with it, please contact your server administrator regarding the matter.
If you remove the tables as it is described above, you will need to re-configure the extension after it is re-installed. All transactions history will be lost as well.


7. If everything works fine, it is safe to delete the files of the extension.

Troubleshooting


After the extension installation the store gives an error, or blank page, or suggests to start Magento installation procedure.

Change the owner of the extracted extension files to the web server user and set 775 permissions on them. Clear the store cache and try again.


There is no aheadWorks extensions under my configuration section, or having the extension tab clicked I get a blank page, or Access Denied error.

Clear the store cache, browser cookies, logout and login again.

I've set up everything correctly, inserted the HTML code but there is nothing on that page.

Clear the store cache, clear your browser cache and domain cookies and refresh the page.

My configuration changes do not appear on the store.

 Clear the store cache, clear your browser cache and domain cookies and refresh the page.



You can always find the latest version of the software, full documentation, demos, screenshots and reviews at http://ecommerce.aheadworks.com
License agreement: http://ecommerce.aheadworks.com/LICENSE-M1.txt
Contact us: http://ecommerce.aheadworks.com/contacts/
Copyright © 2015 aheadWorks  http://www.aheadworks.com

  • No labels