Skip to content

Commit 7f7316c

Browse files
authored
docs: update customers user guide (medusajs#11512)
1 parent 25a7826 commit 7f7316c

File tree

7 files changed

+222
-51
lines changed

7 files changed

+222
-51
lines changed

www/apps/user-guide/app/customers/groups/page.mdx

+59-17
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,29 @@
22
sidebar_position: 2
33
---
44

5-
import { EllipsisHorizontal } from "@medusajs/icons"
5+
import { EllipsisHorizontal, ArrowUpRightOnBox, EllipsisVertical } from "@medusajs/icons"
66

77
export const metadata = {
88
title: `Manage Customer Groups`,
99
}
1010

1111
# {metadata.title}
1212

13-
In this document, you’ll learn how to manage customer groups, including customers in these groups.
13+
In this guide, you’ll learn how to create and manage customer groups.
14+
15+
## Segment Customers with Customer Groups
16+
17+
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.
18+
19+
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.
20+
21+
### View List of Customer Groups
22+
23+
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.
24+
25+
![Customer Groups List](https://res.cloudinary.com/dza7lstvk/image/upload/v1739888390/User%20Guide/Screenshot_2025-02-18_at_4.19.35_PM_rhhfpx.png)
26+
27+
---
1428

1529
## Create a Customer Group
1630

@@ -21,6 +35,8 @@ To create a customer group:
2135
3. In the form that opens, enter the customer group's name.
2236
4. Click the Create button.
2337

38+
![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)
39+
2440
---
2541

2642
## View Customer Group Details
@@ -30,6 +46,10 @@ To view the details of a customer group:
3046
1. Go to the Customers → Customer Groups page.
3147
2. Click on the group you want to view.
3248

49+
This opens the customer group's details page.
50+
51+
![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)
52+
3353
---
3454

3555
## Edit a Customer Group
@@ -39,45 +59,66 @@ To edit a customer group:
3959
1. Go to the customer group’s details page.
4060
2. Click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the top right of the first section.
4161
3. Click on Edit in the dropdown.
42-
4. In the drawer that opens, edit the group's name.
43-
5. Once you’re done, click on the Edit Group button.
62+
4. In the side window that opens, you can edit the customer group's name.
63+
5. Once you’re done, click on the Save button.
64+
65+
![Edit Customer Group](https://res.cloudinary.com/dza7lstvk/image/upload/v1739888705/User%20Guide/Screenshot_2025-02-18_at_4.24.50_PM_qex5xs.png)
4466

4567
---
4668

4769
## Manage Customers in a Group
4870

49-
### View List of Customers in a Group
50-
51-
To view the list of customers in a customer group:
52-
53-
1. Go to the customer group’s details page.
54-
2. Under the Customers section, you’ll find all customers that belong to this customer group.
71+
A customer group can have multiple customers. You can add or remove customers from a customer group.
5572

5673
### Add Customers to a Group
5774

5875
To add customers to a customer group:
5976

6077
1. Go to the customer group’s details page.
61-
2. Under the Customers section, click the Add button at the top right.
62-
3. Check the box next to every customer you want to add to the group.
63-
4. Once you're done, click on the Add button.
78+
2. In the Customers section, click the Add button at the top right.
79+
3. Check the customers you want to add to the group.
80+
4. Once you're done, click on the Save button.
81+
82+
![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)
6483

6584
### Remove a Customer from a Group
6685

6786
To remove customers from a customer group:
6887

6988
1. Go to the customer group’s details page.
70-
2. Under the Customer section, click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon next to the customer you want to remove from the group.
71-
3. Choose Remove from the dropdown.
72-
4. Confirm removing the customer by clicking the Continue button in the pop-up.
89+
2. In the Customers section, check the customers you want to remove from the group.
90+
3. Once you're done, either press <Kbd>R</Kbd> or click Remove at the bottom center of the page.
91+
4. Confirm removing the customers by clicking the Continue button in the pop-up.
92+
93+
![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)
94+
95+
---
96+
97+
## Edit Customer Group Metadata
98+
99+
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.
100+
101+
To edit the customer group's metadata:
102+
103+
1. Go to the customer group's details page.
104+
2. Click the <InlineIcon Icon={ArrowUpRightOnBox} alt="arrow" /> icon at the right of the "Metadata" section.
105+
3. In the side window that opens:
106+
- Manage the key-value pairs in the table.
107+
- To add a new row of key-value pairs before or after a row:
108+
- Hover over the row and click the <InlineIcon Icon={EllipsisVertical} alt="three-dots" /> icon at its right.
109+
- Choose "Insert row above" or "Insert row below" from the dropdown.
110+
- To delete a row of key-value pairs:
111+
- Hover over the row and click the <InlineIcon Icon={EllipsisVertical} alt="three-dots" /> icon at its right.
112+
- Choose "Delete row" from the dropdown.
113+
4. Once you're done, click the Save button.
73114

74115
---
75116

76117
## Delete Customer Group
77118

78119
<Note type="warning">
79120

80-
Deleting a customer group is irreversible.
121+
Deleting a customer group is irreversible. It doesn't delete the customers in the group.
81122

82123
</Note>
83124

@@ -86,3 +127,4 @@ To delete a customer group:
86127
1. Go to the customer group’s details page.
87128
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the top right of the first section.
88129
3. Choose Delete from the dropdown.
130+
4. Confirm deleting the customer group by clicking the Delete button in the pop-up.

www/apps/user-guide/app/customers/manage/page.mdx

+116-10
Original file line numberDiff line numberDiff line change
@@ -2,25 +2,29 @@
22
sidebar_position: 1
33
---
44

5-
import { EllipsisHorizontal } from "@medusajs/icons"
5+
import { EllipsisHorizontal, ArrowUpRightOnBox, EllipsisVertical } from "@medusajs/icons"
66

77
export const metadata = {
88
title: `Manage Customers`,
99
}
1010

1111
# {metadata.title}
1212

13-
In this document, you’ll learn how to manage customers and their details.
13+
In this guide, you’ll learn how to create and manage customers and their details.
1414

1515
## Create a Customer
1616

17-
To create a customer:
17+
You can create a customer through the Medusa Admin, which is useful if a customer is creating an order offline. The customer will be a guest customer; to register, the customer must register through the storefront.
18+
19+
To create a customer from the Medusa Admin:
1820

1921
1. Go to the Customers page.
20-
2. Click the Create button.
21-
3. In the form that opens, enter the customer's details such as first and last name, email, and password.
22+
2. Click the Create button at the top right.
23+
3. In the form that opens, enter the customer's email, and optionally their first and last name, company name, and phone number.
2224
4. Once you're done, click the Create button.
2325

26+
![Create Customer Form](https://res.cloudinary.com/dza7lstvk/image/upload/v1739886786/User%20Guide/Screenshot_2025-02-18_at_3.52.54_PM_phbhjy.png)
27+
2428
---
2529

2630
## View Customer Details
@@ -30,23 +34,125 @@ To view a customer’s details:
3034
1. Go to the Customers page.
3135
2. Click on the customer you want to view.
3236

37+
![Customers Detail Page](https://res.cloudinary.com/dza7lstvk/image/upload/v1739886949/User%20Guide/Screenshot_2025-02-18_at_3.55.21_PM_omxw5x.png)
38+
3339
---
3440

3541
## Edit Customer Details
3642

43+
<Note>
44+
45+
You can't edit a customer's password from the Medusa Admin. The customer has to reset it from the storefront.
46+
47+
</Note>
48+
3749
To edit a customer’s details:
3850

39-
1. Go to a Customer’s details page.
51+
1. Go to a customer’s details page.
4052
2. Click on the <InlineIcon Icon={EllipsisHorizontal} alt="three dots" /> icon in the first section.
4153
3. Choose Edit from the dropdown.
42-
4. In the drawer that opens, edit the customer’s details.
54+
4. In the side window that opens, you can edit the customer's email, first and last name, company name, and phone number.
4355
5. Once you’re done, click the Save button.
4456

57+
![Edit Customer Form](https://res.cloudinary.com/dza7lstvk/image/upload/v1739887419/User%20Guide/Screenshot_2025-02-18_at_4.03.27_PM_r7vb4o.png)
58+
4559
---
4660

4761
## View Customer Orders
4862

49-
To view the orders of a customer:
63+
You can view a customer’s orders from their details page in the Orders section. By clicking on an order, you can view its details.
64+
65+
### Transfer Order to Another Customer
66+
67+
You can transfer an order to another customer. For example, a guest customer registered, or a customer created an order offline.
68+
69+
When you transfer the ownership of an order, the original customer will receive a notification, such as an email, requesting their approval for the transfer. The order is transferred to the new customer only after the original customer approves the transfer.
70+
71+
<Note>
72+
73+
You can't transfer ownership to a guest customer, and that includes customers you create through the admin dashboard.
74+
75+
</Note>
76+
77+
To transfer a customer's order ownership to another:
78+
79+
1. Go to the customer's details page.
80+
2. In the Orders section, click on the <InlineIcon Icon={EllipsisHorizontal} alt="three dots" /> icon on the right of the order.
81+
3. Choose Transfer ownership from the dropdown.
82+
4. In the side window that opens, choose the customer to transfer the order to in the "New owner" field.
83+
5. Once you're done, click the Save button.
84+
85+
The original customer will then receive a notification requesting their approval for the transfer.
86+
87+
<Note>
88+
89+
If a notification isn't sent, check with your technical team to debug the integrated notification service.
90+
91+
</Note>
92+
93+
![Transfer ownership form](https://res.cloudinary.com/dza7lstvk/image/upload/v1739887736/User%20Guide/Screenshot_2025-02-18_at_4.08.41_PM_ebkblt.png)
94+
95+
---
96+
97+
## Manage Customer's Groups
98+
99+
You can add a customer to multiple groups, allowing you to offer different promotions or pricing based on the group they belong to.
100+
101+
### Add Customer to Groups
102+
103+
To add a customer to customer groups:
104+
105+
1. Go to the customer's details page.
106+
2. In the "Customer Groups" section, click on the "Add" button.
107+
3. In the list that opens, check the groups you want to add the customer to.
108+
4. Once you're done, click the Save button.
109+
110+
![Add groups form](https://res.cloudinary.com/dza7lstvk/image/upload/v1739888065/User%20Guide/Screenshot_2025-02-18_at_4.14.13_PM_jntqs2.png)
111+
112+
### Remove Customer from Groups
113+
114+
To remove a customer from customer groups:
115+
116+
1. Go to the customer's details page.
117+
2. In the "Customer Groups" section, check the groups you want to remove the customer from.
118+
3. Once you're done, either press <Kbd>R</Kbd> or click "Remove" at the bottom center of the page.
119+
4. Confirm removing the groups by clicking the "Remove" button in the pop-up.
120+
121+
![Remove customer from groups](https://res.cloudinary.com/dza7lstvk/image/upload/v1739888155/User%20Guide/Screenshot_2025-02-18_at_4.15.44_PM_ieqngf.png)
122+
123+
---
124+
125+
## Edit Customer Metadata
126+
127+
Metadata is custom data that can be associated with the customer in key-value pairs. This is usually used by developers for custom integrations or to store additional information about the customer.
128+
129+
To edit the customer's metadata:
130+
131+
1. Go to the customer's details page.
132+
2. Click the <InlineIcon Icon={ArrowUpRightOnBox} alt="arrow" /> icon at the right of the "Metadata" section.
133+
3. In the side window that opens:
134+
- Manage the key-value pairs in the table.
135+
- To add a new row of key-value pairs before or after a row:
136+
- Hover over the row and click the <InlineIcon Icon={EllipsisVertical} alt="three-dots" /> icon at its right.
137+
- Choose "Insert row above" or "Insert row below" from the dropdown.
138+
- To delete a row of key-value pairs:
139+
- Hover over the row and click the <InlineIcon Icon={EllipsisVertical} alt="three-dots" /> icon at its right.
140+
- Choose "Delete row" from the dropdown.
141+
4. Once you're done, click the Save button.
142+
143+
---
144+
145+
## Delete a Customer
146+
147+
<Note type="warning">
148+
149+
Deleting a customer is irreversible.
150+
151+
</Note>
152+
153+
To delete a customer:
50154

51-
1. Go to a Customer’s details page.
52-
2. Find the customer's orders under the Orders section.
155+
1. Go to the customer's details page.
156+
2. Click on the <InlineIcon Icon={EllipsisHorizontal} alt="three dots" /> icon at the top right of the first section.
157+
3. Choose Delete from the dropdown.
158+
4. In the pop-up, enter the customer's email and click the "Delete" button.

www/apps/user-guide/app/customers/page.mdx

+10-12
Original file line numberDiff line numberDiff line change
@@ -3,32 +3,30 @@ sidebar_autogenerate_exclude: true
33
---
44

55
export const metadata = {
6-
title: `Customers`,
6+
title: `Customers Overview`,
77
}
88

99
# {metadata.title}
1010

11-
In this document, you’ll get an overview of the customer listing page.
11+
The Customers domain allows you to manage customers and customer groups in your commerce store.
1212

13-
## Overview
13+
You can manage both customers that have registered in your store and guest customers that have placed an order. You can also segment these customers into groups to offer them specific [promotions](../discounts/page.mdx) and [pricing](../pricing/page.mdx).
1414

15-
The Customers page shows you the list of registered customers in your store. For each of those customers, view details such as their orders, or personal information.
15+
You can view the list of customers in your commerce store by clicking on Customers from the sidebar menu.
1616

17-
Part of the Customers domain is also Customer Groups. Customer groups allow you to put together a set of customers for business purposes.
17+
In the list, you can see customer details such as the email, name, and account type. You can also search, filter, and sort the customers to find the specific one you are looking for.
1818

19-
For example, you can create a VIP customer group for customers that you want to give special discounts.
19+
<Note title="Tip">
2020

21-
---
22-
23-
## View List of Customer Groups
21+
Find tips to use lists effectively in [this guide](../tips/lists/page.mdx).
2422

25-
To view the list of customer groups, go to the Customers page, then go to the Customer Groups sub-item in the sidebar.
23+
</Note>
2624

27-
On the Customer Groups page, you'll find the list of customer groups with their details.
25+
![Customers List](https://res.cloudinary.com/dza7lstvk/image/upload/v1739886647/User%20Guide/Screenshot_2025-02-18_at_3.50.29_PM_wq7m1k.png)
2826

2927
---
3028

31-
## Learn More About Customers
29+
## Manage Customers
3230

3331
- [Manage and View a Customer’s Details](./manage/page.mdx)
3432
- [Manage and View a Customer Group](./groups/page.mdx)

www/apps/user-guide/app/orders/manage/page.mdx

+6
Original file line numberDiff line numberDiff line change
@@ -160,6 +160,12 @@ To transfer the ownership of an order to another customer:
160160

161161
The original customer will then receive a notification requesting their approval for the transfer.
162162

163+
<Note>
164+
165+
If a notification isn't sent, check with your technical team to debug the integrated notification service.
166+
167+
</Note>
168+
163169
![Transfer Ownership Form](https://res.cloudinary.com/dza7lstvk/image/upload/v1739546904/User%20Guide/Screenshot_2025-02-14_at_5.28.12_PM_brwpek.png)
164170

165171
---

www/apps/user-guide/generated/edit-dates.mjs

+4-4
Original file line numberDiff line numberDiff line change
@@ -36,17 +36,17 @@ export const generatedEditDates = {
3636
"app/settings/sales-channels/products/page.mdx": "2024-05-03T17:36:38+03:00",
3737
"app/settings/developer/executions/page.mdx": "2024-05-03T17:36:38+03:00",
3838
"app/inventory/inventory/page.mdx": "2025-02-18T13:59:16.960Z",
39-
"app/customers/groups/page.mdx": "2024-05-03T17:36:38+03:00",
40-
"app/orders/manage/page.mdx": "2025-02-17T10:29:36.199Z",
39+
"app/customers/groups/page.mdx": "2025-02-18T15:41:30.730Z",
40+
"app/orders/manage/page.mdx": "2025-02-18T15:38:17.544Z",
4141
"app/orders/returns/page.mdx": "2025-02-17T15:10:11.039Z",
4242
"app/inventory/page.mdx": "2025-02-18T13:58:42.393Z",
4343
"app/settings/sales-channels/manage/page.mdx": "2024-05-03T17:36:38+03:00",
4444
"app/orders/claims/page.mdx": "2025-02-17T15:16:27.380Z",
4545
"app/orders/fulfillments/page.mdx": "2025-02-17T15:12:20.431Z",
46-
"app/customers/page.mdx": "2025-02-18T13:56:28.134Z",
46+
"app/customers/page.mdx": "2025-02-18T15:38:17.543Z",
4747
"app/orders/edit/page.mdx": "2025-02-17T15:15:53.489Z",
4848
"app/products/collections/page.mdx": "2025-02-18T14:00:51.469Z",
49-
"app/customers/manage/page.mdx": "2025-02-18T13:56:28.134Z",
49+
"app/customers/manage/page.mdx": "2025-02-18T15:38:17.543Z",
5050
"app/discounts/create/page.mdx": "2024-05-03T17:36:38+03:00",
5151
"app/orders/payments/page.mdx": "2025-02-17T15:10:24.250Z",
5252
"app/discounts/page.mdx": "2024-05-03T17:36:38+03:00",

0 commit comments

Comments
 (0)