User Tools

Site Tools


Sidebar

magento_2:gift_card

For more details see how the Gift Card for Magento 2 extension works.

Guide for Gift Card for Magento 2

Enable customers to buy gift cards and send them to friends via email or by post. Create an unlimited number of gift cards with different pricing models and easily keep track of all purchased certificates.

  • Create gift cards with fixed or open amount price types
  • Easily generate and upload gift codes
  • Send gift certificates via email or post office
  • Keep track of all purchased gift cards
  • Offer stunning gift card templates
  • API support
  • GraphQL compatibility

The module easily solves the gifting dilemma by offering specially designed gift certificates which can be sent to recipients via email or by post. Once the certificate is purchased, a unique code with a custom greeting message will be sent to the addressee. The module lets admin users create gift card products with different pricing types, use predefined card images or upload their own ones and helps them to keep track of all purchased gift certificates.


How do gift cards work?

  • Gift card is an alphanumeric code, consisting of letters and numbers, like BIRTHDAY_DF627. It can be applied at the cart/checkout to cover the order total
  • These codes are groped in code pools: Birthday cards, Christmas cards, etc. You can name them as you want. Before selling gift cards, you need to create a code pool for your campaign
  • In the catalog, gift card is represented as a custom product type. A customer can buy this product and get the code. You can allow customers to use gift cards they bought for themselves
  • Gift card is always linked to the code pool. Code pool should be generated first, then a product is linked to the pool
  • A gift card code becomes activated after the order invoiced only. If the order is not paid, a customer will not be able to apply a gift card
  • To track the balance of a particular voucher, Gift Code Accounts are issued. The store manager can adjust the balance manually

How do I ship my gift cards?

  • Gift Card as a product in your catalog may be virtual, printed or combined
  • A virtual gift card is just an email-sent code like virtual and downloadable products, it has no weight, there is no physical inventory and it cannot be shipped
  • When gift card is printed or combined, it means the code is being printed on a sheet of paper and delivered. The delivery flow is standard like for simple products
  • Amasty Gift Card does not cover printing issues, we offer only tracking tools

How to configure Gift Card in Magento 2? General Settings

To configure general extension settings please go to StoresConfigurationGift Card.

Enabled - set the option to Yes to run the extension.

Product Types, Which Can Be Bought with Gift Card - specify product types which customers will be able to purchase using a gift card.

Use a Gift Card to Pay for Shipping - select Yes, to pay for a shipment with your giftcard. I.e. a gift card can cover both a purchase and a shipping.

Use a Gift Card to Pay for Tax - enable the setting to allow customers to pay for tax with a gift card. This means, that a customer will be able to pay both for products and taxes with a gift card.

Use a Gift Card to Pay for Amasty Extra Fee - set to Yes ti let customers cover extra fees added by Amasty Extra Fee extension with gift cards.

Allow Refund for Orders Paid with Gift Card - if you enable this option, the sum paid with gift cards will be refunded to gift card amounts.

How it works:

Customers can pay for orders with gift cards. If they want to refund orders later, they may also want to get the wasted gift card balance back. In such cases, the extension does the following:

  • the amount will be refunded to the gift card balance
  • if the gift card is already in a “used” or “inactive” status, it will become “active” again
  • if the gift card account was deleted, a new account will be created instead after the credit memo creation
  • if the order was paid with several gift cards, the amount will be refunded to each of the account according to the spent sum
  • if the gift card has the “expired” status, admin won't be able to refund to this card: in this case, you can turn off the 'Allow Refund for Orders Paid with Gift Card' option and refund as usual
  • admin can specify the required refund details in the credit memo email to notify customers

Apply Cart Price Rules to Gift Card - enable this option to make Cart Price Rules available for gift cards.


Display options

Gift Card Fields - Specify the fields a customer should fill in when purchasing a gift card.

When disabling certain fields by adjusting corresponding settings in the Gift Card Extension Configuration, do not forget to update your templates for gift card related emails. Otherwise, those unnecessary variables will be included in the body of the sent message and it may cause inconvenience.

Show Gift Card Options in Mini Cart And Checkout - Enable the option to show the gift card options on the cart page.

Timezones for User Choosing - Define the timezones a user can choose on the frontend. The option is connected with the delivery date setting. A user can define the date a gift card should be sent and, also, choose the timezone of a recipient.

Allow Users to Upload Own Images for Gift Card - Set to Yes to enable users to upload their own images for gift cards (in png, jpg, gif formats).

Tooltip Message for Users - Specify the message to inform customers upon certain restrictions when uploading their own images for gift cards.

Here's how customers will see the tooltip:

Gift Card Options

Lifetime (days) - Specify the number of days during which the gift card will be valid. When set to 0 (zero), certificate will have unlimited lifetime.

Assign Gift Card to Customer Account — enable the option to assign gift cards to customer accounts to improve fraud protection. If enabled, customers need to bind Gift Card Codes with their accounts to use them on checkout or in the cart. Otherwise, they will get the notification ‘Please add this Gift Card Code to your customer account to proceed’ and won’t be able to apply the gift code.

Allow Customers to Use Gift Cards They Bought for Themselves - Enable the option to let customers buy gift card without sending them to other recipient.

Notify Customers Before Certificate Expires - Set the option to ‘yes’ to enable notifications dispatch when the certificate lifetime expires. Notifications are available only for purchased gift cards.

Number of Days Before Expiry - specify when email reminders should be sent. When set to 0 (zero), the notification is sent once the certificate expires.


Email Options

Email sender - select an email sender.

Email Template - choose a template according to which an email will be generated.

Send Copy to - in this field you may specify particular email addresses to which notifications will be sent as well. Each email should be placed on a new line.

Expiry Notification Email Template - set the template for the expiry notifications.

Send Confirmation to Sender - enable this option to notify a gift card sender once the certificate is sent to the recipient.

Sender Confirmation Email Template - select the corresponding sender confirmation email template from the templates list.

Attach PDF Gift Card to Email - you can add a PDF gift card to the email.

Gift Card Account

In this tab you can configure how and where the field for adding a card will be displayed.

Position On Checkout - choose the position to add the filed for gift cards application (by now, only 'Checkout Discount' position is available).

View On Checkout - select the 'Input Field' value to show the gift card after the discount block or choose the 'Dropdown' to hide the option.

Input field:

Dropdown:


Email Addresses

To specify store email addresses from which you want to send gift card emails and expiration notifications please go to StoresConfigurationStore Email Addresses.


Product Creation

To create a gift card product please go to ProductsCatalog → click on the Add Product button and select the Gift Card by Amasty product type in the dropdown.

Gift Card Information Settings

Gift Card product settings include the same options as other product types except for Prices and Gift Card Information settings.

Card Type - Select one of the card types:

  • Virtual;
  • Printed;
  • Combined:

Usage - Set the ‘Multiple’ value for a Gift Card that can be used an unlimited number of times till the balance is over. The ‘Single’ value should be used to allow a single application only. In this case, the remaining balance will be reset.

Lifetime in days - It's possible to set individual lifetime for each particular gift card or use default settings.

Email Template - It's also possible to set an individual template per gift card product or use general configuration settings.

Choose gift card code pool - Select one of the available gift card code sets.

Choose gift card images - Choose a gift card image/images from the list of predefined images or upload your own ones.


Gift Card Price Settings

To set gift card price and possible pricing options, expand the Amasty Gift Card Prices tab.

Amounts - You can set fixed price for a gift card product.

The specified prices will be displayed on the frontend product page.

To add even more flexible pricing options, you may enable Open Amount and a Fee for purchase.

Open Amount - Enable the option to let customers specify a custom gift card amount.

Open Amount Min/Max Value - Limit an open amount with min/max values.

On the frontend the feature will be displayed in the following way:

Enable fee for purchase - Set the option to 'yes' to add an extra fee for a gift card product or vice versa - make the gift card product price lower than the certificate value.

Add a fee for purchase - Select a fee type either fixed or percent.

Specify fee value - in case you specify a negative amount, the price of a gift card product will be decreased accordingly. If you want to add an extra fee, either percent or fixed, please specify a positive value. E.g. -10 or 10.


Gift Card Codes Generation

To create gift card code pools please go to MarketingGift CardsCode Pools.

On the Gift Card Code Pools grid you'll see all previously generated gift code sets. You can easily delete or edit them if needed.

Create additional code pools with the Add New button. Configure the General Settings.

Code Pool Name - Specify the name for each code pool you create.

Conditions - set the necessary conditions that will limit the cases of a gift card application.

When a customer tries to apply a gift card code, that doesn't match the conditions set by the admin, he will see a notification:

Proceed to the Code Settings section.

Code Templates - Specify the template for codes generation, where {L} - letter, {D} - digit, e.g. PROMO_{L}{L}{D}{D}{D} results in PROMO_DF627. Recommended code length is 20 symbols

Codes Qty to Generate - Set the codes quantity that should be created.

You can also import gift card codes using a CSV file.

Hit the Generate button. Open the Codes List tab, where you'll find all generated or imported codes.

When a coupon is used, you will see the updated status in the codes list.

Gift Card Images

To upload gift card images please go to MarketingGift CardsImages.

See uploaded images on the grid. Click on the Add New button to upload a new image.

Image Title - specify the suitable title for internal use.

Enabled - switch to Yes to activate the image.

Gift Card Title - provide the title of a gift card which can be placed on the image using drag-and-drop.

Hit the Upload Image button.

Also, you can customize the design of a card by adding different types of information. Hit the Design Card button.

Drag and drop the elements you need to place on a card. It is possible to edit each element manually if needed. Delete elements by double-clicking or by clicking on the trash icon directly on the item.


Gift Code Accounts

To manage gift code accounts please go to MarketingGift CardsAccounts.

On the gift card code accounts grid you can view and edit the accounts of all purchased gift cards. Generate in Bulk to create several accounts at once.

You can also view and filter all accounts by the recipient and the sender email addresses. Also, you can filter gift codes by their order numbers.

Click Edit in the Action column to check the info of a particular account.

Order ID - Click on the order ID to get redirected to the corresponding order page.

Edit gift card codes data:

  • Status;
  • Website;
  • Initial code value;
  • Current balance;
  • The date of expiration;

Comment - Admin users can write a comment for each gift card code for their internal needs.

Send Gift Card - Specify recipient's data to resend a gift card code if needed.

In the Order History tab you'll find all orders for which the gift card was used.


Gift Card Email Templates Settings

To create or edit an email template please go to MarketingCommunicationsEmail Templates. Choose the template you need and click on the Load Template button.

Template Content - In this field you can edit the template content according to your needs.


Gift Card Email Template Example

Also, the customers have the ability to preview the email with a gift card before they make a purchase.

If you enabled Assign Gift Card to Customer Account option then the email template will be as follows:

Please mind that if you use a custom email template, it needs to be adjusted to convey the proper message under the setting enabled.


Gift Card Frontend Examples

See the example of gift card products added to a separate category.

Here is the example of a gift card product page where a customer can select the gift card value (if there are any), upload a custom image, specify recipient's information and write a greeting message.


Amasty Gift Card Code Status Check Widget

You can also add a widget so that customers could check their balance on any page. See the frontend sample on a product page:

To create a widget, go to Content → Elements → Widgets and hit the Add Widget button.

Select the Amasty Gift Card Code Status Check widget type.

Choose the theme, set the required pages and postion for you widget and click Save. For example, you can also add status check to the mini cart by choosing the appropriate position.

Gift Card Application

Customers can check the balance of each gift card in their accounts. To see the balance, the recipient should open the corresponding tab in a customer account, enter the code and click on the 'Submit' button. Information about activated codes will be displayed below.

Customers can check a gift card status as well as apply the gift card on a shopping cart page. All active codes are displayed in the dropdown, so customers can simply choose the necessary one.

Once a gift card code is applied, the order total will be automatically recalculated.

Now the extension is compatible with Amasty Extra Fee extension. Thus, shoppers can cover ANY costs with their gift cards.

API Integration

The extension includes API support. Store admins may use the following APIs:

GiftCard

Amasty\GiftCard\Api\ImageRepositoryInterface - API for images processing

Available methods:

save(account)
getById(id)
getList()
deleteById(id)

Amasty\GiftCard\Api\CodePoolRepositoryInterface - API for codes pool processing

Available methods:

save(codePool)
getById(id)
getList() 
deleteById(id)

Amasty\GiftCard\Api\CodeGeneratorManagementInterface - API for codes generation

generateCodesForCodePool(codePoolId, qty) - generation of codes qty for codePoolId

generateCodesByTemplate(codePoolId, template, qty) - generation of codes according to template for codePoolId

GiftCardAccount

Amasty\GiftCardAccount\Api\GiftCardAccountRepositoryInterface - API for gift account processing

Available methods:

save(account)
getById(id)
getByCode(code)
deleteById(id)
getList()

Amasty\GiftCardAccount\Api\GiftCardAccountManagementInterface - API for cards application to customers

Available methods:

saveByQuoteId(cartId, giftCardCode) - application //cartId// of gift account with //giftCardCode//
deleteByQuoteId(cartId, giftCardCode) - deletion //cartId// of gift account with //giftCardCode//

Amasty\GiftCardAccount\Api\GuestGiftCardAccountManagementInterface - API for card apllication to guests

Available methods:

saveByQuoteId(cartId, giftCardCode)
deleteByQuoteId(cartId, giftCardCode)

GraphQL compatibility

The extension is compatible with GraphQL (read + write).

Here is an example of the implementation via Graphql. Follow the steps below:

1. Create the cart

mutation 
{createEmptyCart}

2. Add the product

mutation 
{addSimpleProductsToCart(
input: {
cart_id: "YOUR CART ID"
cart_items: [
{
data: {
quantity: 2
sku: "YOUR PRODUCT SKU"
}
}
]
}
) {
cart {
items {
idproduct {
sku
stock_status
}
quantity
}
prices {
subtotal_excluding_tax {
currency
value
}
grand_total {
currencyvalue
}
}
}
}
}

3. Apply the gift card

mutation {
applyAmGiftCardToCart(
input: {
cart_id: "YOUR CART ID"
am_gift_card_code: "YOUR GIFT CODE"
}
) {
cart {
id
prices {
subtotal_excluding_tax {
currency
value
}
grand_total {
currency
value
}
}
}
}
} 

Gift Card Pro: Export

The extension includes a part of Export Orders solution. It means that you can export any gift card information using the simplified export UI.

Navigate to System → Amasty Export → Export.

Choose the required entity and configure export settings.

Main features you can use:

  • Choose 1 of 6 available file types (CSV, XML, ODS, XLSX, JSON, Template)
  • Specify output option (Store Exported File On Server, Upload Exported File By FTP / SFTP, Send Exported File to E-mail, Send to Rest Api Endpoint)
  • Configure export fields and their namings
  • Filter data by any parameter

Check the details of each tab configuration in this guide.

Gift Card Pro: Import

The same UI as described above is now available for the import tasks.

Navigate to System → Amasty Import → Import.

Choose the required entity and configure import settings.

Main features you can use:

  • Select file format (CSV, XML, ODS, XLSX)
  • Specify output option (Local Directory, File Upload, FTP, SFTP, URL, Google Sheets, REST API Endpoint)
  • Add import fields and map the namings
  • Validate import file to avoid errors

See the details in this guide.

Gift Card Pro/Premium: SMS Notification

Now the extension is compatible with SMS Notification Pro. You can set up an additional channel to notify customers about the receipt of a gift card, its balance updates, and remind them of the expiration date. To learn more about the product's capabilities and price, please, visit the product page.

Configuration

SMS Notification - enable the option to set up the SMS notification channel.

SMS Gateway - to set up the Gateway, please, choose your SMS service provider and fill in all the necessary credentials: sender ID, authentication key, route, Auth Token, Account SID, API URL, and purchased mobile phone number. The information to enter will depend on the chosen service provider.

To learn more about the settings, please, refer to the SMS Notification Pro User Guide.

Please, note that to display the Recipient phone number field on the frontend, you need to select the Recipient Phone in the Amasty Extension/Gift Card/Display Options/Gift Card Fields menu.

Please, mind that to employ the functionality you need to buy the SMS Notification Pro extension.

Gift Card Premium: Store Credit

Now the product enjoys features of the Amasty Store Credit & Refund extension to allow your customers to redeem Gift Cards balances for store credit.

Configuration Enable Module - set to Yes to enable refunding to Magento 2 store credit balance.

Refund Store Credit Automatically - select Yes if you want the Refund to Store Credit option to be set on the credit memo page by default.

Allow applying Store Credit on Tax - enable this option if you want to allow customers to apply store credit currency on taxes.

Allow applying Store Credit on Shipping - set to Yes to enable your customers to apply store credit balance on shipping.

You can also apply Store Credit to certain products by including/excluding lists of SKUs and categories. In the example above, we enabled the functionality for category 41, which is the category id for Gift Cards in the demo. You can also enable email notifications about the store credit balance updates. To learn about all the settings, please, refer to the Store Credit and Refund User Guide.


PWA for Gift Card Add-On

To get the most of the Gift Card Pro extension, install the PWA add-on. The software provides a faster, enhanced experience for the clients shopping from phones and tablets.

Before purchasing the PWA for Gift Card Add-On, please, acknowledge, that it requires
  • the Gift Card Pro Extension;
  • PWA theme and PWA Studio installed.
In order to correctly install a PWA add-on, please install the corresponding GraphQL system package first. For the correct name of it, please check the composer.json file of the main module. For example, the GraphQL system package name of the PWA add-on for the Blog Pro extension would be the following: amasty/blog-graphql

The add-on adapts interaction with the website to various screen resolutions to improve responsiveness and the overall client experience. Once the software is added, the Gift Card page will be displayed as follows:

Choosing the card value, its design, checking gift cards balance, and other features will be available with the enhanced mobile usability.

Please, note a few limitations when purchasing PWA for Gift Card Add-On:
  1. The add-on doesn’t include a widget that helps clients see their gift card balance on any page of the store. To check the information one needs to proceed to their account.
  2. Customizable options, like wrapping the gift card, adding ribbons, are not compatible with the add-on.
  3. The software doesn’t support the virtual gift card type. When setting up the Gift Card product page, make sure the related options are disabled. Otherwise, the e-Gift Card type will be displayed on the page, but not available for adding to the cart.

Troubleshooting

Problem: images are not displayed in emails.

Solution: install the Imagick extension to display images for different email clients properly. If you are not sure how to install the necessary extension on the server correctly, please contact your administrator.

Find out more about the Imagick PHP extension here.

FAQ

* Does the extension allow sending a gift card code to the customer who hasn't purchased it using the Admin Panel?

* I'd like to apply discounts to gift cards. How can I do that?

* How to activate the gift card account?

* Is it possible to create a gift code account using a specific code from the pool?

* Is it possible to use a gift card for several orders?

* Show more articles →


Find out how to install the Gift Card extension for Magento 2 via Composer.
Rate the user guide
 stars  from 9 votes (Details)
magento_2/gift_card.txt · Last modified: 2022/08/25 10:33 by tihomirova