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.

Updated 'Export Customers' and 'Editing Customers' user docs (#13621)

jaburghesa7f6bf9db7ef
diff --git a/docs/images/user/customers/editing-customers/1-customers-tab.png b/docs/images/user/customers/editing-customers/1-customers-tab.png
new file mode 100644
index 0000000000..ca1243b604
Binary files /dev/null and b/docs/images/user/customers/editing-customers/1-customers-tab.png differ
diff --git a/docs/images/user/customers/editing-customers/2-customer-profile.png b/docs/images/user/customers/editing-customers/2-customer-profile.png
new file mode 100644
index 0000000000..300006180c
Binary files /dev/null and b/docs/images/user/customers/editing-customers/2-customer-profile.png differ
diff --git a/docs/images/user/customers/editing-customers/3-contact-details.png b/docs/images/user/customers/editing-customers/3-contact-details.png
new file mode 100644
index 0000000000..5a431a5a11
Binary files /dev/null and b/docs/images/user/customers/editing-customers/3-contact-details.png differ
diff --git a/docs/images/user/customers/editing-customers/4-shipping-address.png b/docs/images/user/customers/editing-customers/4-shipping-address.png
new file mode 100644
index 0000000000..bf46f90356
Binary files /dev/null and b/docs/images/user/customers/editing-customers/4-shipping-address.png differ
diff --git a/docs/images/user/customers/editing-customers/5-billing-address.png b/docs/images/user/customers/editing-customers/5-billing-address.png
new file mode 100644
index 0000000000..7eaf771e50
Binary files /dev/null and b/docs/images/user/customers/editing-customers/5-billing-address.png differ
diff --git a/docs/images/user/customers/editing-customers/6-internal-note.png b/docs/images/user/customers/editing-customers/6-internal-note.png
new file mode 100644
index 0000000000..1cb6ff25f7
Binary files /dev/null and b/docs/images/user/customers/editing-customers/6-internal-note.png differ
diff --git a/docs/images/user/customers/editing-customers/7-gift-cards.png b/docs/images/user/customers/editing-customers/7-gift-cards.png
new file mode 100644
index 0000000000..26d9e05981
Binary files /dev/null and b/docs/images/user/customers/editing-customers/7-gift-cards.png differ
diff --git a/docs/images/user/customers/editing-customers/8-store-credit.png b/docs/images/user/customers/editing-customers/8-store-credit.png
new file mode 100644
index 0000000000..57306047da
Binary files /dev/null and b/docs/images/user/customers/editing-customers/8-store-credit.png differ
diff --git a/docs/images/user/customers/exporting-customers/1-customers-tab.png b/docs/images/user/customers/exporting-customers/1-customers-tab.png
new file mode 100644
index 0000000000..ca1243b604
Binary files /dev/null and b/docs/images/user/customers/exporting-customers/1-customers-tab.png differ
diff --git a/docs/images/user/customers/exporting-customers/2-export-customers.png b/docs/images/user/customers/exporting-customers/2-export-customers.png
new file mode 100644
index 0000000000..7c8e8c5a19
Binary files /dev/null and b/docs/images/user/customers/exporting-customers/2-export-customers.png differ
diff --git a/docs/user/customers/edit-customer.mdx b/docs/user/customers/edit-customer.mdx
index f84957485c..da5dc18df5 100644
--- a/docs/user/customers/edit-customer.mdx
+++ b/docs/user/customers/edit-customer.mdx
@@ -1,44 +1,93 @@
---
-title: "Edit a Customer"
-description: "In this Spree user doc, you'll learn how to edit existing customers' data."
+title: "Editing Customers"
+description: "Learn how to edit customer profiles in the Spree Commerce admin dashboard."
---
-Occasionally, you may need to edit a customer’s profile to update contact details, addresses, or preferences for accurate order fulfillment and communication. This is especially common if your sales process frequently includes off-site or manual order entries.
+You may need to edit a customer’s profile to correct contact details, update addresses, manage tags, or adjust account-related settings. This is especially common when handling phone orders, B2B accounts, or customer support requests.
-To edit a customer’s profile, navigate to the Customers tab of the admin dashboard.
+## How to Edit a Customer
-<img alt="Edit a Customer" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1747651949/docs/Customers/Edit%20a%20Customer/5.3.1.1_Edit_a_Customer_-_Navigate_To_Tab_lgyf5q.png" />
+To edit a customer, navigate to **Customers** in the admin dashboard.
-Find and click on the customer you’d like to edit and you’ll be redirected to their Customer Profile page.
+![How to edit a customer profile in Spree Commerce](/docs/images/user/customers/editing-customers/1-customers-tab.png)
-<img alt="Edit a Customer" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/v1747651950/docs/Customers/Edit%20a%20Customer/5.3.1.2_Edit_a_Customer_-_Customer_Profile_ojckzh.png" />
+Find and click the customer you’d like to update to open their **Customer Profile** page.
-The following information can be edited:
+![The customer profile overview in the Spree dashboard](/docs/images/user/customers/editing-customers/2-customer-profile.png)
+
+From here, there are several sections of the customer profile that you may edit when necessary.
## Contact Details
-<img alt="Edit a Customer" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1747651949/docs/Customers/Edit%20a%20Customer/5.3.1.3_Edit_a_Customer_-_Contact_Details_pqhrpw.png" />
+![Customer contact details section in the Spree dashboard](/docs/images/user/customers/editing-customers/3-contact-details.png)
+
+In the **Details** section, click **Edit** to open the edit form and modify:
-Here you can update the following:
+- Email address
+- Phone number
+- First and last name
+- Email marketing opt-in / opt-out status
+- Tags
+- Customer Group (if applicable)
-- Email Address
-- Phone Number
-- First & Last Name
-- Email marketing opt-in/opt-out
-- Add/remove tags
+Click **Save** to apply your changes.
## Shipping Address
-<img alt="Edit a Customer" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1747651949/docs/Customers/Edit%20a%20Customer/5.3.1.3_Edit_a_Customer_-_Contact_Details_pqhrpw.png" />
+![Editing the customers shipping address in the Spree dashboard](/docs/images/user/customers/editing-customers/4-shipping-address.png)
-Here you can edit the default shipping address of the customer.
+In the **Shipping Address** section, click **Edit** to reveal the address editor form, and update the customer’s default shipping address as required.
-Note: Updating the shipping address in the customer profile will not change the shipping address on any outstanding orders. If you’d like to update the shipping address for the order, you must do it from the Orders tab.
+<Note>Updating the shipping address in the customer profile does not change the address on existing or outstanding orders. To modify an order’s shipping address, edit the order directly from the **Orders** tab.</Note>
## Billing Address
-<img alt="Edit a Customer" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1747651948/docs/Customers/Edit%20a%20Customer/5.3.1.5_Edit_a_Customer_-_Billing_Address_rmkcgw.png" />
+![Editing the customer billing address in the Spree dashboard](/docs/images/user/customers/editing-customers/5-billing-address.png)
+
+In the **Billing Address** section, click **Edit** to modify the customer’s default billing address.
+
+You’ll then be able to choose between:
+
+- **Same as shipping address**, or
+- **Add a new address**
+
+Selecting **Add a new address** will reveal the address form, where you can enter the updated billing details. Click **Update** to apply your changes.
+
+<Note>As with shipping addresses, updating the billing address here will not affect existing orders.</Note>
+
+## Internal Notes
+
+![Adding an internal note to a customer profile in Spree Commerce](/docs/images/user/customers/editing-customers/6-internal-note.png)
+
+The **Internal Note** section allows admins to leave private notes about a customer (for example, special handling instructions, account context, or support history).
+
+To add or update an internal note:
+
+1. Click **Edit** in the Internal Note section
+2. Enter your note
+3. Click **Save**
+
+<Note>Internal notes are only visible to admins and are never shown on the storefront.</Note>
+
+## Issue Gift Cards
+
+![Issuing a gift card to a customer in Spree Commerce](/docs/images/user/customers/editing-customers/7-gift-cards.png)
+
+You can issue a gift card directly from the customer profile.
+
+Click the **three-dot menu** in the top right corner and select **Add Gift Card**.
+
+For detailed instructions, refer to the [<u>Issue a Gift Card</u>](https://spreecommerce.org/docs/user/customers/issue-gift-card) support article.
+
+## Issue Store Credits
+
+![Issuing store credits to a customer in Spree Commerce](/docs/images/user/customers/editing-customers/8-store-credit.png)
+
+You can also assign store credit to a customer account.
+
+Either:
-Here you can edit the default billing address of the customer.
+- Click the **three-dot menu** and **Add Store Credit**, or
+- Use the **Add Store Credit** button in the analytics section at the top of the profile.
-Note: Updating the billing address in the customer profile will not change the billing address on any outstanding orders. If you’d like to update the billing address for the order, you must do it from the Orders tab.
\ No newline at end of file
+For step-by-step guidance, see the [<u>Issue Store Credits</u>](https://spreecommerce.org/docs/user/customers/assign-store-credits) support article.
diff --git a/docs/user/customers/exporting-customers.mdx b/docs/user/customers/exporting-customers.mdx
index d04abb7ae4..1d3f6ea2ad 100644
--- a/docs/user/customers/exporting-customers.mdx
+++ b/docs/user/customers/exporting-customers.mdx
@@ -1,26 +1,48 @@
---
-title: "Exporting Customers"
-description: "In this Spree user doc, you'll learn how to export your customer database."
+title: "Export Customers"
+description: "Learn how to export customers records to CSV in Spree Commerce."
---
-Exporting customer data is useful for generating reports, segmenting customer data, or integrating with external tools like email marketing platforms. This makes it easier to analyze customer trends, track engagement, and manage business operations efficiently.
+In Spree you can, export your customer database for reporting, segmentation, or integration with external tools such as email marketing platforms or CRM systems.
-To export customer data, navigate to the Customers tab of the admin dashboard.
+Doing so can make it easier to analyze trends, review engagement, and manage customer relationships outside of Spree when needed.
-<img alt="Exporting Customers" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1747661500/docs/Customers/Exporting%20Customers/5.5.1_Exporting_Customers_-_Navigate_To_Tab_g3nyig.png" />
+## How to Export Customers
-## Apply Filters
+To export customers, navigate to **Customers** in the admin dashboard.
-If you intend to export a segment of the customer base rather than the entire list, you should first apply filters such as location, tags, etc.
+![How to export customers in Spree Commerce](/docs/images/user/customers/exporting-customers/1-customers-tab.png)
-<img alt="Exporting Customers" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1747661498/docs/Customers/Exporting%20Customers/5.5.2_Exporting_Customers_-_Apply_Filters_ont7vk.png" />
+From here you may optionally apply filters and export the records you require.
-Note: If you don’t apply any filters,
+### Apply Filters
-## Export
+If you want to export a specific segment rather than your entire customer list, apply filters before exporting.
-When you’re ready to export the data, simply click ‘Export’ in the top right corner and the results will be emailed to the email address associated with your admin account.
+You can use the **Filters** button to narrow results by fields such as:
-<img alt="Exporting Customers" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1747661440/docs/Customers/Exporting%20Customers/5.5.3_Exporting_Customers_-_Click_Export_dcwjuy.png" />
+- Email marketing (opt-in status)
+- Location
+- Created at / Updated at
+- First Name
+- Last Name
+- Tags
-Note: You can also access all historical exports in the Audit Log tab of the Settings menu.
\ No newline at end of file
+To learn more about filters, refer to our [<u>Searching Customers</u>](https://spreecommerce.org/docs/user/customers/searching-customers) article.
+
+<Note>If no filters are applied, the export will include all customers, regardless of your choice in the next step.</Note>
+
+### Export
+
+![Exporting vustomers in the Spree Commerce dashboard](/docs/images/user/customers/exporting-customers/2-export-customers.png)
+
+Once your desired view is set, click **Export** in the top-right corner.
+
+You’ll be prompted to confirm whether you want to export:
+
+- **Filtered records** (only the customers currently shown), or
+- **All records**
+
+After confirming, a CSV file will be generated and sent to the email address associated with your admin account.
+
+<Note>Using filters before exporting allows you to create targeted customer lists for campaigns, reporting, or operational needs.</Note>