Files
medusa-store/www/apps/user-guide/app/customers/groups/page.mdx
Shahed Nasser cdfa21cfb0 docs: add user guide tags + sidebar links for commerce modules (#11612)
* add tags

* docs: add tags for user guide + links in commerce modules sidebar

* generate sidebar
2025-02-26 12:08:29 +02:00

135 lines
4.9 KiB
Plaintext
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
---
sidebar_position: 2
sidebar_label: "Manage Customer Groups"
tags:
- user guide
- customer
---
import { EllipsisHorizontal, ArrowUpRightOnBox, EllipsisVertical } from "@medusajs/icons"
export const metadata = {
title: `Manage Customer Groups in Medusa Admin`,
}
# {metadata.title}
In this guide, youll learn how to create and manage customer groups.
## Segment Customers with Customer Groups
A customer group is a way to segment your customers based on certain criteria. You can use customer groups to apply promotions or offer different pricing.
For example, you can create a VIP customer group and offer them a 10% discount on all products. You can also create a wholesale customer group and offer them products at a discounted price for large orders.
### View List of Customer Groups
To view all customer groups, go to the Customers → Customer Groups page. From here, you can see a list, filter, and search through all customer groups.
![Customer Groups List](https://res.cloudinary.com/dza7lstvk/image/upload/v1739888390/User%20Guide/Screenshot_2025-02-18_at_4.19.35_PM_rhhfpx.png)
---
## Create a Customer Group
To create a customer group:
1. Go to the Customers → Customer Groups page.
2. Click the Create button.
3. In the form that opens, enter the customer group's name.
4. Click the Create button.
![Create customer group form](https://res.cloudinary.com/dza7lstvk/image/upload/v1739888496/User%20Guide/Screenshot_2025-02-18_at_4.21.18_PM_xzuzxp.png)
---
## View Customer Group Details
To view the details of a customer group:
1. Go to the Customers → Customer Groups page.
2. Click on the group you want to view.
This opens the customer group's details page.
![Customer group details page](https://res.cloudinary.com/dza7lstvk/image/upload/v1739888618/User%20Guide/Screenshot_2025-02-18_at_4.23.15_PM_g6mzpc.png)
---
## Edit a Customer Group
To edit a customer group:
1. Go to the customer groups details page.
2. Click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the top right of the first section.
3. Click on Edit in the dropdown.
4. In the side window that opens, you can edit the customer group's name.
5. Once youre done, click on the Save button.
![Edit Customer Group](https://res.cloudinary.com/dza7lstvk/image/upload/v1739888705/User%20Guide/Screenshot_2025-02-18_at_4.24.50_PM_qex5xs.png)
---
## Manage Customers in a Group
A customer group can have multiple customers. You can add or remove customers from a customer group.
### Add Customers to a Group
To add customers to a customer group:
1. Go to the customer groups details page.
2. In the Customers section, click the Add button at the top right.
3. Check the customers you want to add to the group.
4. Once you're done, click on the Save button.
![Add Customers to Group](https://res.cloudinary.com/dza7lstvk/image/upload/v1739888804/User%20Guide/Screenshot_2025-02-18_at_4.26.31_PM_oxfcva.png)
### Remove a Customer from a Group
To remove customers from a customer group:
1. Go to the customer groups details page.
2. In the Customers section, check the customers you want to remove from the group.
3. Once you're done, either press <Kbd>R</Kbd> or click Remove at the bottom center of the page.
4. Confirm removing the customers by clicking the Continue button in the pop-up.
![Remove customers from group](https://res.cloudinary.com/dza7lstvk/image/upload/v1739888876/User%20Guide/Screenshot_2025-02-18_at_4.27.42_PM_tghdqi.png)
---
## Edit Customer Group Metadata
Metadata is custom data that can be associated with the customer group in key-value pairs. This is usually used by developers for custom integrations or to store additional information about the customer group.
To edit the customer group's metadata:
1. Go to the customer group's details page.
2. Click the <InlineIcon Icon={ArrowUpRightOnBox} alt="arrow" /> icon at the right of the "Metadata" section.
3. In the side window that opens:
- Manage the key-value pairs in the table.
- To add a new row of key-value pairs before or after a row:
- Hover over the row and click the <InlineIcon Icon={EllipsisVertical} alt="three-dots" /> icon at its right.
- Choose "Insert row above" or "Insert row below" from the dropdown.
- To delete a row of key-value pairs:
- Hover over the row and click the <InlineIcon Icon={EllipsisVertical} alt="three-dots" /> icon at its right.
- Choose "Delete row" from the dropdown.
4. Once you're done, click the Save button.
---
## Delete Customer Group
<Note type="warning">
Deleting a customer group is irreversible. It doesn't delete the customers in the group.
</Note>
To delete a customer group:
1. Go to the customer groups details page.
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the top right of the first section.
3. Choose Delete from the dropdown.
4. Confirm deleting the customer group by clicking the Delete button in the pop-up.