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.
Ruby b2b-commercee-commerceecommerceecommerce-apiecommerce-frameworkecommerce-platformheadlessheadless-commerceheadless-ecommercemarketplacemulti-tenantmulti-vendormulti-vendor-ecommerceopen-sourcespree-commerce
Added 'Gift cards' documentation under the Promotions section (#13634)
jaburghes287df357f0e5
diff --git a/docs/docs.json b/docs/docs.jsonindex 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.pngnew file mode 100644index 0000000000..979448f043Binary files /dev/null and b/docs/images/user/promotions/gift-cards/1-gift-cards.png differdiff --git a/docs/images/user/promotions/gift-cards/2-add-gift-cards.png b/docs/images/user/promotions/gift-cards/2-add-gift-cards.pngnew file mode 100644index 0000000000..f4bea93e2fBinary files /dev/null and b/docs/images/user/promotions/gift-cards/2-add-gift-cards.png differdiff --git a/docs/images/user/promotions/gift-cards/3-gift-form.png b/docs/images/user/promotions/gift-cards/3-gift-form.pngnew file mode 100644index 0000000000..7ad9b02ac2Binary files /dev/null and b/docs/images/user/promotions/gift-cards/3-gift-form.png differdiff --git a/docs/images/user/promotions/gift-cards/4-gift-card-batch.png b/docs/images/user/promotions/gift-cards/4-gift-card-batch.pngnew file mode 100644index 0000000000..e20f75c81bBinary files /dev/null and b/docs/images/user/promotions/gift-cards/4-gift-card-batch.png differdiff --git a/docs/images/user/promotions/gift-cards/5-manage-gift-cards.png b/docs/images/user/promotions/gift-cards/5-manage-gift-cards.pngnew file mode 100644index 0000000000..8cc66c757dBinary files /dev/null and b/docs/images/user/promotions/gift-cards/5-manage-gift-cards.png differdiff --git a/docs/images/user/promotions/gift-cards/6-edit-gift-cards.png b/docs/images/user/promotions/gift-cards/6-edit-gift-cards.pngnew file mode 100644index 0000000000..8104ddd099Binary files /dev/null and b/docs/images/user/promotions/gift-cards/6-edit-gift-cards.png differdiff --git a/docs/images/user/promotions/gift-cards/7-delete-gift-card.png b/docs/images/user/promotions/gift-cards/7-delete-gift-card.pngnew file mode 100644index 0000000000..3b102811c3Binary files /dev/null and b/docs/images/user/promotions/gift-cards/7-delete-gift-card.png differdiff --git a/docs/user/promotions/gift-cards.mdx b/docs/user/promotions/gift-cards.mdxnew file mode 100644index 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.++++Click **New Gift Card** in the top right corner.++++You’ll be prompted to choose between:++- **Gift Card** (single code)+- **Gift Card Batch** (multiple codes generated at once)++## Create a Single Gift Card++++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)++++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++++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++++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++++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.