From 911f75942e051b06a82921c0e18449902d4d94a3 Mon Sep 17 00:00:00 2001 From: Shahed Nasser Date: Wed, 5 Oct 2022 17:39:40 +0300 Subject: [PATCH] docs: added user guide for customer groups (#2364) --- docs/content/user-guide/customers/groups.md | 11 -- docs/content/user-guide/customers/groups.mdx | 115 +++++++++++++++++++ docs/content/user-guide/customers/index.md | 2 +- 3 files changed, 116 insertions(+), 12 deletions(-) delete mode 100644 docs/content/user-guide/customers/groups.md create mode 100644 docs/content/user-guide/customers/groups.mdx diff --git a/docs/content/user-guide/customers/groups.md b/docs/content/user-guide/customers/groups.md deleted file mode 100644 index f0e75f3646..0000000000 --- a/docs/content/user-guide/customers/groups.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Manage Customer Groups - -:::note - -This guide is coming soon. - -::: diff --git a/docs/content/user-guide/customers/groups.mdx b/docs/content/user-guide/customers/groups.mdx new file mode 100644 index 0000000000..91330d953c --- /dev/null +++ b/docs/content/user-guide/customers/groups.mdx @@ -0,0 +1,115 @@ +--- +sidebar_position: 3 +--- + +# Manage Customer Groups + +In this document, you’ll learn how to manage customer groups, including customers in these groups. + +## Create a Customer Group + +To create a customer group: + +1. Go to the Customers page. +2. Choose the Groups headline. +3. Click on the New Group button. +4. In the new window that opens: + 1. Enter a title for the group. + 2. Optionally, to add metadata: + 1. Click on the Add Metadata button. + 2. Enter a value for the Key and Value Fields. + 3. To remove a metadata field, click on the icon. +5. Once you’re done, click on the Publish Group button. + +--- + +## View Customer Group Details + +To view the details of a customer group: + +1. Go to the Customers page. +2. Choose the Groups headline. +3. Click on the name of the group you want to view. + +--- + +## Edit a Customer Group + +To edit a customer group: + +1. Go to the customer group’s details page. +2. Click on the icon at the right of the group’s name. +3. Click on Edit in the dropdown. +4. In the new window that opens: + 1. You can change the title and existing metadata of the group. + 2. To add metadata: + 1. Click on the Add Metadata button. + 2. Enter a value for the Key and Value Fields. + 3. To remove metadata click on the icon. +5. Once you’re done, click on the Edit Group button. + +--- + +## 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. Scroll to the Customers section. You’ll find all customers that belong to this customer group in this section if there are any. + +### Add Customers to a Group + +To add customers to a customer group: + +1. Go to the customer group’s details page. +2. Click on the “Edit customers” button at the top right of the Customers section. +3. Check the box next to every customer you want to add to the group. +4. Click on the Save button. + +### Remove a Customer from a Group + +:::info + +Removing customers from a customer group doesn't remove the customers from your store. + +::: + +To remove customers from a customer group: + +1. Go to the customer group’s details page. +2. In the Customer section, click on the icon next to the customer you want to remove from the group. +3. Click on “Delete from the Group” from the dropdown. + +### Remove Multiple Customers from a Group + +:::info + +Removing customers from a customer group doesn't remove the customers from your store. + +::: + +To remove more than one customer from a customer group at the same time: + +1. Go to the customer group’s details page. +2. Click on the “Edit customers” button at the top right of the Customers section. +3. Uncheck the box next to every customer you want to remove from the group. +4. Click on the Save button. + +--- + +## Delete Customer Group + +:::warning + +Deleting a customer group cannot be undone. + +::: + +To delete a customer group: + +1. Go to the customer group’s details page. +2. Click on the icon at the right of the group’s name. +3. Click on Delete from the dropdown. +4. Confirm deleting the price list by clicking the “Yes, delete” button in the pop-up. \ No newline at end of file diff --git a/docs/content/user-guide/customers/index.md b/docs/content/user-guide/customers/index.md index 4d48d1a50d..3aab3cd11f 100644 --- a/docs/content/user-guide/customers/index.md +++ b/docs/content/user-guide/customers/index.md @@ -33,4 +33,4 @@ In the list, you can see group details such as the group’s title and the numbe ## Learn More About Customers - [Manage and View a Customer’s Details](./manage.md) -- [Manage and View a Customer Group](./groups.md) +- [Manage and View a Customer Group](./groups.mdx)