api-ref: custom API reference (#4770)
* initialized next.js project * finished markdown sections * added operation schema component * change page metadata * eslint fixes * fixes related to deployment * added response schema * resolve max stack issue * support for different property types * added support for property types * added loading for components * added more loading * type fixes * added oneOf type * removed console * fix replace with push * refactored everything * use static content for description * fixes and improvements * added code examples section * fix path name * optimizations * fixed tag navigation * add support for admin and store references * general enhancements * optimizations and fixes * fixes and enhancements * added search bar * loading enhancements * added loading * added code blocks * added margin top * add empty response text * fixed oneOf parameters * added path and query parameters * general fixes * added base path env variable * small fix for arrays * enhancements * design enhancements * general enhancements * fix isRequired * added enum values * enhancements * general fixes * general fixes * changed oas generation script * additions to the introduction section * added copy button for code + other enhancements * fix response code block * fix metadata * formatted store introduction * move sidebar logic to Tags component * added test env variables * fix code block bug * added loading animation * added expand param + loading * enhance operation loading * made responsive + improvements * added loading provider * fixed loading * adjustments for small devices * added sidebar label for endpoints * added feedback component * fixed analytics * general fixes * listen to scroll for other headings * added sample env file * update api ref files + support new fields * fix for external docs link * added new sections * fix last item in sidebar not showing * move docs content to www/docs * change redirect url * revert change * resolve build errors * configure rewrites * changed to environment variable url * revert changing environment variable name * add environment variable for API path * fix links * fix tailwind settings * remove vercel file * reconfigured api route * move api page under api * fix page metadata * fix external link in navigation bar * update api spec * updated api specs * fixed google lint error * add max-height on request samples * add padding before loading * fix for one of name * fix undefined types * general fixes * remove response schema example * redesigned navigation bar * redesigned sidebar * fixed up paddings * added feedback component + report issue * fixed up typography, padding, and general styling * redesigned code blocks * optimization * added error timeout * fixes * added indexing with algolia + fixes * fix errors with algolia script * redesign operation sections * fix heading scroll * design fixes * fix padding * fix padding + scroll issues * fix scroll issues * improve scroll performance * fixes for safari * optimization and fixes * fixes to docs + details animation * padding fixes for code block * added tab animation * fixed incorrect link * added selection styling * fix lint errors * redesigned details component * added detailed feedback form * api reference fixes * fix tabs * upgrade + fixes * updated documentation links * optimizations to sidebar items * fix spacing in sidebar item * optimizations and fixes * fix endpoint path styling * remove margin * final fixes * change margin on small devices * generated OAS * fixes for mobile * added feedback modal * optimize dark mode button * fixed color mode useeffect * minimize dom size * use new style system * radius and spacing design system * design fixes * fix eslint errors * added meta files * change cron schedule * fix docusaurus configurations * added operating system to feedback data * change content directory name * fixes to contribution guidelines * revert renaming content * added api-reference to documentation workflow * fixes for search * added dark mode + fixes * oas fixes * handle bugs * added code examples for clients * changed tooltip text * change authentication to card * change page title based on selected section * redesigned mobile navbar * fix icon colors * fix key colors * fix medusa-js installation command * change external regex in algolia * change changeset * fix padding on mobile * fix hydration error * update depedencies
This commit is contained in:
Shahed Nasser
@@ -0,0 +1,9 @@
|
||||
{
|
||||
"position": 4,
|
||||
"collapsed": false,
|
||||
"link": null,
|
||||
"label": "Customers",
|
||||
"customProps": {
|
||||
"sidebar_is_group_headline": true
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,119 @@
|
||||
---
|
||||
sidebar_position: 3
|
||||
description: 'This user guide explains how to manage customer groups on the Medusa admin. Learn how to create and edit customer groups.'
|
||||
addHowToData: true
|
||||
---
|
||||
|
||||
import UiIcon from '@site/src/components/UiIcon';
|
||||
|
||||
# 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 <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999273/Medusa%20Docs/UI%20Icons/7hztVhj_mj6mxu.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999290/Medusa%20Docs/UI%20Icons/1yp4PNt_vzwnhf.png" alt="trash" /> 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 <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999308/Medusa%20Docs/UI%20Icons/1ordBC6_ssysel.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999326/Medusa%20Docs/UI%20Icons/dSwWYBH_stzgoi.png" alt="three dots" /> 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 <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999273/Medusa%20Docs/UI%20Icons/7hztVhj_mj6mxu.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999290/Medusa%20Docs/UI%20Icons/1yp4PNt_vzwnhf.png" alt="trash" /> 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 <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999308/Medusa%20Docs/UI%20Icons/1ordBC6_ssysel.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999326/Medusa%20Docs/UI%20Icons/dSwWYBH_stzgoi.png" alt="three dots" /> 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 <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999308/Medusa%20Docs/UI%20Icons/1ordBC6_ssysel.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999326/Medusa%20Docs/UI%20Icons/dSwWYBH_stzgoi.png" alt="three dots" /> 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.
|
||||
@@ -0,0 +1,37 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
description: 'Medusa admin allows merchants to manage customers and customer groups.'
|
||||
---
|
||||
|
||||
# Customers Overview
|
||||
|
||||
In this document, you’ll get an overview of the customer listing page and all the things you can do with it.
|
||||
|
||||
## Overview
|
||||
|
||||
You can find the list of signed up customers on your store in the Customers page. For each of those customers, you can view details such as their orders, or personal information.
|
||||
|
||||
Part of the Customers domain is also Customer Groups. Customer groups allow you to put together a set of customers for business purposes. For example, you can create a VIP customer group for customers that you want to give special discounts.
|
||||
|
||||
---
|
||||
|
||||
## View List of Customers
|
||||
|
||||
You can view the list of available customers in your ecommerce store by clicking on Customers from the sidebar menu.
|
||||
|
||||
In the list, you can see customer details such as the customer’s name, email address, and the number of orders.
|
||||
|
||||
---
|
||||
|
||||
## View List of Customer Groups
|
||||
|
||||
You can view the list of customer groups on the Customer Groups page by clicking on the grey Groups headline next to the Customers headline.
|
||||
|
||||
In the list, you can see group details such as the group’s title and the number of customers in the group.
|
||||
|
||||
---
|
||||
|
||||
## Learn More About Customers
|
||||
|
||||
- [Manage and View a Customer’s Details](./manage.mdx)
|
||||
- [Manage and View a Customer Group](./groups.mdx)
|
||||
@@ -0,0 +1,39 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
description: 'This user guide explains how to manage customers on the Medusa admin. Learn how to view and edit customers.'
|
||||
addHowToData: true
|
||||
---
|
||||
|
||||
import UiIcon from '@site/src/components/UiIcon';
|
||||
|
||||
# Manage Customers
|
||||
|
||||
In this document, you’ll learn how to manage customers and their details.
|
||||
|
||||
## View Customer Details
|
||||
|
||||
To view a customer’s details:
|
||||
|
||||
1. Go to the Customers page.
|
||||
2. Click on the customer you want to view.
|
||||
|
||||
---
|
||||
|
||||
## Edit Customer Details
|
||||
|
||||
To edit a customer’s details:
|
||||
|
||||
1. Go to a Customer’s details page.
|
||||
2. Click on the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999308/Medusa%20Docs/UI%20Icons/1ordBC6_ssysel.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999326/Medusa%20Docs/UI%20Icons/dSwWYBH_stzgoi.png" alt="three dots" /> icon in the first section.
|
||||
3. Choose Edit from the dropdown.
|
||||
4. In the new window that opens, you can edit the customer’s details.
|
||||
5. Once you’re done, click on the Save button.
|
||||
|
||||
---
|
||||
|
||||
## View Customer Orders
|
||||
|
||||
To view the orders of a customer:
|
||||
|
||||
1. Go to a Customer’s details page.
|
||||
2. Scroll to the Orders section. You’ll fine the customer’s orders and you can click on an order to view it.
|
||||
Reference in New Issue
Block a user