Skip to content

Site · Ecommerce

Gift Cards

Last updated 18 November 2026

Issue gift cards, track their balance and apply them to orders.

What gift cards are for

A gift card holds a value that a customer can spend on an order. Each card has a code, the value it started with, the balance left on it, a status and an optional expiry date. Every change to the balance is written to the card's transaction history, so you can see where the money went.

Open Ecommerce > Gift Cards to see every card on the site.

The gift card list

The list shows one row per card. Search by Code, sort by any column, and choose 10, 20, 50 or 100 rows per page.

ColumnWhat it shows
CodeThe code the customer enters. Codes are generated by the site in the form XXXX-XXXX-XXXX.
Initial ValueThe value the card was issued with.
Balance RemainingWhat is still left to spend.
Expiry DateWhen the card stops working. Empty when the card never expires.
Last UpdatedWhen the card last changed.
StatusActive, Cancelled, Spent or Expired. See the table below.

Statuses

StatusMeaningSet by
ActiveThe card can be used.The site when the card is issued, or you
CancelledThe card can no longer be used.You, on the card's Details tab
SpentThe whole balance has been used.The site
ExpiredThe expiry date has passed.The site

You can switch a card between Active and Cancelled. A card that is Spent or Expired shows its status as read-only.

Add a gift card

  1. Go to Ecommerce > Gift Cards.
  2. Select Add Gift Card.
  3. Enter the Initial Value. It is required and must be at least 0.01.
  4. Leave Expiry Date set to Never Expires, or switch it to Has Expiry Date and pick a date.
  5. Select Add Gift Card.

The site generates the code and sets the balance to the initial value. You cannot type your own code.

View or change a gift card

Select a card in the list to open it. It has two tabs.

TabWhat you can do
DetailsSee the Initial Value, Balance Remaining and Code, which are read-only. Change the Status between Active and Cancelled, and change the expiry date.
Transaction HistoriesSee every change to the balance, with the Order, Type, Amount, Balance After and Date.

Transaction types

TypeWhen it is written
IssueThe card is created with its full value.
RedemptionThe card is used to pay for an order.
AdjustmentAn amount is put back on the card, for example when the card is removed from an order.

Use a gift card on an order

  1. Open the order in Ecommerce > Orders.
  2. Select Apply Gift Card.
  3. Enter the Gift Card Code and select Apply Gift Card.

You do not enter an amount. The site takes the smaller of the card's balance and what is still owed on the order. It records a gift card payment on the order and a Redemption on the card.

The card is refused when:

  • no card has that code
  • the card has no balance left
  • the card is cancelled or has expired
  • nothing is owed on the order

Removing a gift card from an order puts the amount back on the card and writes an Adjustment. Gift card payments on an order cannot be edited or deleted like other payments; remove the card instead.

Gift cards through the API

The Ecommerce API can list gift cards, look one up by code, issue a new card, and apply or remove a card on an order. A website uses these to sell gift cards and to let customers pay with them at checkout. See API for how to call the module endpoints.