Skip to content

armgit / spree

Public Imported from GitHub
0

Open Source Platform for DTC, B2B Commerce, Marketplaces & Omnichannel. REST APIs, TypeScript SDKs, and production-ready Next.js storefront. Self-host it. Own your data. No vendor lock-in. Zero platform fees.

Added 'Gift cards' documentation under the Promotions section (#13634)

jaburghes287df357f0e5
diff --git a/docs/docs.json b/docs/docs.json
index 7dba55670b..572b5a29a7 100644
--- a/docs/docs.json
+++ b/docs/docs.json
@@ -1048,7 +1048,8 @@
"pages": [
"user/promotions/create-a-promotion",
"user/promotions/promotion-rules",
- "user/promotions/promotion-actions"
+ "user/promotions/promotion-actions",
+ "user/promotions/gift-cards"
]
},
{
diff --git a/docs/images/user/promotions/gift-cards/1-gift-cards.png b/docs/images/user/promotions/gift-cards/1-gift-cards.png
new file mode 100644
index 0000000000..979448f043
Binary files /dev/null and b/docs/images/user/promotions/gift-cards/1-gift-cards.png differ
diff --git a/docs/images/user/promotions/gift-cards/2-add-gift-cards.png b/docs/images/user/promotions/gift-cards/2-add-gift-cards.png
new file mode 100644
index 0000000000..f4bea93e2f
Binary files /dev/null and b/docs/images/user/promotions/gift-cards/2-add-gift-cards.png differ
diff --git a/docs/images/user/promotions/gift-cards/3-gift-form.png b/docs/images/user/promotions/gift-cards/3-gift-form.png
new file mode 100644
index 0000000000..7ad9b02ac2
Binary files /dev/null and b/docs/images/user/promotions/gift-cards/3-gift-form.png differ
diff --git a/docs/images/user/promotions/gift-cards/4-gift-card-batch.png b/docs/images/user/promotions/gift-cards/4-gift-card-batch.png
new file mode 100644
index 0000000000..e20f75c81b
Binary files /dev/null and b/docs/images/user/promotions/gift-cards/4-gift-card-batch.png differ
diff --git a/docs/images/user/promotions/gift-cards/5-manage-gift-cards.png b/docs/images/user/promotions/gift-cards/5-manage-gift-cards.png
new file mode 100644
index 0000000000..8cc66c757d
Binary files /dev/null and b/docs/images/user/promotions/gift-cards/5-manage-gift-cards.png differ
diff --git a/docs/images/user/promotions/gift-cards/6-edit-gift-cards.png b/docs/images/user/promotions/gift-cards/6-edit-gift-cards.png
new file mode 100644
index 0000000000..8104ddd099
Binary files /dev/null and b/docs/images/user/promotions/gift-cards/6-edit-gift-cards.png differ
diff --git a/docs/images/user/promotions/gift-cards/7-delete-gift-card.png b/docs/images/user/promotions/gift-cards/7-delete-gift-card.png
new file mode 100644
index 0000000000..3b102811c3
Binary files /dev/null and b/docs/images/user/promotions/gift-cards/7-delete-gift-card.png differ
diff --git a/docs/user/promotions/gift-cards.mdx b/docs/user/promotions/gift-cards.mdx
new file mode 100644
index 0000000000..4960544b85
--- /dev/null
+++ b/docs/user/promotions/gift-cards.mdx
@@ -0,0 +1,103 @@
+---
+title: "Gift Cards"
+description: "Learn how to create individual or bulk gift cards in Spree Commerce."
+---
+
+Gift cards allow customers (or recipients) to redeem a prepaid balance at checkout. In Spree, you can create single gift cards for specific customers or generate batches of codes for broader distribution.
+
+To get started, navigate to **Promotions → Gift Cards** in the admin dashboard.
+
+![](/docs/images/user/promotions/gift-cards/1-gift-cards.png)
+
+Click **New Gift Card** in the top right corner.
+
+![How to create gift cards in Spree Commerce](/docs/images/user/promotions/gift-cards/2-add-gift-cards.png)
+
+You’ll be prompted to choose between:
+
+- **Gift Card** (single code)
+- **Gift Card Batch** (multiple codes generated at once)
+
+## Create a Single Gift Card
+
+![Creating a single gift card in Spree Commerce](/docs/images/user/promotions/gift-cards/3-gift-form.png)
+
+Selecting **Gift Card** opens the creation form.
+
+Complete the following fields:
+
+- **Email (optional)** - Assign the gift card to a specific customer email, or leave blank to create an unassigned code.
+- **Code** - Leave blank to auto-generate a unique code, or enter one manually.
+- **Amount** (required) - The value of the gift card.
+- **Currency** (required) - The currency the card should be issued in.
+- **Expires At** - Optional expiration date. Leave blank for a non-expiring card.
+
+Click **Create** to issue the gift card. It will appear in the Gift Cards table and can be redeemed using the code at checkout.
+
+## Create a Gift Card Batch (Bulk Generation)
+
+![Creating a batch of gift cards in the Spree Commerce dashboard](/docs/images/user/promotions/gift-cards/4-gift-card-batch.png)
+
+Selecting **Gift Card Batch** allows you to generate multiple codes at once.
+
+The form includes the same core fields as a single gift card (excluding the Customer field), plus:
+
+- **Prefix** - Adds a custom prefix to each generated code (e.g., HOLIDAY-, VIP-).
+- **Codes Count** (required) - The total number of gift card codes to generate.
+
+Spree will automatically create the specified number of unique codes.
+
+After clicking **Create**, all generated gift cards will be added to the Gift Cards table.
+
+## Manage & Export Gift Cards
+
+![How to manage gift cards in the Spree Commerce dashboard](/docs/images/user/promotions/gift-cards/5-manage-gift-cards.png)
+
+Once created, gift cards appear in the main table view under **Promotions → Gift Cards**.
+
+The table displays key information for each card, including:
+
+- Code
+- Original amount
+- Amount of credit used
+- Currency
+- Expiration date
+- Assigned customer (if any)
+
+This makes it easy to monitor usage and track remaining balances.
+
+### Edit a Gift Card
+
+![How to edit a gift card in the Spree Commerce dashboard](/docs/images/user/promotions/gift-cards/6-edit-gift-cards.png)
+
+To edit a gift card:
+
+1. Click on the gift card from the table
+2. In the **Settings** section, click **Edit**
+3. Update the necessary fields
+4. Click **Save**
+
+### Delete a Gift Card
+
+![How to delete a gift card in the Spree Commerce dashboard](/docs/images/user/promotions/gift-cards/7-delete-gift-card.png)
+
+To delete a gift card:
+
+1. Open the gift card
+2. Click the **three-dot menu** in the top-right corner
+3. Select **Delete**
+
+### Export Gift Cards
+
+You can also:
+
+- Use **Filters** to narrow results
+- Sort columns
+- Customize visible columns
+- Click **Export** to export filtered records to CSV
+
+This is especially useful when distributing bulk-generated codes for marketing campaigns, partnerships, or seasonal promotions.
+
+## How to Redeem Gift Cards
+
+Customers can redeem a gift card at checkout by entering the gift card code into the Promotion field before completing their purchase.