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.

[Skip CI] Added Customer Groups doc (#13470)

jaburghes13fcfd150d9a
diff --git a/docs/docs.json b/docs/docs.json
index 2747119fce..836a152aba 100644
--- a/docs/docs.json
+++ b/docs/docs.json
@@ -1026,7 +1026,8 @@
"user/customers/issue-gift-card",
"user/customers/assign-store-credits",
"user/customers/searching-customers",
- "user/customers/exporting-customers"
+ "user/customers/exporting-customers",
+ "user/customers/customer-groups"
]
},
{
diff --git a/docs/images/user/customers/customer-groups/1-customer-groups.png b/docs/images/user/customers/customer-groups/1-customer-groups.png
new file mode 100644
index 0000000000..d5ab535b8e
Binary files /dev/null and b/docs/images/user/customers/customer-groups/1-customer-groups.png differ
diff --git a/docs/images/user/customers/customer-groups/2-customer-group-form.png b/docs/images/user/customers/customer-groups/2-customer-group-form.png
new file mode 100644
index 0000000000..96e09c6633
Binary files /dev/null and b/docs/images/user/customers/customer-groups/2-customer-group-form.png differ
diff --git a/docs/images/user/customers/customer-groups/3-customer-group-edit.png b/docs/images/user/customers/customer-groups/3-customer-group-edit.png
new file mode 100644
index 0000000000..719432cb76
Binary files /dev/null and b/docs/images/user/customers/customer-groups/3-customer-group-edit.png differ
diff --git a/docs/images/user/customers/customer-groups/4-add-customers.png b/docs/images/user/customers/customer-groups/4-add-customers.png
new file mode 100644
index 0000000000..0daf1af767
Binary files /dev/null and b/docs/images/user/customers/customer-groups/4-add-customers.png differ
diff --git a/docs/images/user/customers/customer-groups/5-customers-added.png b/docs/images/user/customers/customer-groups/5-customers-added.png
new file mode 100644
index 0000000000..a5d7e0deac
Binary files /dev/null and b/docs/images/user/customers/customer-groups/5-customers-added.png differ
diff --git a/docs/user/customers/customer-groups.mdx b/docs/user/customers/customer-groups.mdx
new file mode 100644
index 0000000000..3f9c5f3123
--- /dev/null
+++ b/docs/user/customers/customer-groups.mdx
@@ -0,0 +1,51 @@
+---
+title: "Customer Groups"
+description: "Learn to how to set up customer groups in Spree Commerce."
+---
+
+Customer Groups let you segment your customers into defined lists, which can then be used to personalize pricing, limit access to promotions, or power other business rules.
+
+They’re especially useful when used with:
+
+- **Price List Rules** - apply custom pricing to specific customer groups.
+- **Promotion Rules** - restrict eligibility to certain customer segments (e.g. wholesale, VIP, B2B).
+
+## Create a Customer Group
+
+To create a new customer group, navigate to **Customers → Customer Groups** in the admin dashboard.
+
+![The Customer Groups tab in Spree Commerce](/docs/images/user/customers/customer-groups/1-customer-groups.png)
+
+Here you’ll see an overview of all existing customer groups, including the number of customers in each.
+
+Click the **New Customer Group** button in the top right to begin setup.
+
+## Add Group Details
+
+![Adding a new customer group in Spree Commerce](/docs/images/user/customers/customer-groups/2-customer-group-form.png)
+
+In the creation form, add:
+
+- Name - This is how the group will appear in admin interfaces
+- Description - Use this field to describe the purpose of the group, e.g. “North America wholesale buyers” or “Early access testers” (optional)
+
+Click **Create** to save the new group.
+
+## Add Customers to the Group
+
+![Customer group overview in Spree Commerce](/docs/images/user/customers/customer-groups/3-customer-group-edit.png)
+
+Once the group is created, you’ll be taken to its detail view.
+
+To add customers to the group, click the **Add Customers** button, and a side panel will open where you can search and select customers to add.
+
+![Adding customers to a customer group in Spree Commerce](/docs/images/user/customers/customer-groups/4-add-customers.png)
+
+Check the boxes next to the customers you want to add, then click **Add Selected**.
+
+![An active customer group in Spree Commerce](/docs/images/user/customers/customer-groups/5-customers-added.png)
+
+That’s all there is to it - your customer group is now ready to use in promotions, price lists, and more.
+
+## Remove Customers from a Group
+To remove customers from a group, simply select the checkboxes next to the customers you want to remove, then click **Remove from Group** in the actions menu at the bottom of the screen.