docs: create docs workspace (#5174)

* docs: migrate ui docs to docs universe * created yarn workspace * added eslint and tsconfig configurations * fix eslint configurations * fixed eslint configurations * shared tailwind configurations * added shared ui package * added more shared components * migrating more components * made details components shared * move InlineCode component * moved InputText * moved Loading component * Moved Modal component * moved Select components * Moved Tooltip component * moved Search components * moved ColorMode provider * Moved Notification components and providers * used icons package * use UI colors in api-reference * moved Navbar component * used Navbar and Search in UI docs * added Feedback to UI docs * general enhancements * fix color mode * added copy colors file from ui-preset * added features and enhancements to UI docs * move Sidebar component and provider * general fixes and preparations for deployment * update docusaurus version * adjusted versions * fix output directory * remove rootDirectory property * fix yarn.lock * moved code component * added vale for all docs MD and MDX * fix tests * fix vale error * fix deployment errors * change ignore commands * add output directory * fix docs test * general fixes * content fixes * fix announcement script * added changeset * fix vale checks * added nofilter option * fix vale error
2023-09-21 20:57:15 +03:00
parent 19c5d5ba36
commit fa7c94b4cc
3209 changed files with 32188 additions and 31018 deletions
@@ -0,0 +1,63 @@
+---
+description: 'Learn what Customer Groups are and how they can be used in the Medusa backend. Customer Groups allow to combine customers with similar attributes into a single group.'
+---
+
+# Customer Groups
+
+In this document, you’ll learn about Customer Groups and how they can be used in Medusa.
+
+## Introduction
+
+Customer groups allow you to combine customers with similar attributes such as purchase habits, region, or for any reason that works for your business model.
+
+You can then assign different prices for customer groups using price lists.
+
+### Examples Use Cases
+
+The customer groups feature can be used in a variety of use cases including:
+
+- Implement a B2B business model by assigning a specific customer group for wholesale customers.
+- Combine customers that make purchases frequently into a group and give them a special discount.
+- Create different customer groups based on different buyer personas.
+
+---
+
+## CustomerGroup Entity Overview
+
+A customer group is stored in the database as a [CustomerGroup](../../references/entities/classes/CustomerGroup.md) entity. This entity has two attributes other than the `id`: `name` and `metadata`.
+
+Similar to all entities in Medusa, you can use the `metadata` object attribute to store any custom data you want. For example, you can add some flag or tag to the customer group for a custom use case:
+
+```js noReport
+metadata: {
+	is_seller: true
+}
+```
+
+---
+
+## Relations to Other Entities
+
+### Customer
+
+A customer can belong to multiple customer groups, and a customer group can have more than one customer. After creating a customer group, you can manage customers in that group.
+
+The relation between the `Customer` and `CustomerGroup` entities is available on both entities:
+
+- You can access the customer groups of a customer by expanding the `groups` relation and accessing `customer.groups`.
+- You can access the customers in a customer group by expanding the `customers` relation and accessing `customerGroup.customers`.
+
+### PriceList
+
+A price list can have multiple conditions to define in which cases it should be applied. One of those conditions is customer groups. You can specify more than one customer group to apply the prices on.
+
+The relation between the `PriceList` and `CustomerGroup` entities is available on both entities:
+
+- You can access the customer groups of a price list by expanding the `customer_groups` relation and accessing `price_list.customer_groups`.
+- You can access the price lists that are applied to a customer group by expanding the `price_lists` relation and accessing `customerGroup.price_lists`.
+
+---
+
+## See Also
+
+- [Manage customer groups using the Admin APIs](./admin/manage-customer-groups.mdx)