Skip to main content

Gift Cards

This page details the setup, management, and usage of the Gift Cards addon for ClientXCMS. Objective: enable the creation, sale, and use of gift cards (fixed or random amount) with complete tracking on both admin and client sides.


1. General Principle

  1. Global Settings

    • You define allowed amounts, code prefix, and default validity period.
  2. Creation & Management

    • From administration: manually generate a gift card (fixed or random amount, number of uses, optional recipient) or view global statistics.
  3. Store Sales

    • Customers can purchase a gift card (predefined amounts) via their chosen payment gateway; the code is sent by email.
  4. Usage

    • The recipient enters the code in their client area → the balance is credited immediately.
  5. Tracking

    • Dashboards (admin + client) list ordered cards, used cards, usage rate, total credited, etc.

2. Prerequisites

Once the addon is activated:

  • Administration → Settings → Extension Settings → Gift Card Settings
  • Management interface: Administration → Settings → Store Settings → Gift Cards
ElementVersion / Detail
Add-onGift Cards (Marketplace)
DependenciesNone, works natively with active payment methods
Client Role"Use a gift card" authorization (enabled by default)

3. Global Settings (extension)

FieldDescriptionExample
Allowed amountsValues offered for purchase, comma-separated10,20,50,100,200
Expiration (days)Default validity period for created or sold cards365
Allow purchaseEnables/disables sales in client area
Gift card prefixAutomatically added before each generated codeCC (will give CC-6MCP9IC8)

Amounts are expressed in your store's main currency.


4. Administration Interface

4.1 Dashboard

img

  • Gift cards created: total counter.
  • Total amount credited: sum credited to customers.
  • Usage rate: percentage of fully consumed cards.

4.2 List & Actions

ColumnDescription
#Internal identifier
CodeGift card code
Usagex / y (uses made / maximum)
AmountFixed value or random range
CreatedGeneration date
ActionsView (details) / Delete

4.3 Available Filters

  • Card code
  • Amount
  • Type (fixed / random)
  • Internal identifier
  • Customer (recipient)

5. Manual Creation

img

Administration → Gift Cards → Create

FieldType Fixed AmountType Random Amount
Card codePre-filled (CC-XXXXXXX) editablePre-filled editable
AmountSingle value (e.g., 25.00)
Min / Max amountRange e.g., 5.0050.00
Maximum uses-1 = unlimited, otherwise 1, 2 …Same
ExpirationOptional date/timeSame
Authorized customerRestrict card to one customerSame

Click Create: the card appears in the list and can be sent manually or communicated to the recipient.


6. Client-Side Experience

img

Menu My Account → Payment Methods → Gift Cards

  1. Add a gift card

    • Code field + Add button ⇒ credit is transferred instantly to the balance.
  2. Give a gift card

    • Amount selection (from allowed ones) + payment gateway.
    • Option "This gift card is for a friend": sends the code by email to the recipient.
  3. Ordered cards

    • List of purchased codes, used / unused status and date.
  4. Used cards

    • History of applied codes, amounts and dates.

7. Best Practices

  1. Predefined amounts: offer round values (€10, €20…) to simplify purchasing.
  2. Distinctive prefix: e.g., CC for "ClientXCMS" to avoid confusion with coupons.
  3. Reasonable expiration: 6 – 12 months is sufficient while respecting local legal obligations.
  4. Limit uses: 1 by default; unlimited only for specific needs (e.g., loyalty program).
  5. Support: keep the internal ID (#) for any traceability request.