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.

Rewrite Loyalty user guides: Gift Cards and Store Credits (#14880)

jaburghes484e7bac8d08
diff --git a/docs/docs.json b/docs/docs.json
index 66f4c20a8d..6caee06bca 100644
--- a/docs/docs.json
+++ b/docs/docs.json
@@ -432,14 +432,22 @@
"source": "/user/promotions/gift-cards",
"destination": "/user/loyalty/gift-cards"
},
+ {
+ "source": "/user/loyalty/issue-gift-card",
+ "destination": "/user/loyalty/gift-cards"
+ },
{
"source": "/user/customers/issue-gift-card",
- "destination": "/user/loyalty/issue-gift-card"
+ "destination": "/user/loyalty/gift-cards"
},
{
"source": "/user/customers/assign-store-credits",
"destination": "/user/loyalty/store-credits"
},
+ {
+ "source": "/user/loyalty/store-credits-list",
+ "destination": "/user/loyalty/store-credits"
+ },
{
"source": "/user/manage-products/stock-levels",
"destination": "/user/inventory/stock-levels"
@@ -1233,9 +1241,7 @@
"group": "Loyalty",
"pages": [
"user/loyalty/gift-cards",
- "user/loyalty/issue-gift-card",
- "user/loyalty/store-credits",
- "user/loyalty/store-credits-list"
+ "user/loyalty/store-credits"
],
"icon": "gift"
},
@@ -2889,9 +2895,7 @@
"group": "Loyalty",
"pages": [
"user/loyalty/gift-cards",
- "user/loyalty/issue-gift-card",
- "user/loyalty/store-credits",
- "user/loyalty/store-credits-list"
+ "user/loyalty/store-credits"
]
},
{
diff --git a/docs/images/user/loyalty/gift-cards/1-gift-cards-overview.png b/docs/images/user/loyalty/gift-cards/1-gift-cards-overview.png
new file mode 100644
index 0000000000..eca40faa17
Binary files /dev/null and b/docs/images/user/loyalty/gift-cards/1-gift-cards-overview.png differ
diff --git a/docs/images/user/loyalty/gift-cards/2-new-gift-card-form.png b/docs/images/user/loyalty/gift-cards/2-new-gift-card-form.png
new file mode 100644
index 0000000000..bb497d5689
Binary files /dev/null and b/docs/images/user/loyalty/gift-cards/2-new-gift-card-form.png differ
diff --git a/docs/images/user/loyalty/gift-cards/3-gift-card-detail.png b/docs/images/user/loyalty/gift-cards/3-gift-card-detail.png
new file mode 100644
index 0000000000..1dbd774682
Binary files /dev/null and b/docs/images/user/loyalty/gift-cards/3-gift-card-detail.png differ
diff --git a/docs/images/user/loyalty/gift-cards/4-checkout-summary.png b/docs/images/user/loyalty/gift-cards/4-checkout-summary.png
new file mode 100644
index 0000000000..7f4a256343
Binary files /dev/null and b/docs/images/user/loyalty/gift-cards/4-checkout-summary.png differ
diff --git a/docs/images/user/loyalty/store-credits/1-store-credits-overview.png b/docs/images/user/loyalty/store-credits/1-store-credits-overview.png
new file mode 100644
index 0000000000..8f8d93e983
Binary files /dev/null and b/docs/images/user/loyalty/store-credits/1-store-credits-overview.png differ
diff --git a/docs/images/user/loyalty/store-credits/2-store-credit-detail.png b/docs/images/user/loyalty/store-credits/2-store-credit-detail.png
new file mode 100644
index 0000000000..74d6ad3318
Binary files /dev/null and b/docs/images/user/loyalty/store-credits/2-store-credit-detail.png differ
diff --git a/docs/images/user/loyalty/store-credits/3-issue-store-credit.png b/docs/images/user/loyalty/store-credits/3-issue-store-credit.png
new file mode 100644
index 0000000000..67dfae7640
Binary files /dev/null and b/docs/images/user/loyalty/store-credits/3-issue-store-credit.png differ
diff --git a/docs/user/loyalty/gift-cards.mdx b/docs/user/loyalty/gift-cards.mdx
index 3b029c96e1..16a70382d1 100644
--- a/docs/user/loyalty/gift-cards.mdx
+++ b/docs/user/loyalty/gift-cards.mdx
@@ -1,103 +1,109 @@
---
title: "Gift Cards"
-description: "Learn how to create individual or bulk gift cards in Spree Commerce."
+description: "Learn how to issue gift cards, follow their balances and redeem them on orders 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.
+A gift card holds a set amount of money that anyone with the code can spend in your shop. Each gift card carries a code, an amount in one currency, and a running balance.
-To get started, navigate to **Loyalty → Gift Cards** in the admin dashboard.
+The customer types the code at checkout and the card pays the maximum amount it can for the order. If the gift card does not cover the full order total, the customer pays the remainder with another payment method. Any money left on the gift card after the order stays on the card, and the customer can spend it on a later order. A card's remaining balance falls every time the card is used, so the Gift Cards list always shows what your store still owes on each card.
-![](/docs/images/user/promotions/gift-cards/1-gift-cards.png)
+Customers often buy gift cards as presents. Stores also hand gift cards out as prizes, as goodwill after an order went wrong, or as a thank-you to a regular customer. A gift card you sell is paid for before any stock leaves your warehouse. The person who redeems a gift card is often not the person who bought it, so a gift card can bring new customers into your shop.
-Click **New Gift Card** in the top right corner.
+Store credit is the closest alternative to a gift card. Store credit sits on one named customer's account rather than on a code, and only that customer can spend it. See [<u>Store Credits</u>](/user/loyalty/store-credits).
-![How to create gift cards in Spree Commerce](/docs/images/user/promotions/gift-cards/2-add-gift-cards.png)
+To manage gift cards, navigate to **Loyalty → Gift Cards** in the admin dashboard.
-You’ll be prompted to choose between:
+## Reviewing Gift Cards
-- **Gift Card** (single code)
-- **Gift Card Batch** (multiple codes generated at once)
+The list shows one row for every gift card you have issued, newest first.
-## Create a Single Gift Card
+![The Gift Cards list with one active card](/docs/images/user/loyalty/gift-cards/1-gift-cards-overview.png)
-![Creating a single gift card in Spree Commerce](/docs/images/user/promotions/gift-cards/3-gift-form.png)
+| Column | What it means |
+|---|---|
+| **Code** | What the customer types at checkout to apply the gift card. If the card belongs to a customer, their email address sits under the code. |
+| **Status** | Whether the gift card can still be spent. See the table below. |
+| **Amount** | What the gift card was worth when you issued it. |
+| **Used** | How much of the balance has been spent so far. |
+| **Remaining** | What the gift card can still pay for. This is what your store still owes on it. |
+| **Expires** | The last date the gift card is valid, or a dash if the card never expires. |
-Selecting **Gift Card** opens the creation form.
+Type a code into the search box to find one specific gift card. The **Status** filter narrows the list to cards of one status, so it finds the cards that still have money on them and equally the ones that have been fully spent. **Add filter** narrows the list by currency, batch, customer, who issued the card, expiry date, or when the card was created or last changed.
-Complete the following fields:
+A gift card moves through these statuses as it is spent:
-- **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.
+| Status | What it means |
+|---|---|
+| **Active** | Nothing has been spent yet. The full amount is available. |
+| **Partially redeemed** | Some of the balance has been spent. The rest is still available. |
+| **Redeemed** | The whole amount has been spent. The gift card stays on the list as a record, but nothing is left on it. |
-Click **Create** to issue the gift card. It will appear in the Gift Cards table and can be redeemed using the code at checkout.
+## How to Issue a Gift Card
-## Create a Gift Card Batch (Bulk Generation)
+Click **New gift card** in the top-right corner. A panel opens over the list with these fields:
-![Creating a batch of gift cards in the Spree Commerce dashboard](/docs/images/user/promotions/gift-cards/4-gift-card-batch.png)
+- **Quantity** - How many gift cards to issue. Leave **Quantity** at 1 to issue a single card.
+- **Code** - The code the customer types at checkout. Leave **Code** blank and a 16-character code is generated automatically. Enter your own code when you want something memorable for a campaign.
+- **Amount** - What the gift card is worth. **Amount** must be above zero, and the panel stays open with a message under the field until it is.
+- **Currency** - The currency the gift card's balance is held in. The currency cannot be changed after the card is created.
+- **Expires** - The last date the gift card can be used. Leave **Expires** on **No expiry** if your gift card terms do not limit how long a card is valid.
+- **Customer (optional)** - The customer the gift card belongs to. Start typing their email address and select them from the list.
-Selecting **Gift Card Batch** allows you to generate multiple codes at once.
+![The New gift card panel filled in for one $50.00 card attached to a customer](/docs/images/user/loyalty/gift-cards/2-new-gift-card-form.png)
-The form includes the same core fields as a single gift card (excluding the Customer field), plus:
+Click **Create gift card**. The new card appears at the top of the list as **Active**, with its full amount under **Remaining**.
-- **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.
+Creating a gift card does not send the code to anyone. Pass the code to the customer yourself, by email, on a printed card, or at the till. The code is all the customer needs in order to spend the balance.
-Spree will automatically create the specified number of unique codes.
+### How to Create a Batch of Cards
-After clicking **Create**, all generated gift cards will be added to the Gift Cards table.
+Enter a number above 1 in **Quantity** and the panel changes to suit a batch of cards. **Code** becomes **Prefix**, which is the text every code in the batch starts with. The **Customer (optional)** field is removed, because a batch cannot be attached to one customer. The button names the number of cards it will create, for example **Create 3 gift cards**.
-## Manage & Export Gift Cards
+Use a batch for a campaign, for a set of cards sold over the counter, or for any cards that are not going to one named person.
-![How to manage gift cards in the Spree Commerce dashboard](/docs/images/user/promotions/gift-cards/5-manage-gift-cards.png)
+## How to Check a Card's Balance
-Once created, gift cards appear in the main table view under **Loyalty → Gift Cards**.
+Click a gift card's code in the list, or open the row menu and choose **Edit**. A panel opens with the card's code as its title. The **Usage** section of that panel shows what the card was worth, how much has been spent, how much remains, and which staff member issued it.
-The table displays key information for each card, including:
+![A gift card's panel showing its usage](/docs/images/user/loyalty/gift-cards/3-gift-card-detail.png)
-- Code
-- Original amount
-- Amount of credit used
-- Currency
-- Expiration date
-- Assigned customer (if any)
+Once a gift card is fully spent, every field in the panel is read-only.
-This makes it easy to monitor usage and track remaining balances.
+## How Customers Redeem a Card at Checkout
-### Edit a Gift Card
+The customer types the code into the **Gift card or discount code** box in the checkout order summary and clicks **Apply**. The order summary then shows a gift card line taking the card's balance off the order, with the amount still to pay underneath.
-![How to edit a gift card in the Spree Commerce dashboard](/docs/images/user/promotions/gift-cards/6-edit-gift-cards.png)
+If the gift card covers the full order total, the payment section reads *No payment required* and the customer clicks **Place Order**. If the gift card covers only part of the order total, the customer selects a payment method for the remainder and places the order. The order then lists two payments, one for the gift card's share and one for the remainder.
-To edit a gift card:
+![The checkout summary with a gift card paying part of the order and the rest due](/docs/images/user/loyalty/gift-cards/4-checkout-summary.png)
-1. Click on the gift card from the table
-2. In the **Settings** section, click **Edit**
-3. Update the necessary fields
-4. Click **Save**
+A gift card that is not attached to a customer can be spent by anyone who has the code, including a shopper checking out as a guest. If a gift card has money left after an order, the customer can use the same code again on a later order until the balance reaches zero.
-### Delete a Gift Card
+On the order page in the admin dashboard, the **Discounts & Credit** card names which gift card paid for the order and how much of the total it covered.
-![How to delete a gift card in the Spree Commerce dashboard](/docs/images/user/promotions/gift-cards/7-delete-gift-card.png)
+## How to Apply a Gift Card to a Draft Order
-To delete a gift card:
+When your team builds an order on a customer's behalf, a gift card can pay for part or all of that order.
-1. Open the gift card
-2. Click the **three-dot menu** in the top-right corner
-3. Select **Delete**
+1. Open the draft order. In the **Discounts & Credit** card, click **Apply** next to **Gift card**.
+2. Enter the gift card's code and click **Add**.
+3. The card's code and the amount it covers appear in the **Gift card** row, and the order's **Outstanding balance** drops by that amount.
-### Export Gift Cards
+If the gift card does not cover the full order total, add a payment for the remainder from the **Payments** card before you complete the order.
-You can also:
+If you add more items to the draft order after applying the gift card, the amount the card covers does not change, and the cost of the new items is added to the outstanding balance.
-- Use **Filters** to narrow results
-- Sort columns
-- Customize visible columns
-- Click **Export** to export filtered records to CSV
+To take a gift card off a draft order, click **Remove** in the **Gift card** row and confirm with **Remove**. The order's outstanding balance goes back up by that amount, and the amount returns to the gift card's remaining balance.
-This is especially useful when distributing bulk-generated codes for marketing campaigns, partnerships, or seasonal promotions.
+## How to Delete a Gift Card
-## How to Redeem Gift Cards
+Open the row menu on the gift card and choose **Delete**, then confirm with **Delete**. The gift card is removed from the list.
-Customers can redeem a gift card at checkout by entering the gift card code into the Promotion field before completing their purchase.
+<Warning>Deleting a gift card erases it from your store's records rather than keeping it as a canceled card. If the card still has a balance, that balance is erased with it, so check **Remaining** and settle up with the customer before you delete.</Warning>
+
+## Further Reading
+
+- [<u>Store Credits</u>](/user/loyalty/store-credits) - Balances your store owes individual customers
+- [<u>Draft Orders</u>](/user/orders/draft-orders) - Building an order for a customer, with a gift card as payment
+- [<u>Orders</u>](/user/orders/orders) - Where a redeemed gift card shows on an order
+- [<u>Payments</u>](/user/settings/payments) - The payment methods customers use for anything a gift card does not cover
diff --git a/docs/user/loyalty/issue-gift-card.mdx b/docs/user/loyalty/issue-gift-card.mdx
deleted file mode 100644
index 190ad98f3d..0000000000
--- a/docs/user/loyalty/issue-gift-card.mdx
+++ /dev/null
@@ -1,61 +0,0 @@
----
-title: "Issue a Gift Card"
-description: "Learn how to issue gift cards to customers in the Spree admin dashboard."
----
-
-Gift cards are prepaid balances that can be redeemed like cash on future purchases. They’re commonly used for promotions, customer service gestures, loyalty rewards, or as products sold directly to customers.
-
-In Spree, you can issue gift cards to individual customers or generate them in bulk for later distribution. This guide covers how to issue a gift card to a specific customer.
-
-## How to Issue a Gift Card
-
-To issue a gift card, navigate to **Customers** in the admin dashboard.
-
-![How to issue a gift card to a customer in Spree Commerce](/docs/images/user/customers/gift-cards/1-customers-tab.png)
-
-Find and click the customer who should receive the gift card to open their customer profile.
-
-![Customer profile page in the Spree admin backend](/docs/images/user/customers/gift-cards/2-customer-profile.png)
-
-Click the **three-dot menu** in the top right corner, and select **Add a Gift Card**.
-
-![Issuing a gift card to a customer in Spree Commerce](/docs/images/user/customers/gift-cards/3-add-gift-card.png)
-
-You’ll be redirected to the gift card creation form.
-
-## Configure the Gift Card
-
-![Configuring a gift card in Spree Commerce](/docs/images/user/customers/gift-cards/4-gift-card-form.png)
-
-Complete the following fields:
-
-- **Code** - Leave blank to have Spree automatically generate a unique code, or enter one manually.
-- **Amount** - The value of the gift card.
-- **Currency** - Select the currency the gift card should be issued in.
-- **Expires At** - Optional expiration date. Leave blank for a non-expiring gift card.
-
-Click **Create** to issue the gift card. It will immediately appear in the customer’s **Gift Cards** section.
-
-## Edit a Gift Card
-
-![Editing a gift card in the Spree Commerce admin dashboard](/docs/images/user/customers/gift-cards/5-edit-gift-card.png)
-
-To modify a gift card:
-
-1. Go to the customer’s profile
-2. Scroll to the **Gift Cards** subsection
-3. Click on the gift card to be redirected that gift card's form
-4. Click **Edit** in the Settings section 
-5. Make your changes and click **Update**
-
-## Delete a Gift Card
-
-![Deleting a gift card in Spree Commerce](/docs/images/user/customers/gift-cards/6-delete-gift-card.png)
-
-To delete a gift card:
-
-1. Go to the customer’s profile
-2. Scroll to the **Gift Cards** subsection
-3. Click on the gift card to be redirected to that gift card's form
-4. Click **three-dot menu** in the top-right corner
-5. Click **Delete**
diff --git a/docs/user/loyalty/store-credits-list.mdx b/docs/user/loyalty/store-credits-list.mdx
deleted file mode 100644
index adf9a0ae84..0000000000
--- a/docs/user/loyalty/store-credits-list.mdx
+++ /dev/null
@@ -1,82 +0,0 @@
----
-title: "Store Credits List"
-description: "See how much your store owes in prepaid balances, to whom, and why."
----
-
-A store credit is money your store owes a customer. Spread across many
-customers, credits are easy to lose track of: without a place to see them
-together, answering "how much do we owe in total" means opening every customer
-in turn.
-
-**Loyalty → Store Credits** shows every credit in your store on one page, with
-the outstanding balance summarised above it. You can also issue a new credit to
-any customer from here with **Issue store credit** - see
-[Issue Store Credits](/user/loyalty/store-credits).
-
-## Read the Outstanding Balance
-
-Above the table sits one card per currency you have issued credit in. Each card
-shows three figures:
-
-- **Outstanding** - what is still owed. This is the number that belongs on your
- books as a liability.
-- **Issued** - everything ever put on a credit in that currency.
-- **Used** - how much of it customers have already spent.
-
-The cards follow whatever filter is active. With no filter they answer "what
-does the store owe"; filter by a customer and the same cards answer "what does
-this customer hold".
-
-## Filter and Search
-
-The table can be narrowed by:
-
-| Filter | The question it answers |
-| --- | --- |
-| Customer | Who holds this credit |
-| Standing | Is there money left, or has it all been spent |
-| Currency | Which set of books this belongs to |
-| Origin | Did a gift card create it, or something else |
-| Issued by | Which staff member put it there |
-| Created | When it was issued |
-
-The search box matches the memo, which is the free-text reason written when a
-credit is issued or by the workflow that created it.
-
-## Understand Where a Credit Came From
-
-The **Origin** column names what created the credit:
-
-- **Gift card** - a customer redeemed a gift card and the balance moved onto
- their account.
-- **Return**, **Exchange**, **Claim** - a post-sale process refunded to credit
- rather than to the original payment method.
-- **Issued by hand** - a staff member created it directly, usually as
- compensation or a goodwill gesture. The memo says why.
-
-## Open a Credit
-
-Click any row to see the credit's full details and its **ledger** - every
-movement of the balance since it was issued, newest first. A credit is
-allocated when created, authorised when a customer starts a checkout with it,
-captured when that order is paid, and voided or credited back if the order is
-cancelled.
-
-## Edit or Delete a Credit
-
-Use **Edit** to change a credit's amount or memo, or **Delete** to remove it.
-Both are in the menu at the end of each row and at the bottom of the credit's
-panel. **Open customer profile** takes you to the customer who holds the
-credit, where the same actions are available. See
-[Issue Store Credits](/user/loyalty/store-credits).
-
-<Note>
-A credit that has been partly or fully used cannot have its amount changed or
-be deleted, because the money has already been spent against an order.
-</Note>
-
-## Related
-
-- [Issue Store Credits](/user/loyalty/store-credits)
-- [Gift Cards](/user/loyalty/gift-cards)
-- [Issue a Gift Card](/user/loyalty/issue-gift-card)
diff --git a/docs/user/loyalty/store-credits.mdx b/docs/user/loyalty/store-credits.mdx
index 16a0ad1712..e71bf0a608 100644
--- a/docs/user/loyalty/store-credits.mdx
+++ b/docs/user/loyalty/store-credits.mdx
@@ -1,53 +1,153 @@
---
-title: "Issue Store Credits"
-description: "Learn how to issue store credits to customers in the Spree admin dashboard."
+title: "Store Credits"
+description: "Learn how to give a customer store credit, track what your store owes, and edit or remove a balance in Spree Commerce."
---
-Store credits allow you to add funds directly to a customer’s account. Unlike gift cards, store credits are tied to a specific customer and cannot be transferred. They are commonly used for refunds, compensation, or loyalty rewards.
+Store credit is an amount of money held on one customer's account, which that customer can spend on a later order. Each store credit carries an amount in one currency, a memo recording why it was given, and a running balance.
-In more advanced use cases, store credits can serve as the primary payment method - particularly in B2B scenarios where customers operate on prepaid balances or agreed credit thresholds that they draw from over time.
+The customer spends store credit at checkout, and the credit's balance falls by the amount used. A store credit is attached to one named customer and cannot be transferred to anyone else. A gift card does a similar job, but a gift card holds its balance against a code that anyone can use. See [<u>Gift Cards</u>](/user/loyalty/gift-cards).
-## How to Issue Store Credits
+Stores issue credit to settle something without returning money to the customer's card: a parcel that arrived late, a damaged item the customer decided to keep, or a price drop the week after they bought. Some B2B stores also use store credit as the way an account pays, topping a balance up and drawing it down over time rather than paying for each order separately.
-You can issue a store credit from two places:
+Store credit also appears without you issuing it. Refunding a return, an exchange or a claim to store credit puts the money on the customer's account instead of back on their card, and a customer redeeming a gift card creates a store credit as well. Every store credit is money your store owes, whatever created it, which is why the Store Credits list totals them for you.
-- **Loyalty → Store Credits** - click **Issue store credit** and choose the
- customer to credit. Use this when you already know who should receive the
- credit and don't want to open their profile first.
-- **Customers → a customer's profile** - click **Issue store credit** in the
- **Store credit** card. The credit goes to that customer.
+To review store credit across every customer, navigate to **Loyalty → Store Credits** in the admin dashboard. To see one customer's store credit, open that customer under **Customers**.
-Both open the same form:
+## Reviewing Store Credits
-- **Customer** - who receives the credit (only asked on the Store Credits page)
-- **Amount** - the value of the store credit
-- **Currency** - which currency the credit is in, if your store sells in more
- than one
-- **Memo** - an optional internal note explaining why you issued the credit
+**Loyalty → Store Credits** lists every store credit in your store, with the total your store owes shown above the list.
-Click **Issue store credit** to save. The balance is available to the customer
-straight away. When you issue from the Store Credits page, the new credit opens
-so you can check it.
+![The Store Credits list, with the outstanding balance cards above it](/docs/images/user/loyalty/store-credits/1-store-credits-overview.png)
-## Edit Store Credits
+### Reading the Outstanding Balance
-1. Open the customer's profile
-2. In the **Store credit** card, open the menu (**⋮**) on the credit's row
-3. Click **Edit**, change the amount or memo, and click **Save**
+Above the table sits one card per currency you have issued credit in. Each card shows three figures:
-You can't change the currency of a credit. Once a customer has spent part of a
-credit, its amount is locked too; only the memo can change.
+| Figure | What it means |
+|---|---|
+| **Outstanding** | What your store still owes. This is the figure that belongs on your books as a liability. |
+| **Issued** | Everything ever put on a store credit in that currency. |
+| **Used** | How much of it customers have already spent. |
-## Delete Store Credits
+These three figures reflect whatever filter is active on the table below. With no filter applied, the cards show what your store owes across every customer. Filter the table by one customer, and the same cards show what that customer holds.
-1. Open the customer's profile
-2. In the **Store credit** card, open the menu (**⋮**) on the credit's row
-3. Click **Delete** and confirm
+<Note>A gift card a customer redeems becomes a store credit, so the Issued figure counts gift card money alongside the credit you issued by hand.</Note>
-<Note>Deleting a store credit permanently removes the balance from the customer's account.</Note>
+### Filtering and Searching
-## See Every Customer's Credit in One Place
+The list can be narrowed by:
-To see what your store owes in total, go to **Loyalty → Store Credits**. See
-[Store Credits List](/user/loyalty/store-credits-list) for how to read and
-filter it.
+| Filter | What it narrows the list by |
+|---|---|
+| **Customer** | The customer who holds the store credit. |
+| **Standing** | Whether the credit still has money on it, or has been fully spent. |
+| **Currency** | The currency the credit is held in. |
+| **Origin** | What created the credit. |
+| **Issued by** | The staff member who created the credit. |
+| **Created** | The date the credit was issued. |
+
+The search box matches the memo, which is the free-text reason written when a credit is issued, or written by the process that created it.
+
+### Where a Credit Came From
+
+The **Origin** column names what created the store credit:
+
+- **Gift card** - A customer redeemed a gift card, and the balance moved onto their account.
+- **Return**, **Exchange**, **Claim** - A post-sale process refunded to store credit rather than to the original payment method.
+- **Issued by hand** - A staff member created the credit directly, usually as compensation or a goodwill gesture. The memo records why.
+
+### Opening a Credit
+
+Click a row to open that store credit's details in a side panel. The panel is for reading: it shows what the credit is and what has happened to it, and changing the credit is a separate form covered in [How to Edit Store Credit](#how-to-edit-store-credit) below.
+
+The top of the panel holds the credit's details:
+
+| Field | What it means |
+|---|---|
+| **Amount** | What the credit was worth when it was created. |
+| **Used** | How much of the credit the customer has already spent. |
+| **On hold** | How much of the credit is being held against an order the customer has started but not completed. |
+| **Remaining** | How much of the credit is still available to spend. |
+| **Currency** | The currency the credit is held in. |
+| **Origin** | What created the credit. |
+| **Issued by** | The staff member who created the credit, when a staff member created it. |
+| **Memo** | The reason recorded when the credit was given. |
+
+Below the details sits the ledger, which lists every movement of that credit's balance since it was created, newest first. A credit is allocated when it is created, authorized when a customer starts a checkout with it, and captured when that order is paid. If the order is canceled, the credit is voided or credited back.
+
+![A store credit's detail panel, showing its fields and the ledger below them](/docs/images/user/loyalty/store-credits/2-store-credit-detail.png)
+
+Three actions sit at the bottom of the panel: **Delete**, **Open customer profile**, which opens the customer who holds the credit, and **Edit**.
+
+### Reviewing One Customer's Credit
+
+Every customer profile page has a **Store credit** card, and the summary across the top of that page carries a **Store credit** figure beside **Total spent** and **Orders**. If a customer has never been given store credit, the card reads "No store credits issued". Once the customer has credit, the card lists one line per credit:
+
+| Column | What it means |
+|---|---|
+| **Amount** | How much was given in this credit. |
+| **Used** | How much of this credit the customer has already spent. |
+| **Remaining** | How much of this credit is still left to spend. |
+| **Memo** | The reason recorded when the credit was given. |
+
+Each line has its own menu at the end of the row, holding the same **Edit** and **Delete** actions as the Store Credits list.
+
+## How to Issue Store Credit
+
+Store credit can be issued from either screen. The form is the same on both, except for one field.
+
+**From the Store Credits list**, click **Issue store credit** in the top-right corner. The form opens with a **Customer** field at the top. Start typing an email address and select the customer from the list.
+
+**From a customer's page**, click **Issue store credit** on their **Store credit** card. The customer is already known, so the form has no **Customer** field.
+
+The rest of the form is the same on both screens:
+
+- **Amount** - How much credit to give. The form cannot be submitted while **Amount** is blank.
+- **Currency** - The currency the credit is held in. **Currency** appears only when your store sells in more than one currency.
+- **Memo** - Why you are giving the credit, such as "Goodwill for a late delivery", or the complaint the credit settles.
+
+![The Issue store credit form filled in with an amount of 25 GBP and a memo](/docs/images/user/loyalty/store-credits/3-issue-store-credit.png)
+
+Click **Issue store credit**. The new credit appears on the customer's **Store credit** card, and the **Store credit** figure at the top of their page goes up by that amount. The customer can spend the balance immediately.
+
+The credit's origin is recorded as issued by hand, along with the staff member who issued it. Both appear on the credit's details in the Store Credits list.
+
+Write a memo every time you issue credit. A balance nobody can explain is hard to defend when the customer, or your accountant, asks about it.
+
+## How to Refund a Return as Store Credit
+
+When you refund a return, you choose whether the money goes back to the original payment method or onto the customer's account as store credit.
+
+1. Open the order. Once the returned items have been received, open the return's menu and choose **Refund**.
+2. Check the **Amount**, which starts at the return's refund total.
+3. Set **Refund to** to **Store credit**, then click **Refund**.
+4. The return is marked **Refunded**, and a new line appears on the customer's **Store credit** card with a memo naming the return. That credit's origin in the Store Credits list reads **Return**.
+
+Creating, approving and receiving a return, which all happen before the refund, are covered in [<u>Returns</u>](/user/orders/returns).
+
+## How to Edit Store Credit
+
+The **Edit** form is where a credit is changed, and it is not the same as the read-only detail panel. Open it from the menu at the end of the credit's row, either on the Store Credits list or on the customer's page, or with **Edit** at the bottom of the credit's detail panel.
+
+- The **amount** and the **memo** can both be changed while none of the credit has been spent.
+- The **currency** can never be changed, on a new store credit or an old one.
+- Once any of the credit has been spent, only the **memo** can be changed, because the money has already gone against an order.
+
+## How to Delete Store Credit
+
+If a store credit was given by mistake, for the wrong amount or to the wrong customer, delete it and issue a fresh one.
+
+1. Open the menu at the end of the credit's row and choose **Delete**.
+2. A box asks you to confirm. Click **Delete**.
+3. The credit is removed, and the **Store credit** figure on the customer's page drops by that amount. If it was the customer's only store credit, the card goes back to "No store credits issued".
+
+A store credit that has been partly or fully spent cannot be deleted, because the money has already gone against an order.
+
+<Warning>Deleting a store credit takes its whole amount off the customer's balance, and removes the line from both the customer's page and the Store Credits list. Check that the customer has not been promised that money before you delete it.</Warning>
+
+## Further Reading
+
+- [<u>Gift Cards</u>](/user/loyalty/gift-cards) - Prepaid codes typed in at checkout, rather than credit held on one account
+- [<u>Customer Profiles</u>](/user/customers/customer-profile) - The rest of the customer page the Store credit card sits on
+- [<u>Returns</u>](/user/orders/returns) - Creating, approving and receiving a return before you refund it
+- [<u>Refunding Orders</u>](/user/orders/processing-orders) - Refunding to the original payment method instead