diff --git a/www/apps/user-guide/app/customers/groups/page.mdx b/www/apps/user-guide/app/customers/groups/page.mdx index d61e169acf..fa5f818dde 100644 --- a/www/apps/user-guide/app/customers/groups/page.mdx +++ b/www/apps/user-guide/app/customers/groups/page.mdx @@ -2,7 +2,7 @@ sidebar_position: 2 --- -import { EllipsisHorizontal } from "@medusajs/icons" +import { EllipsisHorizontal, ArrowUpRightOnBox, EllipsisVertical } from "@medusajs/icons" export const metadata = { title: `Manage Customer Groups`, @@ -10,7 +10,21 @@ export const metadata = { # {metadata.title} -In this document, you’ll learn how to manage customer groups, including customers in these groups. +In this guide, you’ll 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 @@ -21,6 +35,8 @@ To create a customer group: 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 @@ -30,6 +46,10 @@ 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 @@ -39,37 +59,58 @@ To edit a customer group: 1. Go to the customer group’s details page. 2. Click on the icon at the top right of the first section. 3. Click on Edit in the dropdown. -4. In the drawer that opens, edit the group's name. -5. Once you’re done, click on the Edit Group button. +4. In the side window that opens, you can edit the customer group's name. +5. Once you’re 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 -### View List of Customers in a Group - -To view the list of customers in a customer group: - -1. Go to the customer group’s details page. -2. Under the Customers section, you’ll find all customers that belong to this customer 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 group’s details page. -2. Under the Customers section, click the Add button at the top right. -3. Check the box next to every customer you want to add to the group. -4. Once you're done, click on the Add button. +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 group’s details page. -2. Under the Customer section, click the icon next to the customer you want to remove from the group. -3. Choose Remove from the dropdown. -4. Confirm removing the customer by clicking the Continue button in the pop-up. +2. In the Customers section, check the customers you want to remove from the group. +3. Once you're done, either press R 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 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 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 icon at its right. + - Choose "Delete row" from the dropdown. +4. Once you're done, click the Save button. --- @@ -77,7 +118,7 @@ To remove customers from a customer group: -Deleting a customer group is irreversible. +Deleting a customer group is irreversible. It doesn't delete the customers in the group. @@ -86,3 +127,4 @@ To delete a customer group: 1. Go to the customer group’s details page. 2. Click the 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. diff --git a/www/apps/user-guide/app/customers/manage/page.mdx b/www/apps/user-guide/app/customers/manage/page.mdx index 8a855dc357..9f9096e296 100644 --- a/www/apps/user-guide/app/customers/manage/page.mdx +++ b/www/apps/user-guide/app/customers/manage/page.mdx @@ -2,7 +2,7 @@ sidebar_position: 1 --- -import { EllipsisHorizontal } from "@medusajs/icons" +import { EllipsisHorizontal, ArrowUpRightOnBox, EllipsisVertical } from "@medusajs/icons" export const metadata = { title: `Manage Customers`, @@ -10,17 +10,21 @@ export const metadata = { # {metadata.title} -In this document, you’ll learn how to manage customers and their details. +In this guide, you’ll learn how to create and manage customers and their details. ## Create a Customer -To create a customer: +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. + +To create a customer from the Medusa Admin: 1. Go to the Customers page. -2. Click the Create button. -3. In the form that opens, enter the customer's details such as first and last name, email, and password. +2. Click the Create button at the top right. +3. In the form that opens, enter the customer's email, and optionally their first and last name, company name, and phone number. 4. Once you're done, click the Create button. +![Create Customer Form](https://res.cloudinary.com/dza7lstvk/image/upload/v1739886786/User%20Guide/Screenshot_2025-02-18_at_3.52.54_PM_phbhjy.png) + --- ## View Customer Details @@ -30,23 +34,125 @@ To view a customer’s details: 1. Go to the Customers page. 2. Click on the customer you want to view. +![Customers Detail Page](https://res.cloudinary.com/dza7lstvk/image/upload/v1739886949/User%20Guide/Screenshot_2025-02-18_at_3.55.21_PM_omxw5x.png) + --- ## Edit Customer Details + + +You can't edit a customer's password from the Medusa Admin. The customer has to reset it from the storefront. + + + To edit a customer’s details: -1. Go to a Customer’s details page. +1. Go to a customer’s details page. 2. Click on the icon in the first section. 3. Choose Edit from the dropdown. -4. In the drawer that opens, edit the customer’s details. +4. In the side window that opens, you can edit the customer's email, first and last name, company name, and phone number. 5. Once you’re done, click the Save button. +![Edit Customer Form](https://res.cloudinary.com/dza7lstvk/image/upload/v1739887419/User%20Guide/Screenshot_2025-02-18_at_4.03.27_PM_r7vb4o.png) + --- ## View Customer Orders -To view the orders of a customer: +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. -1. Go to a Customer’s details page. -2. Find the customer's orders under the Orders section. +### Transfer Order to Another Customer + +You can transfer an order to another customer. For example, a guest customer registered, or a customer created an order offline. + +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. + + + +You can't transfer ownership to a guest customer, and that includes customers you create through the admin dashboard. + + + +To transfer a customer's order ownership to another: + +1. Go to the customer's details page. +2. In the Orders section, click on the icon on the right of the order. +3. Choose Transfer ownership from the dropdown. +4. In the side window that opens, choose the customer to transfer the order to in the "New owner" field. +5. Once you're done, click the Save button. + +The original customer will then receive a notification requesting their approval for the transfer. + + + +If a notification isn't sent, check with your technical team to debug the integrated notification service. + + + +![Transfer ownership form](https://res.cloudinary.com/dza7lstvk/image/upload/v1739887736/User%20Guide/Screenshot_2025-02-18_at_4.08.41_PM_ebkblt.png) + +--- + +## Manage Customer's Groups + +You can add a customer to multiple groups, allowing you to offer different promotions or pricing based on the group they belong to. + +### Add Customer to Groups + +To add a customer to customer groups: + +1. Go to the customer's details page. +2. In the "Customer Groups" section, click on the "Add" button. +3. In the list that opens, check the groups you want to add the customer to. +4. Once you're done, click the Save button. + +![Add groups form](https://res.cloudinary.com/dza7lstvk/image/upload/v1739888065/User%20Guide/Screenshot_2025-02-18_at_4.14.13_PM_jntqs2.png) + +### Remove Customer from Groups + +To remove a customer from customer groups: + +1. Go to the customer's details page. +2. In the "Customer Groups" section, check the groups you want to remove the customer from. +3. Once you're done, either press R or click "Remove" at the bottom center of the page. +4. Confirm removing the groups by clicking the "Remove" button in the pop-up. + +![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) + +--- + +## Edit Customer Metadata + +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. + +To edit the customer's metadata: + +1. Go to the customer's details page. +2. Click the 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 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 icon at its right. + - Choose "Delete row" from the dropdown. +4. Once you're done, click the Save button. + +--- + +## Delete a Customer + + + +Deleting a customer is irreversible. + + + +To delete a customer: + +1. Go to the customer's details page. +2. Click on the icon at the top right of the first section. +3. Choose Delete from the dropdown. +4. In the pop-up, enter the customer's email and click the "Delete" button. diff --git a/www/apps/user-guide/app/customers/page.mdx b/www/apps/user-guide/app/customers/page.mdx index 06cfde0619..9f590af5dc 100644 --- a/www/apps/user-guide/app/customers/page.mdx +++ b/www/apps/user-guide/app/customers/page.mdx @@ -3,32 +3,30 @@ sidebar_autogenerate_exclude: true --- export const metadata = { - title: `Customers`, + title: `Customers Overview`, } # {metadata.title} -In this document, you’ll get an overview of the customer listing page. +The Customers domain allows you to manage customers and customer groups in your commerce store. -## Overview +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). -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. +You can view the list of customers in your commerce store by clicking on Customers from the sidebar menu. -Part of the Customers domain is also Customer Groups. Customer groups allow you to put together a set of customers for business purposes. +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. -For example, you can create a VIP customer group for customers that you want to give special discounts. + + +Find tips to use lists effectively in [this guide](../tips/lists/page.mdx). + + + +![Customers List](https://res.cloudinary.com/dza7lstvk/image/upload/v1739886647/User%20Guide/Screenshot_2025-02-18_at_3.50.29_PM_wq7m1k.png) --- -## View List of Customer Groups - -To view the list of customer groups, go to the Customers page, then go to the Customer Groups sub-item in the sidebar. - -On the Customer Groups page, you'll find the list of customer groups with their details. - ---- - -## Learn More About Customers +## Manage Customers - [Manage and View a Customer’s Details](./manage/page.mdx) - [Manage and View a Customer Group](./groups/page.mdx) diff --git a/www/apps/user-guide/app/orders/manage/page.mdx b/www/apps/user-guide/app/orders/manage/page.mdx index c610659b53..52a3f12b2a 100644 --- a/www/apps/user-guide/app/orders/manage/page.mdx +++ b/www/apps/user-guide/app/orders/manage/page.mdx @@ -160,6 +160,12 @@ To transfer the ownership of an order to another customer: The original customer will then receive a notification requesting their approval for the transfer. + + +If a notification isn't sent, check with your technical team to debug the integrated notification service. + + + ![Transfer Ownership Form](https://res.cloudinary.com/dza7lstvk/image/upload/v1739546904/User%20Guide/Screenshot_2025-02-14_at_5.28.12_PM_brwpek.png) --- diff --git a/www/apps/user-guide/generated/edit-dates.mjs b/www/apps/user-guide/generated/edit-dates.mjs index 6eacfa7003..6cd011b25a 100644 --- a/www/apps/user-guide/generated/edit-dates.mjs +++ b/www/apps/user-guide/generated/edit-dates.mjs @@ -36,17 +36,17 @@ export const generatedEditDates = { "app/settings/sales-channels/products/page.mdx": "2024-05-03T17:36:38+03:00", "app/settings/developer/executions/page.mdx": "2024-05-03T17:36:38+03:00", "app/inventory/inventory/page.mdx": "2025-02-18T13:59:16.960Z", - "app/customers/groups/page.mdx": "2024-05-03T17:36:38+03:00", - "app/orders/manage/page.mdx": "2025-02-17T10:29:36.199Z", + "app/customers/groups/page.mdx": "2025-02-18T15:41:30.730Z", + "app/orders/manage/page.mdx": "2025-02-18T15:38:17.544Z", "app/orders/returns/page.mdx": "2025-02-17T15:10:11.039Z", "app/inventory/page.mdx": "2025-02-18T13:58:42.393Z", "app/settings/sales-channels/manage/page.mdx": "2024-05-03T17:36:38+03:00", "app/orders/claims/page.mdx": "2025-02-17T15:16:27.380Z", "app/orders/fulfillments/page.mdx": "2025-02-17T15:12:20.431Z", - "app/customers/page.mdx": "2025-02-18T13:56:28.134Z", + "app/customers/page.mdx": "2025-02-18T15:38:17.543Z", "app/orders/edit/page.mdx": "2025-02-17T15:15:53.489Z", "app/products/collections/page.mdx": "2025-02-18T14:00:51.469Z", - "app/customers/manage/page.mdx": "2025-02-18T13:56:28.134Z", + "app/customers/manage/page.mdx": "2025-02-18T15:38:17.543Z", "app/discounts/create/page.mdx": "2024-05-03T17:36:38+03:00", "app/orders/payments/page.mdx": "2025-02-17T15:10:24.250Z", "app/discounts/page.mdx": "2024-05-03T17:36:38+03:00", diff --git a/www/apps/user-guide/generated/sidebar.mjs b/www/apps/user-guide/generated/sidebar.mjs index c16f51b5f3..795bc86eb9 100644 --- a/www/apps/user-guide/generated/sidebar.mjs +++ b/www/apps/user-guide/generated/sidebar.mjs @@ -243,26 +243,30 @@ export const generatedSidebar = [ "loaded": true, "isPathHref": true, "type": "category", - "path": "/customers", "title": "Customers", - "autogenerate_path": "/customers", "children": [ { "loaded": true, "isPathHref": true, "type": "link", - "path": "/customers/manage", - "title": "Manage Customers", - "description": "", + "title": "Overview", + "path": "/customers", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", + "title": "Manage Customers", + "path": "/customers/manage", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "title": "Manage Groups", "path": "/customers/groups", - "title": "Manage Customer Groups", - "description": "", "children": [] } ] diff --git a/www/apps/user-guide/sidebar.mjs b/www/apps/user-guide/sidebar.mjs index 9a3c8d9265..a9f650d5cb 100644 --- a/www/apps/user-guide/sidebar.mjs +++ b/www/apps/user-guide/sidebar.mjs @@ -144,9 +144,24 @@ export const sidebar = sidebarAttachHrefCommonOptions([ }, { type: "category", - path: "/customers", title: "Customers", - autogenerate_path: "/customers", + children: [ + { + type: "link", + title: "Overview", + path: "/customers", + }, + { + type: "link", + title: "Manage Customers", + path: "/customers/manage", + }, + { + type: "link", + title: "Manage Groups", + path: "/customers/groups", + }, + ], }, { type: "category",