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
This commit is contained in:
Shahed Nasser
2023-09-21 20:57:15 +03:00
committed by GitHub
parent 19c5d5ba36
commit fa7c94b4cc
3209 changed files with 32188 additions and 31018 deletions
@@ -0,0 +1,9 @@
{
"position": 4,
"collapsed": false,
"link": null,
"label": "Customers",
"customProps": {
"sidebar_is_group_headline": true
}
}
@@ -0,0 +1,113 @@
---
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, youll 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 pop-up that opens:
1. Enter a title for the group.
2. Under Metadata, you can optionally attach custom data to the customer group as key-value pairs. This is mostly useful for technical teams and develoeprs.
5. Once youre 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 groups 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 top right of the first section.
3. Click on Edit in the dropdown.
4. In the pop-up that opens:
1. You can change the title and existing metadata of the group.
2. Under Metadata, you can optionally attach custom data to the customer group as key-value pairs. This is mostly useful for technical teams and develoeprs.
5. Once youre 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 groups details page.
2. Scroll to the Customers section. Youll 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 groups 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 groups 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 groups 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 groups 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 top right of the first section.
3. Click on Delete from the dropdown.
4. Confirm deleting the customer group 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, youll 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 customers 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 groups title and the number of customers in the group.
---
## Learn More About Customers
- [Manage and View a Customers 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, youll learn how to manage customers and their details.
## View Customer Details
To view a customers details:
1. Go to the Customers page.
2. Click on the customer you want to view.
---
## Edit Customer Details
To edit a customers details:
1. Go to a Customers 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 pop-up that opens, you can edit the customers details.
5. Once youre done, click on the "Save and close" button.
---
## View Customer Orders
To view the orders of a customer:
1. Go to a Customers details page.
2. Scroll to the Orders section. Youll fine the customers orders and you can click on an order to view it.
@@ -0,0 +1,9 @@
{
"position": 6,
"collapsed": false,
"link": null,
"label": "Discounts",
"customProps": {
"sidebar_is_group_headline": true
}
}
@@ -0,0 +1,101 @@
---
sidebar_position: 2
description: 'This user guide explains how to create a discount on the Medusa admin.'
addHowToData: true
---
import UiIcon from '@site/src/components/UiIcon';
# Create a Discount
In this document, youll learn how to create a discount.
## How to Create a Discount
To create a discount:
1. Go to Discounts.
2. Click on the Add Discount button.
This opens a form with collapsible sections to fill in different information about the discount.
### Discount Type
In this section, you have to select the discount type. There are three types:
1. **Percentage:** discount a specific percentage of the price of each item that complies with the discount conditions.
2. **Fixed amount:** discount a specific amount either from the cart total or from the price each item that complies with the discount conditions. After choosing this type, a new field Allocation will show where you can choose how the discount should be applied.
3. **Free shipping:** Remove any shipping amount available during checkout.
Choose the type of the discount and fill in any additional fields if necessary.
### General
In this section, you have to enter general but required information related to the discount:
1. In the “Choose valid regions” field, choose the regions this discount should be applied in. You must select at least one region. For the Fixed Discount type, you can only pick one region. For other types you can select more than one region.
2. In the Code field, enter the code that the customers have to enter during checkout for the discount to be applied. Only uppercase letters and numbers are allowed.
3. If you chose Percentage for Discount Type earlier, enter the percentage that should be discounted in the Percentage field.
4. If you chose Fixed Amount for Discount Type earlier, enter the amount that should be discounted in the Amount field.
5. In the Description field, enter a description for the discount.
6. You can check the “This is a template discount” checkbox to create a template discount. You can use template discounts to reuse discount rules and configurations across a group of discounts.
### Configuration
In this section, you can set configurations that limit the application of the discount:
1. Toggle the Start date field if you want to set the date and time the customers can start using this discount. If you dont set a start date, the discount can be used once its published.
2. Toggle the “Discount has an expiry date?” field if you want to set the date and time the discount ends. If you dont set an expiry date, the discount can be used forever while its published.
3. Toggle the “Limit the number of redemptions?” field if you want to limit how many times the discount can be used. This number is used across customers, and not per customer. If you dont set a limit, the discount can be used unlimitedly.
4. If you chose to make the discount a template discount earlier, you can toggle the “Availability duration?” field to set the duration of the discount in years, months, days, hours, and minutes.
### Conditions
In this section, you can set the conditions that define when the discount can be applied. When the discount is used on a cart, it will only be applied if the items in the cart and the customer fit the discounts conditions.
The following condition types can be used:
1. **Product:** specify products that this discount can/cant be used with.
2. **Customer groups:** specify customer groups that this discount can/cant be used with.
3. **Tag:** specify tags that this discount can/cant be used with.
4. **Collection:** specify the collection that this discount can/cant be used with.
5. **Type:** specify the product type that this discount can/cant be used with.
To add a condition to the discount:
1. Click on the Add Condition button.
2. Click on the condition type.
3. In the new list that opens:
1. Choose at the top either “In” or “Not In,” where “In” indicates that the discount can be applied to the items selected in this list, and “Not In” indicates that the discount can be applied to all items except those selected in this list.
2. Select the items from the list.
4. Once done, click “Save and add more” to add more conditions, or click “Save and close” to close the conditions window.
:::info
You can use a condition type for only one condition. After using a condition type, you will not be able to use it again for another condition. Youll need to edit the condition you added if you need to make any changes.
:::
To edit a condition you already added to the discount:
1. 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 condition.
2. Click on Edit from the dropdown.
3. Make changes to the condition in the new window that opens.
4. Once done, click on the Save button.
To delete a condition you already added to the discount:
1. 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 condition.
2. Click on “Delete condition” from the dropdown.
### Metadata
Under the Metadata section, you can attach custom data to the discount as key-value pairs. This is mostly useful for developers and technical teams.
### Save Discount
After filling out previous sections, you can save the discount by either clicking the “Save as draft” or “Publish discount” buttons.
If you save the discount as a draft, customers will not be able to use it but all of the information, configurations, and conditions will be saved. You can publish it at a later point.
If you publish the discount, customers will be able to use it within the configurations and conditions youve set. You can change the status of the discount back to draft later on as well.
@@ -0,0 +1,35 @@
---
sidebar_position: 1
description: 'Medusa admin allows merchants to manage discounts. Merchants can create discounts and manage their conditions.'
---
# Discounts Overview
In this document, youll get an overview of the customer listing page and everything you can do with it.
## Overview
You can create discounts of different types in Medusa that customers use on checkout:
- **Percentage Discounts** to deduct a percentage of the total amount of an order.
- **Fixed Discounts** to deduct a fixed amount from the total amount of an order.
- **Free Shipping** to override the delivery amount of an order and make it free.
Discounts are in the form of a code that your customers can use. You can set options for a discount such as a start and an end date.
You can also specify conditions for discounts, such as applying them for specific products or shipping options.
---
## View List of Discounts
You can view the list of available discounts in your ecommerce store by clicking on Discounts from the sidebar menu.
In the list, you can see discount details such as the code, description, amount, and status.
---
## Learn More About Discounts
- [Create a Discount](./create.mdx)
- [Manage Discounts](./manage.mdx)
@@ -0,0 +1,142 @@
---
sidebar_position: 3
description: 'This user guide explains how to manage discounts on the Medusa admin. Learn how to edit and delete discounts'
addHowToData: true
---
import UiIcon from '@site/src/components/UiIcon';
# Manage Discounts
In this document, youll learn how to manage discounts including editing and deleting a discount.
## View Discount Details
To view a discounts details:
1. Go to Discounts.
2. Click on the discount you want to view its details
This opens the discounts details page.
---
## Edit a Discount
### Change Discount Status
:::info
Changing a discounts status to published makes it available for customers to use. Changing a discounts status to draft makes it unavailable for customers to use.
:::
To change a discounts status:
1. Go to the discount details page.
2. At the top right of the first section, youll see the status of the discount (for example, Published). Click on it.
3. Choose from the dropdown the opposite status (for example, Draft)
### Edit General Information
To edit a discounts general information:
1. Go to the discount 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 top right of the first section.
3. Click on “Edit general information” from the dropdown.
4. In the pop-up, you can edit any of the discount information.
5. Once done, click on the "Save and close" button.
---
## Manage Discount Configurations
### Edit Configurations
To edit a discounts configuration:
1. Go to the discount 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 top right of the Configurations section.
3. Click on “Edit configurations” from the dropdown.
4. In the pop-up, you can edit any of the configurations.
5. Once done, click on the Save button.
### Delete Configurations
Other than the start date, you can delete any of the configurations if youve set them.
To delete a configuration:
1. Go to the discount details page.
2. In the Configurations 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 configuration you want to delete.
3. Click on “Delete configuration” from the dropdown.
---
## Manage Discount Conditions
### Add Conditions
:::info
You can use a condition type for only one condition. After using a condition type, you will not be able to use it again for another condition. You must [edit the condition](#edit-a-condition) that you added before of that type if you need to make any changes.
:::
To add a condition to a discount:
1. Go to the discount details page.
2. In the Conditions 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.
3. Click on “Add condition” from the dropdown.
4. In the pop-up, find the condition type from the list of conditions and click on it.
5. In the new list that opens:
1. Choose at the top either “In” or “Not In,” where “In” indicates that the discount can be applied to the items selected in this list, and “Not In” indicates that the discount can be applied to all items except those selected in this list.
2. Select the items from the list.
6. Once done, click “Save and add more” to add more conditions, or click “Save and close” to close the conditions window.
### Edit a Condition
To edit a discounts condition:
1. Go to the discount details page.
2. In the Conditions 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 condition you want to edit.
3. Click on “Edit condition” from the dropdown.
4. In the pop-up that opens:
1. To add new items to the list:
1. Click on the Add button at the top right.
2. Choose the items you want to add.
3. Click on either the “Save and go back” or the “Save and close” button.
2. To remove items from the list:
1. Choose the items you want to remove.
2. Click on the Remove button at the top right.
### Delete a Condition
:::caution
Deleting a condition can't be undone. You can still add a new condition of the same type afterward.
:::
To delete a discounts condition:
1. Go to the discount details page.
2. In the Conditions 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 condition you want to delete.
3. Click on “Delete condition” from the dropdown.
---
## Delete a Discount
:::warning
Deleting a discount can't be undone.
:::
To delete a discount:
1. Go to the discount 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 top right of the first section.
3. Click on “Delete discount” from the dropdown.
4. Confirm deleting the discount by clicking the “Yes, confirm” button in the pop-up.
@@ -0,0 +1,9 @@
{
"position": 7,
"collapsed": false,
"link": null,
"label": "Gift Cards",
"customProps": {
"sidebar_is_group_headline": true
}
}
@@ -0,0 +1,93 @@
---
sidebar_position: 3
description: 'This user guide explains how to manage custom gift cards on the Medusa admin. Learn how to create and edit custom gift cards.'
addHowToData: true
---
import UiIcon from '@site/src/components/UiIcon';
# Manage Custom Gift Cards
In this document, youll learn how to manage custom gift cards, including how to create and update them.
## Create Custom Gift Card
To create a custom gift card:
1. Go to Gift Cards from the sidebar.
2. Click on the Custom Gift Card button at the top right of the History section.
3. In the pop-up that opens:
1. Select in the Region field the region this gift card works in. You can only pick one region. Based on the region you pick, the currency of the gift card will automatically change.
2. Enter in the Amount field the amount of the gift card.
3. If the gift card has an expiry date, you can toggle the "Gift Card has an expiry date?" on. This will show an expiry date and time fields that you can use to set the expiry date and time.
4. Enter in the Email field the email of the customer that will receive this gift card.
5. You can optionally enter in the Personal Message field any message you want the customer to receive with this gift card.
4. Once done, click on "Create and send" button.
The gift card will be created with a random code. The customer will then receive an email with details about their gift card.
:::note
If the customer doesnt receive an email, please get in touch with your technical team to ensure an email service is set up correctly.
:::
---
## View a Custom Gift Cards Details
To view a custom gift cards details:
1. Go to Gift Cards from the sidebar.
2. In the History section, find the custom gift card and click on it.
This opens the gift cards details page.
---
## Edit a Custom Gift Card
### Edit Region and Expiry Date
:::info
Changing the region of a custom gift card will change the currency of the gift card to the new regions currency.
:::
To change the region of a custom gift card:
1. Go to the custom gift cards 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 top right of the first section.
3. Click on "Edit details" from the dropdown.
4. In the pop-up that opens:
1. Select in the Region field the region you want this gift card to work in.
2. You can optionally edit its expiry date by toggling the "Gift Card has an expiry date?" field on and specify the expiry date and time.
5. Once done, click on the "Save and close" button.
### Update Balance of Custom Gift Card
To update the balance of a custom gift card:
1. Go to the custom gift cards 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 top right of the first section.
3. Click on “Update balance” from the dropdown.
4. In the pop-up that opens, enter in the Amount field the new balance.
5. Once done, click on the "Save and close" button.
### Change Custom Gift Card Status
You can disable or activate a custom gift card.
:::note
If you disable a gift card, customers cant use it during checkout.
:::
To change a custom gift cards status:
1. Go to the custom gift cards details page.
2. In the first section, you'll find the status of the custom gift card with a <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999685/Medusa%20Docs/UI%20Icons/yrTcDO4_tulwph.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999685/Medusa%20Docs/UI%20Icons/yrTcDO4_tulwph.png" alt="green" /> icon if its active or a <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999700/Medusa%20Docs/UI%20Icons/0lUln3B_arpgmo.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999700/Medusa%20Docs/UI%20Icons/0lUln3B_arpgmo.png" alt="grey" /> icon if its disabled.
3. Click on the status, and a dropdown will show to toggle the status. For example, if the status of the gift card is Active, the dropdown will show a Disable status.
4. Choose the status in the dropdown, and the status of the gift card will change.
@@ -0,0 +1,27 @@
---
sidebar_position: 1
description: 'Medusa admin allows merchants to manage gift cards. Merchants can manage main and custom gift cards.'
---
# Gift Cards Overview
In this document, youll learn about how Gift Cards in Medusa work.
## Overview
In Medusa, theres one main gift card. A gift card can have multiple denominations. For example, a Gift Card can have the amounts of $20 and $50, and customers can buy one of these denominations.
---
## Custom Gift Cards
You can also create custom gift cards in Medusa. These cards can be created and sent directly to a customers email.
To view the list of available custom gift cards, from the sidebar go to Gift Cards. You can find all custom gift cards in the History section.
---
## Learn More About Gift Cards
- [Manage Gift Cards](./manage.mdx)
- [Manage Custom Gift Cards](./custom.mdx)
@@ -0,0 +1,223 @@
---
sidebar_position: 2
description: 'This user guide explains how to manage the main gift card on the Medusa admin. Learn how to create, edit, and delete a gift card.'
addHowToData: true
---
import UiIcon from '@site/src/components/UiIcon';
# Manage a Gift Card
In this document, youll learn about managing gift cards, including how to create, edit, and delete them.
## Create Gift Card
:::info
You can only create one gift card per store.
:::
Click on Gift Cards in the sidebar menu. If you dont have any gift cards you should see a prompt to create your first gift card.
To create a Gift Card:
1. Click on Create Gift Card.
2. In the new pop-up that opens:
- Enter a name for the gift card
- You can optionally enter a description and a thumbnail.
- Click on Add Denomination. You must at least add one denomination
- For each denomination, choose the currency and amount.
- If you want to delete a denomination, you can click 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.
3. Once youre done, click the "Create & Publish" button.
:::tip
If you want to add more than one currency value for a denomination, you can do that when you [edit a denomination](#edit-a-denomination).
:::
---
## Edit Gift Card
To edit a Gift Card:
1. Go to the Gift Cards page from the sidebar menu.
2. Next to the main gift card, 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.
3. Choose Edit from the dropdown.
This opens a page with the Gift Card's details.
### Edit Gift Card Information
To edit the gift card's information:
1. 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 top right of the first section.
2. Click on "Edit General Information" from the dropdown.
3. In the pop-up that opens, you can edit the gift card's general information such as name or handle. You can also organize the gift card into a product type or product collection, or add product tags. In addition, you can specify if the gift card is Discountable.
4. Once you're done, click on the Save button.
:::info
The handle is the URL used on the storefront to view the Gift Card.
:::
### Add a Denomination
To add a denomination:
1. In the Denominations 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 at the top right.
2. Click on "Add Denomination" from the dropdown.
3. In the pop-up that opens:
- Under default currency, enter the denomination's amount for the default store's currency.
- The "Use value for all currencies?" field allows you to specify whether the amount entered for the default currency should be applied to all currencies. Toggling this one on will hide the "Other currencies" section.
- Under the "Other currencies" section, which is only available if "Use value for all currencies?" is disabled, you can enter the amount for each currency in your store.
- Under the Metadata section, you can attach custom data to the denomination in key-value pairs. This is mainly useful for technical teams and developers.
4. Once youre done, click the "Save and close" button.
### Edit a Denomination
To edit a denomination:
1. In the Denominations section, find the denomination you want to edit.
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 side of the denomination's row.
3. Click on Edit from the dropdown.
4. This opens a pop-up to edit the denomination. This form is similar to the [Add Denomination](#add-a-denomination) form. You can edit the amount for the default currency. You can also specify or edit the amount for other currencies if the "Use value for all currencies?" field is disabled, and you can add Metadata fields.
5. Once youre done, click on the "Save and close" button.
### Delete a Denomination
:::warning
If you delete a denomination, customers wont be able to find it in the storefront, purchase it, or use it.
:::
To delete a denomination:
1. In the Denominations section, find the denomination you want to delete.
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 side of the denomination's row.
3. Click on Delete from the dropdown.
4. Confirm deleting the denomination by clicking the “Yes, confirm button in the pop-up.
### Change Thumbnail Image
To change the thumbnail image:
1. Go to the Thumbnail section.
2. If you have an existing thumbnail image, you can click the Edit button to change it. Otherwise, you can click the Upload button to add a thumbnail image.
3. In the pop-up that opens, either click on the dotted box to upload an image or drag your image from your computer.
4. Once you're done, click the "Save and close" button.
:::note
If you face any errors or difficulties while uploading an image, please contact your technical support team as this could be an issue in the storage integration used.
:::
### Delete Thumbnail Image
To delete the thumbnail image:
1. Go to the Thumbnail section.
2. 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.
3. Click on the button again to confirm the deletion.
### Add Images
:::info
You can add up to ten images for a Gift Card.
:::
To add images to the Gift Card:
1. Go to the Media section.
2. Click on the Edit Media button.
3. In the pop-up that opens, either click on the dotted box to upload an image or drag your image from your computer.
3. Once you're done, click the "Save and close" button.
:::note
If you face any errors or difficulties while uploading an image, please contact your technical support team as this could be an issue in the storage integration used.
:::
### Delete Gift Card Image
:::caution
If you delete an image, you wont be able to restore it.
:::
To delete a gift card image:
1. Go to the Images section.
2. Click on the Edit Media button.
3. In the pop-up, find the image you want to delete from the existing images.
4. 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 side of the image.
5. Choose Delete from the dropdown.
3. Once you're done, click the "Save and close" button.
---
## Unpublish Gift Card
:::caution
Unpublishing a gift card prevents customers from seeing the gift card in the storefront, purchasing it, or using it.
:::
### On Gift Cards Page
1. 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 top right of the main gift card.
2. Choose Unpublish from the dropdown.
### On Edit Gift Card Page
1. In the first section, you'll find the status of the gift card with a <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999685/Medusa%20Docs/UI%20Icons/yrTcDO4_tulwph.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999685/Medusa%20Docs/UI%20Icons/yrTcDO4_tulwph.png" alt="green" /> icon if its published or a <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999700/Medusa%20Docs/UI%20Icons/0lUln3B_arpgmo.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999700/Medusa%20Docs/UI%20Icons/0lUln3B_arpgmo.png" alt="grey" /> icon if its a draft.
2. Click on the status, and a dropdown will show to toggle the status. For example, if the status of the gift card is Published, the dropdown will show a Draft status.
3. Choose the status in the dropdown, and the status of the gift card will change.
---
## Publish Gift Card
:::note
Publishing a gift card allows customers to see the gift card on the storefront, purchase it, and use it.
:::
### On Gift Cards Page
1. 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 top right of the main gift card.
2. Choose Publish.
### On Edit Gift Card Page
1. In the first section, you'll find the status of the gift card with a <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999685/Medusa%20Docs/UI%20Icons/yrTcDO4_tulwph.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999685/Medusa%20Docs/UI%20Icons/yrTcDO4_tulwph.png" alt="green" /> icon if its published or a <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999700/Medusa%20Docs/UI%20Icons/0lUln3B_arpgmo.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999700/Medusa%20Docs/UI%20Icons/0lUln3B_arpgmo.png" alt="grey" /> icon if its a draft.
2. Click on the status, and a dropdown will show to toggle the status. For example, if the status of the gift card is Published, the dropdown will show a Draft status.
3. Choose the status in the dropdown, and the status of the gift card will change.
---
## Delete Gift Card
:::warning
If you delete a gift card, you cant restore it or its settings. Customers also cant use the gift card if they had previously purchased it.
:::
To delete a gift card:
1. Go to the Gift Cards page from the sidebar menu.
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 next to the main gift card.
3. Choose Delete from the dropdown.
4. Confirm deleting the gift card by clicking the “Yes, delete” button in the pop-up.
@@ -0,0 +1,90 @@
---
sidebar_position: 2
description: 'Learn how to use utility features in the Medusa Admin including lists, quick and advanced filters, pagination, and search functionalities. You can also customize quick features.'
---
import UiIcon from '@site/src/components/UiIcon';
# Lists Overview
In this document, youll get an overview of lists in Medusa including filters, searching, and more!
## Filter Items
You can use filters to retrieve only items in a list matching specific criteria.
### Quick Filters
On a table with a list of items, youll find quick filters at the top of the list.
You can click on one of these filters to quickly apply it to the list of items.
![Quick filters for lists](https://res.cloudinary.com/dza7lstvk/image/upload/v1667998663/Medusa%20Docs/User%20Guide/eVwD0JP_ukor4r.png)
### Advanced Filters
You can use advanced filters to furthermore limit the items shown based on specific criteria. For example, on the Orders list, you can filter orders to only show pending orders created in a specific region.
To use advanced filters:
1. Click on the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999131/Medusa%20Docs/UI%20Icons/1hL8NiW_lqmjcq.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999150/Medusa%20Docs/UI%20Icons/8LtkPqW_jyqz5i.png" alt="plus" /> icon next to Filters. This will toggle a dropdown with categories for different fields.
2. You can click on a field name to expand it and choose a filter for that field.
3. Click on the Apply button at the top of the dropdown.
This will retrieve the items based on the filters youve selected.
![Advanced filters for lists](https://res.cloudinary.com/dza7lstvk/image/upload/v1667998724/Medusa%20Docs/User%20Guide/rg9nKcS_vpwcrg.png)
### Save Advanced Filters as Quick Filters
If there are filters that you need to use frequently, you can give the set of filters a name and save them to be used later. For example, you can save the filters used in the previous example as “European Orders”.
To save an advanced filter:
1. Click on the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999131/Medusa%20Docs/UI%20Icons/1hL8NiW_lqmjcq.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999150/Medusa%20Docs/UI%20Icons/8LtkPqW_jyqz5i.png" alt="plus" /> icon next to Filters.
2. Choose your filters from the dropdown.
3. Choose a name for the filters in the input at the end of the dropdown.
4. Click the Save button.
![Saved Quick filters](https://res.cloudinary.com/dza7lstvk/image/upload/v1667998745/Medusa%20Docs/User%20Guide/0nKZ5BX_r5tdld.png)
Once you click Save, you should see the new filter you added next to the Quick Filters at the top of the list.
![Custom Quick filters shown at the top](https://res.cloudinary.com/dza7lstvk/image/upload/v1667998777/Medusa%20Docs/User%20Guide/ymuSHkv_xey8ao.png)
To apply a saved quick filter, just click on it.
### Delete Saved Quick Filters
You can delete any saved filter youve created. To do that, simply click on the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999180/Medusa%20Docs/UI%20Icons/kvGRHQR_s0ptsm.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999200/Medusa%20Docs/UI%20Icons/RJ4SLIu_n30zqr.png" alt="X" /> icon next to the quick filters name, and it will be deleted.
### Clear Filters
To clear all applied filters:
1. Click on the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999131/Medusa%20Docs/UI%20Icons/1hL8NiW_lqmjcq.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999150/Medusa%20Docs/UI%20Icons/8LtkPqW_jyqz5i.png" alt="plus" /> icon next to Filters.
2. Click on the Clear button.
![Clear filters](https://res.cloudinary.com/dza7lstvk/image/upload/v1667998828/Medusa%20Docs/User%20Guide/ArawLDT_mjye2n.png)
:::info
Clearing filters does not delete saved quick filters. You can still apply them by clicking on them.
:::
---
## Search Items
You can search for items in a list by clicking the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999227/Medusa%20Docs/UI%20Icons/k0U0wpO_pizpfd.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999249/Medusa%20Docs/UI%20Icons/IdKjFak_ultvmh.png" alt="magnifier" /> icon at the top right of the list.
![Search items in a list](https://res.cloudinary.com/dza7lstvk/image/upload/v1667998849/Medusa%20Docs/User%20Guide/Z09rbmQ_jgi4ti.png)
---
## Multiple Pages
Lists in the Medusa admin can span across multiple pages if the number of items in that list are more than 15.
In that case, you can navigate between pages by clicking the arrows at the bottom of the list.
@@ -0,0 +1,9 @@
{
"position": 5,
"collapsed": false,
"link": null,
"label": "Multi-Warehouse",
"customProps": {
"sidebar_is_group_headline": true
}
}
@@ -0,0 +1,33 @@
---
sidebar_position: 1
description: "Multi-warehouse allows you to define multiple locations that your stock items are available in. In the Medusa admin, you can manage the store's inventory and location."
---
# Multi-Warehouse Overview
In this document, youll get an overview of the multi-warehouse setup and how you can use it in the Medusa admin.
:::note
Multi-warehouse requires the Inventory and Stock Location modules to be installed. If youre unsure how to handle that, please contact your technical team for support.
:::
## Overview
Multi-warehouse allows you to define multiple locations that your stock items are available in. You can then specify for each of these locations the quantity of the item. You can also associate locations with multiple [Sales Channels](../sales-channels/index.md).
When fulfilling an order, you can select the location to fulfill the items from. Similarly, when requesting or handling a return, you can select the location to return the item to. This will automatically increment or decrement the quantity as necessary.
It should be noted that the following are not explained within this section of the user guide:
- Item allocation and locations in orders: this is explained in the [Orders section](../orders/manage.mdx).
- Managing general inventory of a product variant: this is explained in the [Products section](../products/manage.mdx).
---
## Learn More About Multi-Warehouse
- [Manage Inventory](./inventory.mdx)
- [Manage Locations](./locations.mdx)
- [Manage Reservations](./reservations.mdx)
@@ -0,0 +1,30 @@
---
sidebar_position: 2
description: "This user guide explains how to manage inventory in the Medusa Admin. Learn how to check and change a variant's quantity in a location."
addHowToData: true
---
import UiIcon from '@site/src/components/UiIcon';
# Manage Inventory
In this document, youll learn how to manage inventory in the Medusa Admin.
## Check Inventory
To check your stores inventory, go to the Inventory page. Here, youll see the available inventory of product variants in a location.
You can switch locations from the select field above the table of inventory. You can also search products through the search field above the table of inventory.
---
## Change Variant Inventory
To change a product variants inventory in a location:
1. Go to the Inventory page.
2. Choose the location you want to change the inventory in from the select field above the table.
3. Find the product variant you want to change its quantity, then 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 its right.
4. Choose “Adjust Availability” from the dropdown.
5. In the new window that opens, change the quantity of the variant.
6. Once done, click on the “Save and close” button.
@@ -0,0 +1,80 @@
---
sidebar_position: 3
description: "This user guide explains how to manage inventory in the Medusa Admin. Learn how to check and change a variant's quantity in a location."
addHowToData: true
---
import UiIcon from '@site/src/components/UiIcon';
# Manage Locations
In this document, youll learn how to manage the stock locations using the Medusa admin.
## Create a Location
To create a location:
1. Go to the Inventory page.
2. Click on the Locations header at the top of the section.
3. Click on the “Add location” button at the top right.
4. In the new form that opens:
1. Enter the location name.
2. Optionally, enter the address details of the location.
3. To associate this location with sales channels:
1. Click on the Sales Channels collapsible.
2. Click on the “Add sales channels” button.
3. In the new window that opens:
1. Click on the “Add Channels” button.
2. Choose the channels you want to add.
3. Click the “Save and close” button.
5. Once youre done, click on the “Add location” button.
---
## Edit a Location
To edit a location:
1. Go to the Inventory page.
2. Click on the Locations header at the top of the section.
3. Find the location you want to edit and 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 its right.
4. Choose “Edit details” from the dropdown.
5. Edit any of the locations details.
6. Once youre done, click the “Save and close” button.
---
## Edit Sales Channels of a Location
To edit the sales channels of a location:
1. Go to the Inventory page.
2. Click on the Locations header at the top of the section.
3. Find the location you want to edit its sales channels, and click on the “Edit channels” button.
4. In the new window that opens:
1. To remove an association to a sales channel:
1. Click on the checkbox next to the sales channel.
2. Click on the Remove button.
2. To associate a sales channel:
1. Click on the “Add Channels” button.
2. Choose the channels you want to add.
3. Click the “Save and go back” button.
5. Once youre done, click the Close button.
---
## Delete a Location
:::warning
Deleting a location cant be undone, and its data cant be restored.
:::
To delete a location:
1. Go to the Inventory page.
2. Click on the Locations header at the top of the section.
3. Find the location you want to delete and 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 its right.
4. Choose “Delete” from the dropdown.
5. Enter the name of the location then click the “Yes, confirm” button.
@@ -0,0 +1,99 @@
---
sidebar_position: 4
description: "This user guide explains how to manage reservations in your store. Learn how to view, create, edit, and delete reservations."
addHowToData: true
---
import UiIcon from '@site/src/components/UiIcon';
# Manage Reservations
In this document, youll learn how to manage reservations in your store.
## View Reservations
To view reservations, go to Inventory from the sidebar, and click on the Reservations header.
In the reservations page, you can view all reservations, either created by an order or created manually.
### Filter by Location
To filter reservations by location:
1. Click on the “All locations” button.
2. Choose the location you want to filter reservations by.
### Other Filters
You can also filter by description, creation date, reserved quantity, and more.
To do that:
1. Click on the “View” button.
2. Apply any filters relevant for you.
3. Click on the “Apply” button.
To reset applied filters:
1. Click on the “View” button.
2. Toggle off applied filters.
3. Click on the “Apply” button.
---
## Create a Reservation
Reservations are created manually when an order is created, and you can also manage them from the orders page.
You can also manually create a reservation from the Reservations page. To create a reservation:
1. Go to Inventory → Reservations.
2. Click on the “Create reservation” button.
3. In the form that opens:
1. For the “Location” field, select the location the reservation is created in.
2. For the “Item to reserve” field, enter the SKU of the item you want to create a reservation for.
3. Select the item from the results that appear. Once you do that, a table shows. In the table:
1. Next to the “Reserve” row, specify the reservation quantity.
2. If you want to remove the selected item and choose a different one, click on the “Remove item” button.
4. You can optionally enter a Description of the reservation.
5. You can optionally enter key-value metadata fields if you have any custom data you want to attach to the reservation. To add or manage the metadata fields:
1. Hover over the available row in the table.
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.
3. Choose the actions in the dropdown to manage the metadata fields.
4. Once youre done, click the “Save reservation” button.
---
## Edit Reservation
To edit a reservation:
1. Go to Inventory → Reservations
2. Find the reservation you want to edit, and 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 on its right.
3. Click on “Edit” from the dropdown.
4. In the side window that opens:
1. You can change the location of the reservation using the Location field.
2. In the table, you can change the reserved quantity by changing the value of the Allocate row.
3. You can change the description of the reservation using the Description field.
4. You can manage the metadata of the reservation:
1. If there arent any metadata fields, you can add a metadata field using the “Add metadata” button.
2. You can add more metadata fields or manage available ones by hovering over a row, clicking 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, and choosing an action from the dropdown.
3. You can remove metadata fields by clicking the “Remove metadata” button.
5. Once youre done, click the “Save and close” button.
---
## Delete Reservation
:::warning
Deleting a reservation cant be undone, and the reservation data cant be restored.
:::
To delete a reservation:
1. Go to Inventory → Reservations
2. Find the reservation you want to edit, and 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 on its right.
3. Click on “Delete” from the dropdown.
4. Confirm deleting the reservation by clicking the “Yes, remove" button in the pop-up.
@@ -0,0 +1,9 @@
{
"position": 3,
"collapsed": false,
"link": null,
"label": "Orders",
"customProps": {
"sidebar_is_group_headline": true
}
}
@@ -0,0 +1,174 @@
---
sidebar_position: 9
description: 'This user guide explains how to manage order claims on the Medusa Admin. Learn how to create claims, manage their returns and fulfillments, and more.'
addHowToData: true
---
import UiIcon from '@site/src/components/UiIcon';
# Manage Order's Claims
In this document, youll learn what claims are, how to create them, and more.
## Overview
If a customer receives a faulty or incorrect item(s) for an order they placed, you can create a claim to either refund or replace the item(s).
When a claim is created, you can choose whether the claim will be resolved through a refund or by replacing the item(s).
---
## Create a Claim
:::caution
If you create a claim of type Refund, a refund is issued to the customer right after the claim is created. Before you can create a claim for an order, you must capture the orders payment, and create fulfillment in the order for the items included in the claim.
:::
:::info
The steps mentioned here regarding an item's location and quantity are only available if you have the Inventory and Stock Location modules installed. You can learn more in the [Multi-Warehouse documentation](../multiwarehouse/index.md).
:::
1. Open the order details page.
2. In the Timeline 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 at the top right.
3. Click on Register Claim in the dropdown.
4. In the new window that opens:
- Choose the items you want to create the claim for. For each item you pick, you must select the reason for the claim:
- Click on the Select Reason button below the item.
- Choose the Reason from the options in the Reason field.
- Optionally add a Note or upload images as part of the reason.
- Click on the Add button.
- Choose the Shipping method to use to return the item.
- You can add a custom price for the shipping method by clicking on the Add custom price button.
- You can remove the custom price by clicking 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 next to the price.
- For the Location field, you can optionally choose the location that the items should be returned to.
- Choose whether the type of the claim is “Refund” or “Replace”. If you choose “Replace”:
- Choose the products you want to send to the customer by clicking Add Product and choosing the product you want to add.
- You can remove a product from the “items to send” list by clicking 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.
- If you want to send the items to another address, click on “Ship to a different address” and fill out the shipping address info.
- Choose the Shipping Method that will be used to deliver the replacement items.
- If you dont want the customer to receive an email that a claim has been created, uncheck the “Send notifications” checkbox.
5. Once youre done, click on the Complete button.
---
## View Claim Details
To view an orders claim details:
1. Open the order details page.
2. In the Timeline section, find the claim and 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 its right.
3. Click on More Details in the dropdown.
---
## Manage a Claims Returns
### Receive a Claims Return
To mark a claims return as received:
1. Open the order details page.
2. In the Timeline section, find the return requested.
3. Click on the Receive Return button.
4. Check or uncheck the items that have been received.
5. Click the Complete button.
### Cancel a Claims Return
:::caution
Canceling a return cant be undone.
:::
To cancel a return of a claim:
1. Open the order details page.
2. In the Timeline section, find the return requested and 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.
3. Click on “Cancel return” in the dropdown.
---
## Manage a Claims Fulfillments
:::caution
This section only applies if the Claims type is Replace.
:::
### Create a Fulfillment for a Claim
You can create fulfillment for items in the claim that you are sending to the customer as a replacement. You can create more than one fulfillment, with each having at least one item.
To create a fulfillment for a claim:
1. Open the order details page.
2. In the Timeline section, find the claim and 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.
3. Click on Fulfill Claim in the dropdown.
4. In the window that opens:
- Choose the items you want to fulfill. You can change the quantity of the items youre fulfilling using the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999131/Medusa%20Docs/UI%20Icons/1hL8NiW_lqmjcq.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999150/Medusa%20Docs/UI%20Icons/8LtkPqW_jyqz5i.png" alt="plus" /> and <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999351/Medusa%20Docs/UI%20Icons/EGk9uYD_a7rwhs.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999366/Medusa%20Docs/UI%20Icons/XvkBK8p_dzhzfx.png" alt="minus" /> icons.
- Optionally add under Metadata any additional information that might be necessary for the fulfillment.
- If you dont want the customer to receive an email that a fulfillment for the claim items has been created, uncheck the “Send notifications” checkbox.
5. Once youre done, click on the Complete button.
### Mark a Claims Fulfillment Shipped
To mark a claims fulfillment as shipped:
1. Open the order details page.
2. Scroll down to the Fulfillment section.
3. Find the fulfillment you want to mark as shipped. A claims fulfillments title should be prefixed with “Claim fulfillment”.
4. 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 it.
5. Click on Mark Shipped in the dropdown.
6. In the new window that opens:
- Enter a tracking number for the shipment.
- If you have more than one tracking number, click on the “Add Additional Tracking Number” to add more numbers.
- If you dont want the customer to receive an email that the fulfillment has been shipped, uncheck the “Send notifications” checkbox.
7. Once youre done, click the Complete button.
Shipment details can be seen in the Timeline section.
### Cancel a Claims Fulfillment
:::caution
If you cancel a fulfillment, it cant be reverted. Only a fulfillment that hasnt been marked as shipped can be canceled.
:::
To cancel a claims fulfillment:
1. Open the order details page.
2. Scroll down to the Fulfillment section.
3. Find the fulfillment you want to cancel. A claims fulfillments title should be prefixed with “Claim fulfillment”.
4. 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 it.
5. Click on Cancel Fulfillment in the dropdown.
6. Confirm canceling the fulfillment by clicking the “Yes, confirm” button in the pop-up.
---
## Cancel a Claim
### For Refund Claims
A claim of type Refund can be canceled by just [canceling the return of the claim](#cancel-a-claims-return). However, the refund can not be reverted.
### For Replace Claims
:::caution
Canceling a claim cant be undone. The [return of the claim must be canceled](#cancel-a-claims-return) before the claim itself is canceled.
:::
To cancel a claim of type Replace:
1. Open the order details page.
2. In the Timeline section, find the claim and 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.
3. Click on Cancel Claim in the dropdown.
4. Confirm canceling the fulfillment by clicking the “Yes, remove” button in the pop-up.
@@ -0,0 +1,130 @@
---
sidebar_position: 6
description: 'This user guide explains how to manage draft orders on the Medusa Admin. Learn how to create a draft order, view its details, edit a draft order, cancel a draft order, and more.'
addHowToData: true
---
import UiIcon from '@site/src/components/UiIcon';
# Manage Draft Orders
In this document, youll learn more about draft orders, how to create them, and more.
## Overview
Draft orders are orders created from the Medusa admin. Existing products or custom items can be added to the order as purchased items. You can also specify custom shipping amounts.
After a draft order is created and is marked as paid, an order will be created based on that draft order and it will appear as part of the Orders list.
---
## Create a Draft Order
To create a draft order:
1. Go to Orders → Drafts.
2. Click on “Create draft order” at the top right.
3. A new window then opens with six steps to go through to create the draft order:
1. In the first step, choose the region this draft order belongs to, then click the Next button.
2. In the second step, add items to the order. You must add at least one item. Once youre done, click the Next button.
1. To add existing products:
1. Click on the Add Existing button.
2. Choose the products you want to add into the draft order by clicking the checkbox at the left of the product. You can choose more than one product.
3. Once done, click on the Add button.
2. To add a custom item:
1. Click on the Add Custom button.
2. Enter the title, price, and quantity of the custom item.
3. Click on the Add button.
3. To remove an item you added, 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 at the right of the item.
4. To change the quantity of any item, use the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999131/Medusa%20Docs/UI%20Icons/1hL8NiW_lqmjcq.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999150/Medusa%20Docs/UI%20Icons/8LtkPqW_jyqz5i.png" alt="plus" /> and <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999351/Medusa%20Docs/UI%20Icons/EGk9uYD_a7rwhs.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999366/Medusa%20Docs/UI%20Icons/XvkBK8p_dzhzfx.png" alt="minus" /> icons under the Quantity column.
5. Once youre done, click the Next button.
3. In the third step, choose a shipping method then click the Next button.
1. If you want to change the default price of the shipping method, click on the “Set custom price” button and enter the price you want to use.
2. If you want to remove the custom price, you can 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.
4. In the fourth step, enter the customers details and shipping address.
1. If the customer already exists, you can choose it from the "Find existing customer" input. You can search the list of customers by name or email. This fills out the fields under the General section as well.
2. If this is a new customer, in the "Email" field, enter the email of the customer to add. Then, fill out the customers first name, last name, and phone number in the General section.
3. In the Shipping Address section, enter the customers address details such as the Address line, postal code, and more.
4. Once youre done, click on the Next button.
5. In the fifth step, specify the billing address details.
1. If the billing address is the same as the shipping address, you can just check the “Use same as shipping” checkbox.
2. If the billing address is different than the shipping address, fill out the information under the General and Billing Address as instructed in the previous step.
3. Once done, click the Next button.
6. In the last step, confirm that all the information is correct.
1. If you want to add a discount, click on the Add Discount button and enter the discount code.
2. If you want to edit any of the draft orders info, click on the Edit link next to any of the sections. This will take you back to the step associated with that section.
4. Once youre done following all the six steps, click on the Submit button.
---
## Open Draft Orders Details
To open a draft orders details page:
1. Go to Orders → Drafts.
2. Select the draft order you want to view.
---
## Edit Draft Order Info
### Edit Shipping Address
To edit the shipping address of a draft order:
1. Open the draft order details page.
2. Scroll down to the customer section and 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 that section.
3. Click on Edit Shipping Address in the dropdown.
4. This opens a new window to edit the shipping addresss info.
5. Once youre done click on the "Save and close" button.
---
## Cancel Draft Order
:::warning
Canceling a draft order cannot be undone and the draft order will be removed from the list of draft orders.
:::
To cancel a draft order:
1. Open the draft order 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 top right of the first section.
3. Click on Cancel Draft Order in the dropdown.
4. Confirm canceling the draft order by clicking the “Yes, remove” button in the pop-up.
---
## Mark Draft Order as Paid
:::caution
When you mark a draft order as paid, a new order is created and associated with this draft order. This cant be undone, but the new order created can be canceled.
:::
To mark a draft order as paid:
1. Open the draft order details page.
2. Scroll down to the Payment section.
3. Click on the “Mark as paid” button.
4. Confirm your action by clicking the “Mark paid” button in the pop-up.
You should see a new order in the Orders list now.
---
## Go to Associated Order
:::info
This is only available after a draft order is marked as paid.
:::
To go to the order associated with the draft order.
1. Open the draft order details page.
2. Click on the “Go to Order” button at the top right of the first section.
@@ -0,0 +1,89 @@
---
sidebar_position: 5
description: 'This user guide explains how to edit the items in an order in the Medusa admin. You can add, update, replace, duplicate, and delete items.'
addHowToData: true
---
import UiIcon from '@site/src/components/UiIcon';
# Edit an Orders Items
In this document, youll learn how to edit items in an order. This includes adding, updating, or deleting items.
## Overview
Using the Medusa Admin, you can edit the items in an order. You can perform the following edits:
- Add a new item to the order.
- Edit the quantity of an existing item in the order.
- Delete an item from the order.
When you request an order edit, the changes arent actually saved and reflected on the order until the order edit is confirmed.
There are two ways to confirm an order edit request:
1. The customer reviews the order edit. If they accept the order edit and an additional payment is required, then theyll have to authorize that payment. The customer can also reject the order edit;
2. Or you force-confirm the order edit. In this case, the order edit is reflected on the original order. If there are any additional payment required, you would have to handle that manually with the customer.
---
## Request an Order Edit
:::info
You cant request an order edit if another order edit is already requested.
:::
To request an order edit:
1. Open the order details page.
2. Click on the “Edit Order” button at the top right of the Summary section.
3. In the new window that opens:
1. To add an item:
1. Click on the “Add items” button.
2. Click on the checkbox next to the items you want to add.
3. Once done, click on the “Save and go back” button.
2. To update an items quantity:
1. Click on the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999131/Medusa%20Docs/UI%20Icons/1hL8NiW_lqmjcq.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999150/Medusa%20Docs/UI%20Icons/8LtkPqW_jyqz5i.png" alt="plus" /> or <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999351/Medusa%20Docs/UI%20Icons/EGk9uYD_a7rwhs.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999366/Medusa%20Docs/UI%20Icons/XvkBK8p_dzhzfx.png" alt="minus" /> icons next to the quantity of the item you want to edit.
3. To replace an item:
1. 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 item.
2. Click on “Replace with other item” from the dropdown.
3. Choose the replacement by clicking on the radio button next to the new item.
4. Once done, click on the “Save and go back” button.
4. To duplicate an item:
1. 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 item.
2. Click on “Duplicate item” from the dropdown.
5. To delete an item:
1. 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 item.
2. Click on “Remove item” from the dropdown.
6. You can optionally enter a note for the customer to see in the Note field.
4. Once done, click on the “Save and close” button.
---
## Force Confirm an Order
:::warning
When you force confirm an order edit, the changes will be reflected on the order. If the order edit requires additional payment, youll have to manually receive that payment from the customer.
:::
To force confirm an order:
1. Open the order details page.
2. Find the order edit in the Timeline section.
3. Click on the “Force Confirm” button.
4. Confirm your action by clicking the “Yes, Force Confirm” button in the pop-up.
---
## Cancel an Order Edit Request
To cancel an order-edit request:
1. Open the order details page.
2. Find the order edit in the Timeline section.
3. Click on the “Cancel Order Edit” button.
4. Click the button again to confirm canceling the order.
@@ -0,0 +1,81 @@
---
sidebar_position: 8
description: 'This user guide explains how to manage exchanges in the Medusa Admin. Learn how to create an order exchange, create an order exchange, mark an order exchange return as received, and cancel an exchange.'
addHowToData: true
---
import UiIcon from '@site/src/components/UiIcon';
# Manage Exchanges
In this document, youll learn how to manage order exchanges including how to find customers requested order exchanges, how to create them, and how to fulfill them.
## Find Requested Order Exchanges
To find customers requested order exchanges:
1. Go to an orders details page.
2. In the Timeline section, if there are any requested exchanges youll find them with the title “Exchange Requested”.
## Create an Order Exchange
:::info
- An exchange can only be created if the orders payment is captured and the items have been fulfilled.
- The steps mentioned here regarding an item's location and quantity are only available if you have the Inventory and Stock Location modules installed. You can learn more in the [Multi-Warehouse documentation](../multiwarehouse/index.md).
:::
To create an order exchange:
1. Go to an orders details page.
2. In the Timeline 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.
3. Click on Register Exchange from the dropdown.
4. In the new window that opens:
1. Choose the items you want the customer to return. For each item you select:
1. Click on the Select Reason button.
2. Choose a reason from available Reasons. If you cant find any Reasons, make sure to add [Return Reasons in Settings](../settings/return-reasons.mdx#add-return-reason) first.
3. You can optionally add a Note.
4. Once youre done, click on the Add button.
2. Choose a Shipping Method to return the customers items.
1. You can optionally specify a custom price for shipping by clicking the “Add custom price” button.
2. You can remove the custom price by clicking 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.
3. For the Location field, you can optionally choose the location that the items should be returned to.
4. In the “Items to send” section, click on the Add Product button. Then:
1. Check the products you want to send to the customer in exchange.
2. When youre done, click the Add button.
3. You can remove products youve added by clicking 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.
4. You can change the quantity of the product to send using the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999131/Medusa%20Docs/UI%20Icons/1hL8NiW_lqmjcq.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999150/Medusa%20Docs/UI%20Icons/8LtkPqW_jyqz5i.png" alt="plus" /> and <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999351/Medusa%20Docs/UI%20Icons/EGk9uYD_a7rwhs.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999366/Medusa%20Docs/UI%20Icons/XvkBK8p_dzhzfx.png" alt="minus" /> icons.
5. If you dont want the customer to receive an email that an exchange has been registered, uncheck the “Send notifications” checkbox.
5. Once youre done, click the Complete button.
## Mark an Exchanges Return as Received
To mark a return that is part of an exchange as received:
1. Go to an orders details page.
2. In the Timeline section, find the order exchange.
3. Click on the Receive Return button.
4. Check the items you want to mark as received.
5. Click the Complete button.
## Cancel an Exchange
:::warning
Canceling an exchange cant be undone.
:::
The return of an exchange must be canceled first before the exchange itself can be canceled. If the return has been marked as received, the exchange cant be canceled after that.
To cancel an exchange:
1. Go to an orders details page.
2. In the Timeline section, find the order exchange.
3. 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 it.
4. Click on “Cancel return” from the dropdown.
5. Confirm canceling the return by clicking the “Yes, cancel” button in the pop-up.
6. 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 again next to the order exchange.
7. Click on “Cancel exchange” from the dropdown.
8. Confirm canceling the exchange by clicking the “Yes, cancel” button in the pop-up.
@@ -0,0 +1,66 @@
---
sidebar_position: 10
description: 'This user guide explains how to export a list of orders on the Medusa admin.'
addHowToData: true
---
import UiIcon from '@site/src/components/UiIcon';
# Export Orders
In this document, youll learn how to export all orders in your Medusa store.
## Overview
When you export your orders, you can obtain a list of your orders and their details in a CSV file. This can be useful if you want to migrate from one Medusa backend to another, or if you need the CSV file for other purposes.
---
## Export List of Orders
To export orders:
1. Go to Orders page.
2. Click on Export Orders at the top right.
3. Click Export in the window that opens.
4. Click on the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999016/Medusa%20Docs/UI%20Icons/mWhpxNX_xteuos.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999044/Medusa%20Docs/UI%20Icons/tE8LOXk_puyrib.png" alt="bell" /> icon at the top right of the page.
5. You should see your new export loading.
6. Once the export is ready, click on the Download button.
:::note
If you face any errors or difficulties, please contact your technical support team as this could be an issue in the storage integration used.
:::
---
## Cancel an Order Export
:::info
You can only cancel an unfinished order export.
:::
To cancel an order export:
1. Click on the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999016/Medusa%20Docs/UI%20Icons/mWhpxNX_xteuos.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999044/Medusa%20Docs/UI%20Icons/tE8LOXk_puyrib.png" alt="bell" /> icon at the top right of the page.
2. Find the export you want to cancel.
3. Click on the cancel button.
---
## Delete an Order Export
:::info
You can only delete a finished order export.
:::
To delete an order export:
1. Click on the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999016/Medusa%20Docs/UI%20Icons/mWhpxNX_xteuos.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999044/Medusa%20Docs/UI%20Icons/tE8LOXk_puyrib.png" alt="bell" /> icon at the top right of the page.
2. Find the export you want to delete.
3. Click on the Delete button.
@@ -0,0 +1,86 @@
---
sidebar_position: 4
sidebar_label: Manage Fulfillments
description: 'This user guide explains how to manage order fulfillments in the Medusa Admin. Learn how to create fulfillments, mark fulfillments as shipped, and cancel fulfillments.'
addHowToData: true
---
import UiIcon from '@site/src/components/UiIcon';
# Manage Order's Fulfillments
In this tutorial, youll learn about order fulfillments and how to manage them, including how to create fulfillments and mark them as shipped.
## Overview
When a customer places an order, the fulfillment status of the order will be “not_shipped”. You can then create fulfillments and mark them as shipped once you ship the items.
You can create more than one fulfillment, with each fulfillment used for at least one item in the order.
If some items of the order are fulfilled, the orders fulfillment status will be “partially_shipped”. Once all items are shipped, the orders fulfillment status will be “shipped”.
---
## Create Fulfillment
:::info
The steps mentioned here regarding an item's location and quantity are only available if you have the Inventory and Stock Location modules installed. You can learn more in the [Multi-Warehouse documentation](../multiwarehouse/index.md).
:::
To create a fulfillment for an order:
1. Open the order details page.
2. Scroll down to the Fulfillment section.
3. Click on the Create Fulfillment button.
4. In the window that opens:
- Choose the location you want to fulfill the items from.
- Under Items to fulfill, enter the quantity of the items you want to fulfill.
- Optionally enter any additional information you want to associate with the fulfillment under the Metadata section.
- If you dont want the customer to receive an email that a fulfillment has been created, uncheck the “Send notifications” checkbox.
5. Once done, click on the "Create fulfillment" button.
You can check the fulfillment details in the Fulfillment and Timeline sections.
---
## Mark a Fulfillment Shipped
:::caution
Once a fulfillment is marked as shipped, it cant be reverted. You must [create a fulfillment](#create-fulfillment) first before you can mark it as shipped.
:::
To mark a fulfillment as shipped in an order:
1. Open the order details page.
2. Scroll down to the Fulfillment section.
3. Find the fulfillment you want to mark as shipped, then 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 it.
4. Click on Mark Shipped in the dropdown.
5. In the new window that opens:
- Enter a tracking number for the shipment.
- If you have more than one tracking number, click on the “Add Additional Tracking Number” to add more numbers.
- If you dont want the customer to receive an email that the fulfillment has been shipped, uncheck the “Send notifications” checkbox.
6. Once youre done, click the Complete button.
Shipment details can be seen in the Timeline section.
---
## Cancel a Fulfillment
:::caution
If you cancel a fulfillment, it cant be reverted. Only a fulfillment that hasnt been marked as shipped can be canceled.
:::
To cancel a fulfillment in an order:
1. Open the order details page.
2. Scroll down to the Fulfillment section.
3. Find the fulfillment you want to cancel, then 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 it.
4. Click on Cancel Fulfillment in the dropdown.
5. Confirm canceling the fulfillment by clicking the “Yes, confirm” button in the pop-up.
@@ -0,0 +1,44 @@
---
sidebar_position: 1
sidebar_label: Overview
description: 'Medusa Admin allows merchants to manage orders. Merchants can view order information, capture payment, create shipments and fulfillments, and more.'
---
# Orders Overview
In this document, youll get an overview of the orders listing page and everything you can do with it.
## Overview
When customers buy one or more products, their order appears on the Orders page. You can view an orders information, capture payment, create shipments and fulfillments, register returns or exchanges of the order, and more.
The Orders domain also contains draft orders. Draft orders are orders that you create from the Medusa admin. After you fill out the order and mark it paid, its transformed into an order that appears as part of the Orders list.
---
## View List of Orders
You can view the list of available orders in your ecommerce store by clicking on Orders from the sidebar menu.
In the list, you can see order details such as the ID, date, customer, fulfillment and payment status, total, and the country of the shipping address.
---
## View List of Draft Orders
You can view the list of draft orders on the Orders page by clicking on the grey Drafts headline next to the Orders headline.
In the list, you can see order details such as ID, the ID of the order the draft order belongs to, the date, the customer, and the status of the draft order.
---
## Learn More About Orders
- [Manage Order Details](./manage.mdx)
- [Manage Orders Payment](./payments.md)
- [Manage Orders Fulfillment](./fulfillments.mdx)
- [Manage Draft Orders](./drafts.mdx)
- [Manage Order Returns](./returns.mdx)
- [Manage Order Claims](./claims.mdx)
- [Manage Order Exchanges](./exchange.mdx)
- [Export Orders](./export.mdx)
@@ -0,0 +1,198 @@
---
sidebar_position: 2
sidebar_label: Manage Details
description: 'Learn in this user guide how to manage orders on the Medusa Admin. Learn how to find the order details page, what information can be found on that page, and how to manage the order details such as shipping address or email.'
addHowToData: true
---
import UiIcon from '@site/src/components/UiIcon';
# Manage Order Details
In this document, youll learn how to find an orders details page, what information you can find on the order details page, and how to manage some of the orders details.
## Open Orders Details
To open an orders details:
1. Go to Orders.
2. Select one of the orders.
This opens the orders details page.
---
## Sections of the Order Details Page
### Order Summary
The first section of the page shows the summary of the order, including its current status, date created, email, and payment method.
### Timeline
This section of the order details page shows a summary of the orders history. This includes updates to the orders status, requests for return or exchange, notes, and more.
### Summary
This section includes the summary of the items the customer purchased as well as totals related to taxes, shipping, and more.
### Payment
This section includes details related to the orders payments and allows you to capture the authorized payment.
### Fulfillment
This section includes details related to the shipping method and fulfillment and allows you to create fulfillment.
### Customer
This section includes the customers details, including their shipping address.
---
## Manage Item Allocation
:::note
This feature is only available if you have the Inventory and Stock Locations module installed. You can learn more in the [Multi-Warehouse documentation](../multiwarehouse/index.md).
:::
Item allocation occurs when a customer places an order. The ordered quantity of the items is considered reserved of the underlying product variant's quantity in a stock location. This is only applied for product variants that have "Manage Inventory" enabled.
You can manage the item's allocation by managing the location that the item's quantity will be reserved from.
### Allocate an Item
Items should be allocated by default. However, in some edge cases the item may need to be allocated manually.
To allocate an Item:
1. Go to the order details page.
2. Scroll to the Summary section.
3. You should see an "Awaits allocation" badge at the top of the Summary section. Click on it.
4. In the form that opens:
1. For the Location field, choose the location to allocate the item from.
2. In the Items to Allocate section, choose the quantity to allocate for each item.
5. Once you're done, click the "Save allocation" button.
### Edit Item Allocation
If an item is already allocated, you can edit its allocation by following these steps:
1. Go to the order details page.
2. Scroll to the Summary section.
3. Find the item you want to change its allocation. If the item is already allocated, you should see a <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1680265348/Medusa%20Docs/UI%20Icons/check-circle-solid-lightpng_yvyrz0.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1680265348/Medusa%20Docs/UI%20Icons/check-circle-solid-dark_eo8dgm.png" alt="check" /> icon next to it.
4. Hover over the icon, then click the "Edit Allocation" button.
5. In the new window that opens:
1. In the Locations field, choose the location to allocate this item from.
2. Once done, click the "Save and close" button.
### Delete Item Allocation
To delete an item allocation:
1. Go to the order details page.
2. Scroll to the Summary section.
3. Find the item you want to delete its allocation. If the item is already allocated, you should see a check icon next to it.
4. Hover over the icon, then click the "Edit Allocation" button.
5. In the new window that opens, click on the "Delete allocation" button.
---
## Edit the Shipping Address
To edit the shipping address used for an order:
1. Open the order details page.
2. Scroll down to the Customer section.
3. 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.
4. Click on Edit Shipping Address from the dropdown.
5. This opens a new window to edit the shipping address.
6. Once youre done, click on the Save button.
---
## Edit the Billing Address
To edit the billing address used for an order:
1. Open the order details page.
2. Scroll down to the Customer section.
3. 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.
4. Click on Edit Billing Address from the dropdown.
5. This opens a new window to edit the billing address.
6. Once youre done, click on the Save button.
---
## Edit Email Address
To edit the email address associated with an order:
1. Open the order details page.
2. Scroll down to the Customer section.
3. 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.
4. Click on Edit Email Address from the dropdown.
5. This opens a new window to edit the email address.
6. Once youre done, click on the Save button.
---
## Transfer Customer Ownership
To change the customer that placed this order:
1. Open the order details page.
2. Scroll down to the Customer section.
3. 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.
4. Click on "Transfer ownership" from the dropdown.
5. In the new window that opens choose the new customer to own this order.
6. Once done, click on the Confirm button.
---
## Add a Note
To add a note to an order:
1. Open the order details page.
2. In the Timeline section, enter the note in the text input. You can also choose emojis by clicking the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999389/Medusa%20Docs/UI%20Icons/UwA7Ljp_mlt58a.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999407/Medusa%20Docs/UI%20Icons/9lcr16b_e5gcqz.png" alt="emoji" /> icon.
3. Once done, click on the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999420/Medusa%20Docs/UI%20Icons/hH4pKe3_ltdg5o.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999435/Medusa%20Docs/UI%20Icons/QlvPezL_zsyikc.png" alt="send" /> icon.
The note will be added and can be seen in the timeline.
---
## Delete a Note
:::caution
Deleted notes cant be retrieved.
:::
To delete a note in an order:
1. Open the order details page.
2. In the Timeline section, find the note you want to delete from the timeline.
3. 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 note.
4. Click on Delete from the dropdown.
5. Confirm deleting the note by clicking the “Yes, delete” button in the pop-up.
---
## Cancel an Order
:::warning
Once an order is canceled it cant be undone.
:::
To cancel an order:
1. Open the order details page.
2. In the first section showing the orders number, 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" /> at the top right.
3. Click on Cancel Order from the dropdown.
4. Confirm canceling the order by clicking the “Yes, confirm” button in the pop-up.
@@ -0,0 +1,55 @@
---
sidebar_position: 3
sidebar_label: Manage Payments
addHowToData: true
---
# Manage Order's Payments
In this document, youll learn how to manage an orders payment, including capturing and refunding the payment.
## Overview
When a customer places an order, using the payment provider they choose during checkout, they authorize the payment.
The payment isnt automatically captured. You must capture it manually from the Medusa admin.
---
## Capture Payment
:::info
Payment can only be captured once.
:::
To capture an orders payment:
1. Open the order details page.
2. Scroll to the Payment section.
3. Click on the Capture Payment button.
---
## Refund Payment
:::caution
Refunding payments cant be undone. Payment can only be refunded after it has been captured.
:::
To refund an orders payment:
1. Open the order details page.
2. Scroll to the Payment section.
3. Click on the Refund button.
4. In the new window that opens:
- Enter the Refund amount. It must be less than the Total Paid amount specified in the Payment section.
- In the Reason field, choose a reason for the refund.
- For the Note field, you can optionally provide a note for the customer to see.
- If you dont want the customer to receive an email that the refund has been made, uncheck the “Send notifications” checkbox.
5. Once youre done, click on the Complete button.
You can check refund details in the Payment, Summary, and Timeline sections.
@@ -0,0 +1,92 @@
---
sidebar_position: 7
sidebar_label: Manage Returns
description: 'This user guide explains how to manage order returns on the Medusa Admin. Learn how to request a return for an order, mark a return as received, and cancel a return.'
addHowToData: true
---
import UiIcon from '@site/src/components/UiIcon';
# Manage Orders Returns
In this document, youll learn more about order returns, how to request a return, and more.
## Overview
Part of the order management system that Medusa provides is automating and managing order returns.
There are two ways of returns for an order to be requested:
1. The customer requests a return for an order through the storefront, which the store operator can view on the admin.
2. The store operator requests to receive a return from the customer. The customer can be informed about this through an email.
After a return is requested, the store operator can choose to either cancel the return or mark it as received. When a return is marked as received, a refund is issued to the customer.
---
## Find Return Requests of an Order
To find return requests of an order:
1. Open the order details page.
2. On the Timeline section, youll find any returns requested, whether by store operators or by customers.
---
## Request a Return for an Order
:::info
The steps mentioned here regarding an item's location and quantity are only available if you have the Inventory and Stock Location modules installed. You can learn more in the [Multi-Warehouse documentation](../multiwarehouse/index.md).
:::
To request a return for an order:
1. Open the order details page.
2. In the Timeline 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 at the top right.
3. Click on Request Return in the dropdown.
4. In the new window that opens:
- Choose the items in the order that you want to request the return.
- For each item that you choose, click on the Select Reason below that item.
- Choose a [Return Reason](../settings/return-reasons.mdx#add-return-reason), optionally enter a Note, then click the Add button.
- For the Location field, you can optionally choose the location you want these items to be returned to.
- Select a shipping method you want to use for this return.
- If you want to change the default price of the shipping method, click on the “Add custom price” button and enter the price you want to use.
- If you want to remove the custom price, you can 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.
- If you dont want the customer to receive an email that a return has been requested, uncheck the “Send notifications” checkbox.
5. Once done, click on the Submit button.
---
## Receive Return
:::caution
Once the return is marked as received, a refund will be issued to the customer. A return can only be marked as “received” if the payment of the order or the items chosen in the return is captured.
:::
To mark a return as received:
1. Open the order details page.
2. In the Timeline section, find the return requested.
3. Click on the Receive Return button.
4. Check or uncheck the items that have been received.
5. Click the Complete button.
---
## Cancel a Return
:::danger
If a return is canceled it cant be undone. A return can only be canceled if it hasnt been marked as received.
:::
To cancel a return:
1. Open the order details page.
2. In the Timeline section, find the return requested and 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.
3. Click on “Cancel return” in the dropdown.
@@ -0,0 +1,9 @@
{
"position": 8,
"collapsed": false,
"link": null,
"label": "Price Lists",
"customProps": {
"sidebar_is_group_headline": true
}
}
@@ -0,0 +1,83 @@
---
sidebar_position: 3
description: 'This user guide explains how to import prices to a price list on the Medusa admin.'
addHowToData: true
---
import UiIcon from '@site/src/components/UiIcon';
# Import Prices
In this document, youll learn how to import prices into your Medusa store.
## Overview
To import prices, you must have the prices in a CSV file. You can see a template of the CSV file during the import process.
:::note
For a list of accepted columns, refer to [this guide](../../modules/price-lists/admin/import-prices.mdx#csv-file).
:::
:::caution
When you import prices into a price list, it removes existing prices and adds new prices.
:::
---
## Import Prices into a Price List
To import prices into a price list:
1. Go to the price lists details page.
2. In the Prices 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.
3. Click on “Import price list” from the dropdown.
4. In the new window:
1. If youre unsure of what the CSV files format must be like, you can download a template CSV file by clicking the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999458/Medusa%20Docs/UI%20Icons/fhRqHS3_kwmafj.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999472/Medusa%20Docs/UI%20Icons/HdVNMNy_qrk8ez.png" alt="download" /> icon.
2. To upload the CSV file you want to import prices from, either:
1. Drag and drop the file into the dashed box;
2. Or click on the dashed box and choose the file you want to import the prices from.
3. After you upload the CSV file:
1. You can check the number of prices to be added above the uploaded files name.
2. You can remove the file you choose by clicking 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 youre done choosing a file to import prices from, click on the Import List button.
This starts the import process. Based on the number of prices youre importing, it can take some time.
:::note
If you face any errors or difficulties, please contact your technical support team as this could be an issue in the storage integration used.
:::
### Check Import Status
To check the status of the import:
1. Click on the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999016/Medusa%20Docs/UI%20Icons/mWhpxNX_xteuos.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999044/Medusa%20Docs/UI%20Icons/tE8LOXk_puyrib.png" alt="bell" /> icon at the top right of the page.
2. Find the price import, which should be the latest item on the list.
If a loading indicator is showing, then the import process is still in progress.
If the import is done, you should see the text “Import of prices is done.”
Once the import is done, you should find the news prices on the price lists details page.
---
## Cancel Import
:::info
You can only cancel an unfinished prices import.
:::
To cancel a price import:
1. Click on the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999016/Medusa%20Docs/UI%20Icons/mWhpxNX_xteuos.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999044/Medusa%20Docs/UI%20Icons/tE8LOXk_puyrib.png" alt="bell" /> icon at the top right of the page.
2. Find the import you want to cancel.
3. Click on the cancel button.
@@ -0,0 +1,31 @@
---
sidebar_position: 1
description: 'Medusa admin allows merchants to manage their price lists. Merchants can override prices or create sales using price lists.'
---
# Price Lists Overview
In this document, you learn about what price lists are and get an overview of the Pricing page.
## Overview
Price lists are used to add a sale or override the pricing of one or more products based on specific conditions.
Adding a price list on a set of products would change the prices of these products to an amount you set. You can set the start and end dates of these prices.
You can also specify customer groups to which these prices will be applied. For example, you may apply reduced pricing for VIP customers.
---
## View List of Price Lists
You can view the list of available price lists in your ecommerce store by clicking on Pricing from the sidebar menu.
In the list, you can see price list details such as the name, description, and status of the price list.
---
## Learn More About Price Lists
- [Manage a Price List](./manage.mdx)
- [Import Prices](./import.mdx)
@@ -0,0 +1,175 @@
---
sidebar_position: 2
description: 'This user guide explains how to manage price lists on the Medusa admin. Learn how to create, edit, and delete price lists.'
addHowToData: true
---
import UiIcon from '@site/src/components/UiIcon';
# Manage Price Lists
In this document, youll learn how to create, update, and delete price lists and their related information.
## Create a Price List
To create a price list:
1. Go to the Pricing page.
2. Click on the “Add price list” button at the top right.
This opens the form to create the price list in a new window. The form is split into different sections.
### Price List Type
In this section, choose the type of the price list. It can be either a Sale or an Override.
### General
In this section, enter the name and description of the price list. Both fields are required.
### Configuration
In this section, you can choose some optional configurations that determine how the price list will be applied:
1. To specify the start or end dates:
1. Toggle the “Price overrides has a start date” or “Price overrides has an expiry date” fields.
2. Choose the date and time.
2. To specify customer groups that this price list will be applied for:
1. Toggle the “Customer availability” field.
2. In the Customer Groups field, choose at least one customer group.
### Prices
In this section, you must choose at least one product and specify the prices you want to apply to at least one of its variants.
1. To add product prices:
1. Click on the “Add Products Manually” button.
2. Choose at least one product from the list.
3. Click the Save button. The products will then be seen under the Prices section.
4. For each product you added:
1. Click on the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999131/Medusa%20Docs/UI%20Icons/1hL8NiW_lqmjcq.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999150/Medusa%20Docs/UI%20Icons/8LtkPqW_jyqz5i.png" alt="plus" /> icon at its right.
2. To add the same price for all variants:
1. 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 any of the variants.
2. Choose “Edit Prices” from the dropdown.
3. In the new window, choose the “Apply on all variants” option.
4. Enter the price for each currency.
5. Click on the “Save and close” button.
3. To add a price for each variant:
1. 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 a variant.
2. Choose “Edit Prices” from the dropdown.
3. In the new window, choose the “Apply overrides on selected variants” option.
4. Choose the variants that you want to apply the current pricing to.
5. Enter the price for each currency.
6. Click on the “Save and close” button.
4. To remove a variant from the price list:
1. 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 variant.
2. Click on "Remove from List" from the dropdown.
2. To remove products from the prices list:
1. Click on the “Add Products Manually” button.
2. Uncheck the products you previously added and want to remove.
3. Click on the Save button.
### Save the Price List
To save the price list you can either:
1. Click the “Save as draft” button to save the price list without publishing it;
2. Or click the “Publish price list” button to save and publish the price list.
---
## View Price List Details
To view a price lists details:
1. Go to the Pricing page.
2. Click on the price list you want to view.
---
## Change Price List Status
:::info
Publishing a price list makes it and its prices available to customers. Unpublishing a price list makes it and its prices unavailable to customers.
:::
To change a price lists status:
1. Go to the Pricing 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 next to the price list.
3. Based on the current status, click on the Unpublish or Publish links in the dropdown to change the status.
---
## Edit Price Lists Configurations
To edit a price lists information and configurations:
1. Go to the price lists 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 price list details”.
4. This opens a form in a new window that has the [same sections as the Create Price List form](#create-a-price-list), except for the Prices section. You can edit the price lists general information, customer groups, and start and end dates.
5. Once youre done making changes, click on the Save changes button.
---
## Manage Prices
### Add Product Prices
To add new product prices:
1. Go to the price lists details page.
2. In the Prices 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.
3. Click on “Edit manually” in the dropdown.
4. This opens a new window with a form similar to the [Prices section in the Create form](#prices). You can search for or manually add products.
5. Once youre done, click on the “Save changes” button.
### Edit a Products Prices
To edit the prices in the price list:
1. Go to the price lists details page.
2. Find the product you want to edit in the Prices section.
3. 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 it.
4. Choose “Edit prices” from the dropdown.
5. In the new window:
1. Click on the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999131/Medusa%20Docs/UI%20Icons/1hL8NiW_lqmjcq.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999150/Medusa%20Docs/UI%20Icons/8LtkPqW_jyqz5i.png" alt="plus" /> icon next to the products name to expand the list of variants.
2. Click on the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999494/Medusa%20Docs/UI%20Icons/RxZhOoi_sismq2.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999509/Medusa%20Docs/UI%20Icons/iKh5Q7h_iuwp7r.png" alt="right arrow" /> icon next to the variant you want to edit.
3. Edit the prices of the variant for each currency.
4. Once youre done, click on the “Save and close” button.
6. Once youre done editing the products prices, click on the Save button.
### Delete a Products Prices
:::warning
Deleting a products prices in a price list cannot be undone.
:::
To delete all the prices of a product in a price list:
1. Go to the price lists details page.
2. Find the product you want to edit in the Prices section.
3. 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 it.
4. Click on “Remove product” in the dropdown.
---
## Delete Price List
:::caution
Deleting a price list cannot be undone. Prices defined in the price list will no longer be available for the customers.
:::
To delete a price list:
1. Go to the Pricing 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 next to the price list you want to delete.
3. Click on Delete in the dropdown.
4. Confirm deleting the price list by clicking the “Yes, confirm” button in the pop-up.
@@ -0,0 +1,9 @@
{
"position": 3,
"collapsed": false,
"link": null,
"label": "Products",
"customProps": {
"sidebar_is_group_headline": true
}
}
@@ -0,0 +1,78 @@
---
sidebar_position: 3
description: 'This user guide explains how to manage categories on the Medusa admin. Learn how to create a category, edit existing categories, delete a category, and more.'
addHowToData: true
---
import UiIcon from '@site/src/components/UiIcon';
# Manage Categories
In this document, youll learn how to create a category, edit existing categories, delete a category, and more.
:::note
Product Categories are available as a beta feature and must be enabled first. If you want to use them, ask your technical team to enable them first.
:::
## Create a Category
To create a product category:
1. Go to the Categories Page.
2. Click on the “Add category” button at the top right.
3. In the form that opens:
1. Enter the name of the category. This is the only required field.
2. You can enter a handle if you dont want to use a default handle. A handle is generally used to format the URL shown on your storefront. The default handle will lower-case the category name, and replace spaces with a dash (-). For example, if you name the category “Men Clothing” the handle will be `men-clothing`.
3. You can change the Status to “Inactive” if youre creating the category, but youre still not ready to use it.
4. You can change the Visibility to “Private” if youre creating an internal category that shouldnt be shown to the customer.
4. Once youre done, click the “Save category” button.
---
## Edit a Category
To edit a product category:
1. Go to the Categories 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 category you want to edit.
3. Choose Edit from the dropdown.
4. In the form that opens, you can edit any of the fields of the category.
5. Once youre done, click the “Save and close” button.
---
## Add a Nested Category
To add a new category that should be nested inside another category:
1. Go to the Categories page.
2. Click on the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999131/Medusa%20Docs/UI%20Icons/1hL8NiW_lqmjcq.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999150/Medusa%20Docs/UI%20Icons/8LtkPqW_jyqz5i.png" alt="plus" /> icon at the right of the category youre adding the new category inside.
3. In the form that opens, enter the details as described in the [Create a Category section](#create-a-category).
4. Once youre done, click on the “Save category” button.
---
## Organize Categories
To organize categories and adjust their hierarchy:
1. Go to the Categories page.
2. Click and hold the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999654/Medusa%20Docs/UI%20Icons/zp2QTbO_io0f7i.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999668/Medusa%20Docs/UI%20Icons/ZPpOcvi_h14vyz.png" alt="grip" /> icon next to the category you want to move. Keep holding the icon until step four.
3. Move the category to the new destination. You can make it a parent category to another category, nest it inside another category, or move it to the top hierarchy.
4. Once you move it to the new destination, release the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999654/Medusa%20Docs/UI%20Icons/zp2QTbO_io0f7i.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999668/Medusa%20Docs/UI%20Icons/ZPpOcvi_h14vyz.png" alt="grip" /> icon.
---
## Delete a Category
:::warning
Deleting a category cant be undone, and its data cant be restored.
:::
1. Go to the Categories 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 category.
3. Choose Delete from the dropdown.
@@ -0,0 +1,92 @@
---
sidebar_position: 4
description: 'This user guide explains how to manage collections on the Medusa admin. Learn how to create, edit, and delete collections.'
addHowToData: true
---
import UiIcon from '@site/src/components/UiIcon';
# Manage Collections
In this document, youll learn how to create a new collection, edit an existing collection, delete a collection, and more.
## Create a Collection
To create a collection:
1. Go to the Products page.
2. Click on the Collections header at the top left of the products list.
3. Click on the New collection button.
4. In the form that opens:
1. You're required to enter a name for the collection
2. You can optionally specify the handle of the collection.
3. To add metadata, click on the Add Metadata button.
4. 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 next to it.
5. Once done, click on the “Publish collection” button.
---
## View a Collections Details
To view a collections details:
1. Go to the Products page.
2. Click on the Collections header at the top left of the products list.
3. From the table, choose the collection you want to view.
---
## Edit a Collection
To edit a collection:
1. Go to the Collections 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 top right of the first section.
3. Choose Edit Collection from the dropdown.
4. In the new form that opens, edit any of the collection details.
5. Once done, click on the “Save collection” button.
---
## Manage a Collections Products
### Add Products to a Collection
To add products to a collection:
1. Go to the Collections Details page.
2. In the Products section, click on the Edit Products button.
3. From the list of products, check the box next to the products you want to add to the collection.
4. Once done, click on the Save button.
### Remove a Product from a Collection
:::info
Removing a product from a collection doesn't delete the product from Medusa.
:::
To remove a product from a collection:
1. Go to the Collections Details page.
2. In the Products section, find the product you want to remove from the collection.
3. 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 at the right side of the product.
4. Confirm removing the product by clicking the “Yes, remove" button in the pop-up.
---
## Delete a Collection
:::warning
Deleting a collection cant be undone. You will lose all data related to the collection. Products in the collection will not be lost.
:::
To delete a collection:
1. Go to the Collections page.
2. Find the collection you want to delete, then 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 its right.
3. Choose Delete from the dropdown.
4. Confirm deleting the collection by clicking the “Yes, confirm" button in the pop-up.
@@ -0,0 +1,66 @@
---
sidebar_position: 5
description: 'This user guide explains how to export a list of products on the Medusa admin.'
addHowToData: true
---
import UiIcon from '@site/src/components/UiIcon';
# Export Products
In this document, youll learn how to export all products in your Medusa store.
## Overview
When you export your products, you can obtain a list of your products and their details in a CSV file. This can be useful if you want to migrate from one Medusa backend to another, or if you need the CSV file for other purposes.
---
## Export List of Products
To export products:
1. Go to the Products page.
2. Click on Export Products at the top right.
3. Click Export in the window that opens.
4. Click on the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999016/Medusa%20Docs/UI%20Icons/mWhpxNX_xteuos.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999044/Medusa%20Docs/UI%20Icons/tE8LOXk_puyrib.png" alt="bell" /> icon at the top right of the page.
5. You should see your new export loading.
6. Once the export is ready, click on the Download button.
:::note
If you face any errors or difficulties, please contact your technical support team as this could be an issue in the storage integration used.
:::
---
## Cancel a Product Export
:::info
You can only cancel an unfinished product export.
:::
To cancel a product export:
1. Click on the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999016/Medusa%20Docs/UI%20Icons/mWhpxNX_xteuos.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999044/Medusa%20Docs/UI%20Icons/tE8LOXk_puyrib.png" alt="bell" /> icon at the top right of the page.
2. Find the export you want to cancel.
3. Click on the cancel button.
---
## Delete a Product Export
:::info
You can only delete a finished product export.
:::
To delete a product export:
1. Click on the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999016/Medusa%20Docs/UI%20Icons/mWhpxNX_xteuos.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999044/Medusa%20Docs/UI%20Icons/tE8LOXk_puyrib.png" alt="bell" /> icon at the top right of the page.
2. Find the export you want to delete.
3. Click on the Delete button.
@@ -0,0 +1,78 @@
---
sidebar_position: 6
description: 'This user guide explains how to import a list of products into Medusa using the admin.'
addHowToData: true
---
import UiIcon from '@site/src/components/UiIcon';
# Import Products
In this document, youll learn how to import products into your Medusa store.
## Overview
To import products, you must have the products in a CSV file. You can see a template of the CSV file during the import process.
:::note
For a list of accepted columns, refer to [this guide](../../modules/products/admin/import-products.mdx#csv-file).
:::
When you import products into your Medusa store, youll either create new products or update existing ones.
---
## Import List of Products
To import products:
1. Go to the Products page.
2. Click on Import Products at the top right.
3. In the new window:
1. If youre unsure of what the CSV files format must be like, you can download a template CSV file by clicking the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999458/Medusa%20Docs/UI%20Icons/fhRqHS3_kwmafj.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999472/Medusa%20Docs/UI%20Icons/HdVNMNy_qrk8ez.png" alt="download" /> icon.
2. To upload the CSV file you want to import products from, either:
1. Drag and drop the file into the dashed box;
2. Or click on the dashed box and choose the file you want to import the products from.
3. After you upload the CSV file:
1. You can check the number of products to be created or updated above the uploaded files name.
2. You can remove the file you choose by clicking 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.
4. Once youre done choosing a file to import products from, click on the Import List button.
This starts the import process. Based on the number of products youre importing, it can take some time.
:::note
If you face any errors or difficulties, please contact your technical support team as this could be an issue in the storage integration used.
:::
### Check Import Status
To check the status of the import:
1. Click on the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999016/Medusa%20Docs/UI%20Icons/mWhpxNX_xteuos.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999044/Medusa%20Docs/UI%20Icons/tE8LOXk_puyrib.png" alt="bell" /> icon at the top right of the page.
2. Find the product import, which should be the latest item on the list.
If a loading indicator is showing, then the import process is still in progress.
If the import is done, you should see the text “Import of products is done.”
Once the import is done, you should find the created/updated products on the Products page.
---
## Cancel Import
:::info
You can only cancel an unfinished product import.
:::
To cancel a product import:
1. Click on the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999016/Medusa%20Docs/UI%20Icons/mWhpxNX_xteuos.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999044/Medusa%20Docs/UI%20Icons/tE8LOXk_puyrib.png" alt="bell" /> icon at the top right of the page.
2. Find the import you want to cancel.
3. Click on the cancel button.
@@ -0,0 +1,58 @@
---
sidebar_position: 1
description: 'Medusa admin allows merchants to manage products. Merchants can view products and collections, edit them, and more.'
---
import UiIcon from '@site/src/components/UiIcon';
# Products Overview
In this document, youll get an overview of the product listing page and all the things you can do with it.
## Overview
Products are the goods you sell in your store. They can be physical or digital products. They can also be simple products or products with variants.
You can create products and edit their details. That includes basic info, sales channels, inventory management, prices management, and much more.
Part of the product domain is Categories. Categories allow you to organize products into more than one category. You can also manage the hierarchy of the category. An example of a category could be "Women" with "Shirt" as a nested category.
Another part of the domain is Collections. Collections are used to split products for a marketing or sales purpose. For example, you can create a "Summer Collection" to showcase products for the summer.
---
## View List of Products
You can view the list of available products in your ecommerce store by clicking on Products from the sidebar menu.
In the list, you can see product details such as the name, collection, inventory, and status of the product.
---
## Change Product View
### List View
To view products in a list view, which is the default view, click on the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999530/Medusa%20Docs/UI%20Icons/A4kBy4n_da3gud.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999544/Medusa%20Docs/UI%20Icons/y50COcH_dby5ol.png" alt="list" /> icon at the top right of the product list.
### Grid View
To view products in a grid view, click on the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999559/Medusa%20Docs/UI%20Icons/HXMOOzK_mfmw9o.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999573/Medusa%20Docs/UI%20Icons/fAHh3vz_etj57w.png" alt="grid" /> icon at the top right of the product list.
---
## View List of Collections
You can view the list of collections on the Products page by clicking on the grey Collections headline next to the Products headline.
In the list, you can see collection details such as the title, handle, and the number of products in the collection.
---
## Learn More About Products
- [Manage Products](./manage.mdx)
- [Manage Categories](./categories.mdx)
- [Manage Collections](./collections.mdx)
- [Export Products](./export.mdx)
- [Import Products](./import.mdx)
@@ -0,0 +1,378 @@
---
sidebar_position: 2
description: 'This user guide explains how to manage products on the Medusa admin. Learn how to create a product, edit a product, and more.'
addHowToData: true
---
import UiIcon from '@site/src/components/UiIcon';
import getOsShortcut from '@site/src/utils/get-os-shortcut'
# Manage Products
In this document, youll learn how to create new products, edit different fields and areas in a product, and more.
## Create a Product
To create a new product:
1. Go to the Products page.
2. Click on the New Product button at the top right.
This opens a new form with different sections. The only field required is the Title field in the General Information Section.
### General Information Section
1. Enter the required field Title.
2. If you dont provide a value for the Handle field, it will be generated from the title.
3. If you dont want discounts to be applied to this product, toggle the Discountable field off.
4. Optionally enter the rest of the general information fields.
### Organize Section
:::note
If you don't see a categories field, it's because this feature is currently in beta and must be manually enabled by your technical team.
:::
All fields in this section allow you to better group and filter your products using types, collections, and tags.
1. You can either choose from a list of types or create a new one.
2. You can choose from a list of collections.
3. You can choose one or more categories. If you don't have any categories, you can learn how to create them in the [Manage Categories documentation](./categories.mdx). If you want to choose a nested category, you can click on a parent category which will show the categories nested inside it.
4. Tags are comma-separated. After entering a tags value, add a comma “,” and it will create the tag. You can remove the tag by pressing the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999180/Medusa%20Docs/UI%20Icons/kvGRHQR_s0ptsm.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999200/Medusa%20Docs/UI%20Icons/RJ4SLIu_n30zqr.png" alt="X" /> icon next to it.
### Variants Section
In this section, you can create different options and variants of a product. You must add an option before you can add variants.
1. Add a new option by clicking the “Add an option” button.
1. This shows two new fields: the Title and the Variations fields. Separate the variations using a comma “,”. You can remove a variation by clicking the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999180/Medusa%20Docs/UI%20Icons/kvGRHQR_s0ptsm.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999200/Medusa%20Docs/UI%20Icons/RJ4SLIu_n30zqr.png" alt="X" /> icon next to it.
2. To remove an option, 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 next to it.
2. Add a new variant by clicking the “Add a variant” button. In the new window that opens:
1. Enter the required fields Custom title and choose a value for each option you created.
2. In the Pricing section, you can specify the price for each currency. To specify the price per region:
1. Click on the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999595/Medusa%20Docs/UI%20Icons/A91y4rk_doqj9s.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999615/Medusa%20Docs/UI%20Icons/knwwocb_ll4l6m.png" alt="right arrow" /> icon next to the currency. This expands a list of regions below the currency. These are regions that use this currency.
2. Enter the price for the region you want.
3. In the Stock & Inventory section, you can manage how Medusa handles the products inventory, the quantity in stock, and more.
1. If Manage Inventory is enabled, Medusa will change the available quantity of the variant when orders or returns are made.
2. If Allow Backorders is enabled, customers can purchase this variant even if its out-of-stock.
4. In the Shipping section, you can specify information relevant to shipping such as Height, Weight, Country of origin, and more.
3. You can edit a variant by clicking 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, then choosing Edit from the dropdown.
4. You can delete a variant by clicking 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, then choosing Delete from the dropdown.
### Attributes Section
This section includes optional fields that are used for shipping and customs.
### Thumbnail Section
:::info
You can upload only one thumbnail. Uploading another thumbnail replaces the previous one.
:::
1. To upload a thumbnail either:
1. Click the dashed box and choose an image;
2. Or drag-and-drop an image in the dashed box.
2. To delete a thumbnail:
1. 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.
2. Click Delete from the dropdown.
### Media Section
:::info
You can upload more than one image in the Media section.
:::
1. To upload an image either:
1. Click the dashed box and choose an image;
2. Or drag-and-drop an image in the dashed box.
2. To delete an image:
1. 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.
2. Click Delete from the dropdown.
### Save the Product
To save the product you can either:
1. Click the “Save as draft” button to save the product without publishing it.
2. Click the “Publish product” button to save the product and publish it.
---
## View Product Details
To view a products details:
1. Go to the Products page.
2. Click on the product you want to view.
---
## Edit a Products General Information
To edit a products general information:
1. Go to the products 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" /> at the top right of the first section.
3. Click on “Edit General Information” from the dropdown.
4. Edit any of the information in the window.
5. Once done, click on the Save button.
---
## Change a Products Status
A products status can either be Draft or Published.
To change a products status:
1. Go to the products details page.
2. Click on the status at the top right of the first section. For example, if the current status of the product is Draft, you should see Draft written at the top right of the first section.
3. Click on the status in the dropdown to change the status.
---
## Manage Product Options
:::info
After a product is created, the only way to add values to an option is when you add or edit a variant. Adding a new option automatically creates the value “Default Value”. An options value is deleted if no variant is using it.
:::
To manage a products option:
1. Go to the products 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 top right of the Variants section.
3. Click on Edit Options from the dropdown.
4. In the new window that opens:
1. You can add a new option by clicking the “Add an option” button.
2. You can edit an options name by changing its name in the field.
3. You can delete an option by clicking 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 youre done, click on the "Save and close" button.
---
## Manage Product Variants
### Add a Variant
:::info
Please note the following:
- Multiple variants cant have the same options combination.
- The steps regarding managing the inventory of a product variant requires the Inventory and Stock Location modules to be installed. You can refer to the [Multi-Warehouse user guide](../multiwarehouse/index.md) for more details about that.
:::
To add a variant to a product:
1. Go to the products 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 top right of the Variants section.
3. Click on Add Variant from the dropdown.
4. In the window that opens:
1. Enter the required title field.
2. Choose a value for each option in the product.
3. In the Pricing section, you can specify the price for each currency. To specify the price per region:
1. Click on the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999595/Medusa%20Docs/UI%20Icons/A91y4rk_doqj9s.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999615/Medusa%20Docs/UI%20Icons/knwwocb_ll4l6m.png" alt="right arrow" /> icon next to the currency. This expands a list of regions below the currency. These are regions that use this currency.
2. Enter the price for the region you want.
4. In the Stock & Inventory section, you can manage how Medusa handles the products inventory, the quantity in Stock, and more.
1. If you disable the Manage Inventory field, Medusa will assume the product is always in stock.
2. If you enable the Manage Inventory field:
1. Under the Quantity section, click on the "Manage locations" button.
2. Enable the locations a product is enabled in.
3. Click on the "Save and go back" button.
4. For each location you added, enter the quantity available in stock.
3. If Allow Backorders is enabled, customers can purchase this variant even if its out-of-stock. You can only enable "Allow Backorders" if "Manage Inventory" is enabled.
5. In the Shipping section, you can specify information relevant to shipping such as Height, Weight, Country of origin, and more.
5. Once youre done, click on the “Save and close” button.
### Edit Variants Position
To edit variants position in a product:
1. Go to the products 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 top right of the Variants section.
3. Click on Edit Variants from the dropdown.
4. In the window that opens:
1. Click and hold the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999654/Medusa%20Docs/UI%20Icons/zp2QTbO_io0f7i.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999668/Medusa%20Docs/UI%20Icons/ZPpOcvi_h14vyz.png" alt="grip" /> icon next to the variant, then drag it to the position you want.
2. You can also change the inventory of the variants.
5. Once youre done, click on the “Save and close” button.
### Edit a Variant
To edit a variant:
1. Go to the products details page.
2. Find the variant you want to edit in the Variants section.
3. 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.
4. Click on Edit Variant from the dropdown.
5. In the new window that opens, you can edit all of the variants information.
6. Once youre done, click on the “Save and close” button.
### Duplicate a Variant
To duplicate a variant:
1. Go to the products details page.
2. Find the variant you want to duplicate in the Variants section.
3. 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.
4. Click on Duplicate Variant from the dropdown.
5. This opens a new window with almost all fields filled except for the selected Options.
6. Once youre done, click on the “Save and close” button.
### Delete a Variant
:::warning
Deleting a variant cant be undone.
:::
To delete a variant:
1. Go to the products details page.
2. Find the variant you want to duplicate in the Variants section.
3. 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.
4. Click on Delete Variant from the dropdown.
---
## Edit Product Prices with Bulk Editor
The prices bulk editor allows you to edit the prices of a product's variants using a spreadsheet interface.
To open the prices bulk editor:
1. Go to the product'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 top right of the Variants section.
3. Click on Edit Prices from the dropdown.
This opens the prices bulk editor in a pop-up. Some tips on how to use the bulk editor:
- To view or hide currencies or regions from the editor:
1. Click on the View button.
2. Check or uncheck a currency/region by clicking on it in the dropdown.
- To edit a cell's value, there are two ways:
1. To edit the value without replacing the existing one, double-click the cell, then enter your new value.
2. To edit the value by replacing the existing one, click on the cell and start typing your new value.
- After editing a cell's value, you can persist it by either clicking outside the cell or pressing <kbd>tab</kbd>
- To delete a value, select the cell then press <kbd>backspace</kbd>
- To delete the value of multiple adjacent cells in a column, click on a cell, then drag either up or down to other cells in the same column. Once you've selected all cells you want to delete their values, press <kbd>backspace</kbd>
- To apply a value of a cell to other adjacent cells in a column, click on a cell, then drag the blue dot at the corner of that cell either up or down to other cells you want to apply the value to.
- To undo a change you made in the currently selected cell(s), press <kbd children={getOsShortcut()}></kbd> + <kbd>Z</kbd>
Once you're done making changes, you can save your changes by clicking the "Save and close" button. Then, in the pop-up that opens:
- If you made edits to a value in a currency or region that is now hidden, you'll be shown the option to save all changes or just save the changes made in the currently visible currencies and regions. Choose one of the options then click the "Save changes" button.
- Otherwise, you can directly click the "Save changes" button.
To discard the changes you made:
1. Either press <kbd>esc</kbd> or click the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999180/Medusa%20Docs/UI%20Icons/kvGRHQR_s0ptsm.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999200/Medusa%20Docs/UI%20Icons/RJ4SLIu_n30zqr.png" alt="X" /> icon at the top left.
2. Confirm discarding the changes by clicking the “Yes, close” button in the pop-up.
---
## Edit a Products Attributes
To edit a products attributes:
1. Go to the products 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 top right of the Attributes section.
3. Click on Edit Attributes from the dropdown.
4. In the new window that opens, you can edit any of the attribute information of the product.
5. Once youre done, click on the Save button.
---
## Manage Thumbnails
### Set Thumbnail
:::info
You can have only one thumbnail. If you add another, it replaces the existing one.
:::
To manage the thumbnail of a product:
1. Go to the products details page.
2. In the Thumbnail section, click on either the Edit or Upload buttons depending on whether you already have a thumbnail for the product or not.
3. In the new window, to upload the thumbnail you can either:
1. Click the dashed box and choose an image;
2. Or drag-and-drop an image in the dashed box.
4. Once youre done, click on the “Save and close” button.
### Delete Thumbnail
:::caution
Deleting a thumbnail cant be undone.
:::
To delete a thumbnail:
1. Go to the products details page.
2. 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 at the top right of the Thumbnail section.
3. Click the Confirm button.
---
## Manage Images
:::info
You can upload more than one image for the product.
:::
To manage a products images
1. Go to the products details page.
2. Click on the Edit Media button in the Media section.
3. In the new window that opens:
1. To upload a new image you can either:
1. Click the dashed box and choose an image;
2. Or drag-and-drop an image in the dashed box.
2. To delete an image:
1. 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.
2. Click on Delete from the dropdown.
4. Once youre done, click Save and close.
---
## Duplicate a Product
To duplicate a product:
1. Go to the Products 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 next to the product you want to duplicate.
3. Click on Duplicate from the dropdown.
This creates a product with the same information as the original but as a draft.
---
## Delete a Product
:::warning
Deleting a product cant be undone. Youll lose all the product information.
:::
To delete a product:
1. Go to the Products 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 next to the product you want to delete.
3. Click on Delete from the dropdown.
4. Confirm deleting the product by clicking the “Yes, confirm” button in the pop-up.
@@ -0,0 +1,9 @@
{
"position": 9,
"collapsed": false,
"link": null,
"label": "Regions",
"customProps": {
"sidebar_is_group_headline": true
}
}
@@ -0,0 +1,36 @@
---
sidebar_position: 1
description: 'Medusa admin allows merchants to manage regions. Regions represent different countries within an ecommerce store.'
---
# Regions Overview
In this document, youll get an overview of regions and learn about their importance in your ecommerce store.
## Overview
Regions are essential to your ecommerce store. They allow you to specify available currencies, payment providers, fulfillment providers, tax rates, and more for different regions.
Regions represent different countries that your ecommerce store serves customers in. You can combine more than one country in the same region and give them the same settings, or you can create a different region for each country and add settings specific to each of them.
---
## Currencies in Regions
Each region uses one currency. Having more than one region with each having different currencies allows you to set prices and amounts throughout your ecommerce store for each currency. For example, you can specify prices for a product for each currency you support.
---
## How Customers Use Regions
When a customer browses your storefront, they can choose the region based on their location. Then, different pricing, shipping providers, payment providers, and taxes will be available and applied based on the chosen region.
For example, if you have Stripe enabled as a payment provider in a region created for the United States, but have it disabled in a region created for European countries, only customers in the United States region can use Stripe for payment on checkout.
---
## Learn More About Regions
- [Manage Regions](./manage.mdx)
- [Manage Payment and Fulfillment Providers](./providers.mdx)
- [Manage Shipping Options in a Region](./shipping-options.mdx)
@@ -0,0 +1,72 @@
---
sidebar_position: 2
description: 'This user guide explains how to manage regions on the Medusa admin. Learn how to create and edit regions.'
addHowToData: true
---
import UiIcon from '@site/src/components/UiIcon';
# Manage Regions
In this document, youll learn how to view and manage regions in your Medusa Admin.
## View Regions
To view your regions:
1. Click on Settings in the sidebar.
2. Choose Regions from the list of settings.
This opens the Regions page where you can find a list of regions.
---
## Create a Region
To create a region:
1. Go to Settings → Regions.
2. Click on the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999131/Medusa%20Docs/UI%20Icons/1hL8NiW_lqmjcq.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999150/Medusa%20Docs/UI%20Icons/8LtkPqW_jyqz5i.png" alt="plus" /> icon at the top right of the Regions section.
3. In the form that opens you must enter the Regions details:
- It is required to enter a title, choose a currency, enter a tax rate, and at least choose one country, payment provider, and fulfillment provider.
- You can optionally enter a tax code for the region. Alternatively, you can [edit a regions tax settings](../taxes/manage.md#edit-a-regions-taxes) after creation.
4. Once youre done, click on the "Create region" button.
:::tip
If you cant find the currency you want to use in the Currency field, make sure to [add the Currency to the stores currencies in the settings](../settings/currencies.md#add-a-currency).
:::
After you click save, the region will be created and you can see it in the list on the left.
---
## Edit a Region
To edit a region's basic information:
1. Go to Settings → Regions.
2. Click on the region you want to edit from the Regions section. This shows sections to the right to edit different information and data related to the region.
4. 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 top right of the first section.
5. Click on "Edit Region Details" from the dropdown.
6. This opens a new window where you can edit the region's details.
7. Once done, click on the "Save and close" button.
---
## Delete a Region
:::warning
If you delete a region, you will not be able to restore it or its data. Data related to the region such as tax settings will also be deleted. Prices using the currencies of this region will remain available.
:::
To delete a region:
1. Go to Settings → Regions.
2. Click on the region you want to delete from the Regions section.
3. In the first section on the right, 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.
4. Choose Delete Region from the dropdown list.
5. Confirm deleting the region by entering the name of the region and clicking the “Yes, confirm" button in the pop-up.
@@ -0,0 +1,46 @@
---
sidebar_position: 3
sidebar_label: Manage Providers
description: 'This user guide explains how to manage payment and fulfillment providers in a region on the Medusa admin.'
addHowToData: true
---
import UiIcon from '@site/src/components/UiIcon';
# Manage Payment and Fulfillment Providers in a Region
In this document, youll learn how to manage a regions payment and fulfillment providers in your Medusa Admin.
## Overview
You can choose the payment and fulfillment providers available in each region. This allows you to provide customers in specific regions the providers that are available in their country or region.
When a payment or fulfillment provider is added to a region, it means a customer is able to select that payment or fulfillment provider during checkout to complete their purchase.
---
## Manage Payment Providers
To add or remove a payment provider in a region:
1. Go to Settings → Regions.
2. Select a region to edit.
3. 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 top right of the first section on the right.
4. Click on Edit Region Details from the dropdown.
5. Under the providers section, select the payment providers you want to add to the region.
6. Unselect the payment providers you want to remove from the region.
7. Click the "Save and close" button.
---
## Manage Fulfillment Providers
To add or remove a fulfillment provider in a region:
1. Go to Settings → Regions.
2. Select a region to edit.
3. 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 top right of the first section on the right.
4. Click on Edit Region Details from the dropdown.
5. Under the providers section, select the fulfillment providers you want to add to the region.
6. Unselect the fulfillment providers you want to remove from the region.
7. Click the "Save and close" button.
@@ -0,0 +1,124 @@
---
sidebar_position: 4
sidebar_label: Manage Shipping Options
description: 'This user guide explains how to manage shipping options in a region on the Medusa admin.'
addHowToData: true
---
import UiIcon from '@site/src/components/UiIcon';
# Manage Shipping Options in a Region
In this document, youll learn how to manage a regions shipping options in your Medusa Admin.
## Types of Shipping Options
There are two types of shipping options in a region:
1. Shipping Options that are used when a customer places an order or when an admin creates a draft order.
2. Return Shipping Options that are used when a customer requests a return or exchange for their order, or when an admin registers an exchange, a claim, or a return for an order.
A shipping option cant be used for both cases. In a region, you can create an unlimited amount of shipping options and return shipping options.
---
## Manage Shipping Options in a Region
### Add Shipping Option to a Region
To add a shipping option:
1. Go to Settings → Regions.
2. Select the shipping option's region.
3. Scroll down to the Shipping Options section on the right side.
4. Click on the Add Option button.
5. A new window will open with a form with the following fields:
- **Visible in Store:** Whether or not this option should be available on the website. This is useful if you want to create a shipping option only for use on the Medusa Admin (for example, to create draft orders).
- **Title (Required):** The name of the shipping option. The customer will see this name on the storefront if the “Show on Website” field is checked.
- **Price Type (Required):** The type of price. It can be either Flat Rate or Calculated. If you choose Flat Rate, this will show a new field **Price**. If you choose Calculated, it's assumed the calculation of the shipping option is handled using custom logic implemented in the Fulfillment provider.
- **Price:** This field is only available and required when you set the **Price Type** to Flat Rate. It indicates the price of the shipping option.
- **Shipping Profile (Required):** The shipping profile this option belongs to.
- **Fulfillment Method (Required):** the fulfillment provider that will handle fulfilling this shipping option.
- **Requirements:** You can use this section to specify a condition for when this shipping option should be available during checkout or draft-order creation. The "Min. subtotal" field indicates the minimum cart subtotal required to use this shipping option, and the "Max. subtotal" field indicates the maximum cart subtotal required to use this shipping option. For example, you can fill in the first field “100” to only allow using this shipping option if the carts subtotal is at least $100.
- **Metadata**: This section allows you to add custom data to the shipping option in the form of a key-value pair. This is mostly helpful for technical teams and developers.
6. Once youre done, click the "Save and close" button.
### Edit a Shipping Option
To edit a shipping option:
1. Go to Settings → Regions.
2. Select the shipping option's region.
3. Scroll down to the Shipping Options section on the right side.
4. Find the shipping option you want to edit and click on the three dots icon at its right.
5. Click on Edit in the dropdown.
6. A new window will open with the fields that you can edit. You can edit all of the fields you chose while adding the shipping option except for the Shipping Profile and Fulfillment Method.
7. Once youre done, click the Save and close button.
### Delete a Shipping Option
:::warning
If you delete a shipping option, you cant restore it or its data, customers cant use it during checkout, and admins cant use it for draft orders.
:::
To delete a shipping option:
1. Go to Settings → Regions.
2. Select the shipping option's region.
3. Scroll down to the Shipping Options section on the right side.
4. Find the shipping option you want to edit and 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 its right.
5. Click on Delete in the dropdown.
---
## Manage Return Shipping Options in a Region
### Add Return Shipping Option to a Region
To add a return shipping option:
1. Go to Settings → Regions.
2. Select the shipping option's region.
3. Scroll down to the Return Shipping Options section on the right side.
4. Click on the Add Option button.
5. A new window will open with a form with the following fields:
- **Visible in Store:** Whether or not this option should be available on the website. This is useful if you want to create a return shipping option only for use on the Medusa Admin (for example, to create an order return).
- **Title (Required):** The name of the shipping option. The customer will see this name on the storefront if the “Show on Website” field is checked.
- **Price Type (Required):** The type of price. It can be either Flat Rate or Calculated. If you choose Flat Rate, this will show a new field **Price**. If you choose Calculated, it's assumed the calculation of the shipping option is handled using custom logic implemented in the Fulfillment provider.
- **Price:** This field is only available and required when you set the **Price Type** to Flat Rate. It indicates the price of the shipping option.
- **Shipping Profile (Required):** The shipping profile this option belongs to.
- **Fulfillment Method (Required):** the fulfillment provider that will handle fulfilling this shipping option.
- **Requirements:** You can use this section to specify a condition for when this shipping option should be available when creating a return or exchange. The "Min. subtotal" field indicates the minimum subtotal required to use this shipping option, and the "Max. subtotal" field indicates the maximum subtotal required to use this shipping option. For example, you can fill in the first field “100” to only allow using this shipping option if the carts subtotal is at least $100.
- **Metadata**: This section allows you to add custom data to the shipping option in the form of a key-value pair. This is mostly helpful for technical teams and developers.
6. Once youre done, click the "Save and close" button.
6. Once youre done, click the Save and close button.
### Edit a Return Shipping Option
To edit a return shipping option:
1. Go to Settings → Regions.
2. Select the shipping option's region.
3. Scroll down to the Return Shipping Options section on the right side.
4. Find the shipping option you want to edit and 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 its right.
5. Click on Edit in the dropdown.
6. A new window will open with the fields that you can edit. You can edit all of the fields you chose while adding the shipping option except for the Shipping Profile and Fulfillment Method.
7. Once youre done, click the Save and close button.
### Delete a Return Shipping Option
:::warning
If you delete a return shipping option, you cant restore it or its data, customers cant use it when they request a return or an exchange, and admins cant use it when requesting a return for an order or registering an exchange or claim for an order.
:::
To delete a return shipping option:
1. Go to Settings → Regions.
2. Select the shipping option's region.
3. Scroll down to the Return Shipping Options section on the right side.
4. Find the shipping option you want to edit and 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 its right.
5. Click on Delete in the dropdown.
@@ -0,0 +1,9 @@
{
"position": 11,
"collapsed": false,
"link": null,
"label": "Sales Channels",
"customProps": {
"sidebar_is_group_headline": true
}
}
@@ -0,0 +1,63 @@
---
sidebar_position: 1
description: 'Medusa admin allows merchants to manage their sales channels. Merchants can separate products into multiple sales channels.'
---
# Sales Channels Overview
In this document, youll get an overview of sales channels in Medusa and learn about their importance in your ecommerce store.
## Overview
Sales Channels are multiple channels that you can sell your products through. For example, you can have a sales channel for the web storefront, another for the mobile app, and another for selling across social media platforms.
By default, theres a default sales channel in a Medusa store. You can add multiple sales channels.
---
## How Sales Channels Work
Sales channels are associated with data and settings in your ecommerce store.
For each sales channel, you can choose which products belong to that sales channel. A product can be available in more than one sales channel.
Then, when customers place an order from a sales channel, the order is associated with that sales channel. Youll be able to see the sales channel an order was placed from in the Medusa admin.
---
## Sales Channels Settings Overview
To view the available sales channels and settings, go to Settings → Sales channels.
In the sales channels settings page, You can view available sales channels, add more sales channels, edit sales channels, and manage products available in the sales channel.
---
## View Sales Channels of Orders
### Orders Page
In the Orders page, you can see the sales channel an order belongs to. If the order doesnt belong to any sales channel, you can see “N/A” instead.
### Orders Details Page
In the details page of an order, you can find the sales channel the order belongs to, if there are any.
---
## View Sales Channels of Products
### Products Page
In the Products page, you can see the sales channels a product belongs to under the Availability column if there are any.
### Products Edit Page
In the edit page of a product, you can find the sales channels the product belongs to and edit them under the Sales Channels section.
---
## Learn More About Sales Channels
- [Manage Sales Channels](./manage.mdx)
- [Manage Products in Sales Channels](./products.mdx)
@@ -0,0 +1,90 @@
---
sidebar_position: 2
description: 'This user guide explains how to manage sales channels on the Medusa admin. Learn how to create, edit, and delete sales channels.'
addHowToData: true
---
import UiIcon from '@site/src/components/UiIcon';
# Manage Sales Channels
In this document, youll learn how to view and manage sales channels in your Medusa Admin.
## View Sales Channels
To view sales channels:
1. Click on Settings in the sidebar.
2. Choose Sales Channels from the list of settings.
This opens the Sales Channels page where you can see the list of Sales channels on the left and the products in the selected sales channel on the right.
---
## Search Sales Channels
To search sales channels:
1. Go to Settings → Sales Channels
2. In the Sales Channels section on the left, click on the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999227/Medusa%20Docs/UI%20Icons/k0U0wpO_pizpfd.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999249/Medusa%20Docs/UI%20Icons/IdKjFak_ultvmh.png" alt="magnifier" /> icon next to the title of the section.
3. This shows an input to search sales channels by title and description.
To clear the search, click on the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999180/Medusa%20Docs/UI%20Icons/kvGRHQR_s0ptsm.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999200/Medusa%20Docs/UI%20Icons/RJ4SLIu_n30zqr.png" alt="X" /> icon in the search input.
---
## Create a Sales Channel
To add a new sales channel:
1. Go to Settings → Sales Channels
2. In the Sales Channels section on the left, click on the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999131/Medusa%20Docs/UI%20Icons/1hL8NiW_lqmjcq.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999150/Medusa%20Docs/UI%20Icons/8LtkPqW_jyqz5i.png" alt="plus" /> icon next to the title of the section.
3. The form to create a new sales channel will open. The name of the sales channel is required, but the description is optional.
4. Once youre done, you can either:
- Click Save as draft to save the sales channel as disabled.
- Click Publish channel to save the sales channel as enabled.
---
## Change the Status of a Sales Channel
A sales channel can be enabled or disabled. If a sales channel is disabled, that means its saved as a draft. If its enabled, that means its published.
To enable or disable a sales channel:
1. Go to Settings → Sales Channels
2. In the sales channels list on the left, choose the sales channel you want to enable/disable.
3. At the top right of the right section, you can find the status of the sales channel, with a <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999685/Medusa%20Docs/UI%20Icons/yrTcDO4_tulwph.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999685/Medusa%20Docs/UI%20Icons/yrTcDO4_tulwph.png" alt="green" /> icon if its enabled or a <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999700/Medusa%20Docs/UI%20Icons/0lUln3B_arpgmo.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999700/Medusa%20Docs/UI%20Icons/0lUln3B_arpgmo.png" alt="grey" /> icon if its disabled.
4. Click on the status, and a dropdown will show to toggle the status. For example, if the status of the sales channel is Enabled, the dropdown will show a Disabled status.
5. Choose the status in the dropdown, and the status of the sales channel will change.
---
## Edit Sales Channels Information
To edit a sales channels information:
1. Go to Settings → Sales Channels
2. In the sales channels list on the left, choose the sales channel you want to edit.
3. At the top right of the right 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.
4. Choose from the dropdown list “Edit general info”.
5. This opens a form in a window where you can edit the name and description of the sales channel.
6. Once done, click Save.
---
## Delete a Sales Channel
:::warning
If you delete a sales channel, you wont be able to restore it. Orders and Products associated with the sales channel will not be affected.
:::
To delete a sales channel:
1. Go to Settings → Sales Channels
2. In the sales channels list on the left, choose the sales channel you want to delete.
3. At the top right of the right 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.
4. Choose from the dropdown list “Delete channel”.
5. Confirm deleting the sales channel by entering the name of the sales channel and clicking the “Yes, delete” button in the pop-up.
@@ -0,0 +1,53 @@
---
sidebar_position: 3
sidebar_label: Manage Products
description: 'This user guide explains how to manage products in sales channels on the Medusa admin.'
addHowToData: true
---
import UiIcon from '@site/src/components/UiIcon';
# Manage Products in Sales Channels
In this document, youll learn how to manage products in Sales Channels.
:::note
This guide covers managing products from the Sales Channels page. Its also possible to manage the Sales Channels of products in the Products page.
:::
## Add Products to Sales Channels
To add products to a sales channel:
1. Go to Settings → Sales Channels
2. In the sales channels list on the left, choose the sales channel you want to add products to.
3. At the top right of the right 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.
4. Choose from the dropdown list “Add products”.
5. This opens a window to add products with filters and search functionalities similar to those of a product page. Select the products you want to add to the sales channel.
6. Click Save.
:::info
Products in the list that are grayed out are products that are already added to the sales channel.
:::
---
## Remove Product from Sales Channel
:::info
If you remove a product from a sales channel, it will still be available in your ecommerce store, just not in that sales channel. You can also add the product again to the sales channel.
:::
To remove a product from a sales channel:
1. Go to Settings → Sales Channels
2. In the sales channels list on the left, choose the sales channel you want to remove the product from.
3. Find the product you want to remove from the sales channel.
4. Click 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 side of the products row.
5. Choose from the dropdown list “Remove from the channel”.
@@ -0,0 +1,12 @@
{
"position": 13,
"collapsed": false,
"link": null,
"label": "Settings",
"customProps": {
"sidebar_is_group_headline": true,
"customProps": {
"sidebar_is_group_headline": true
}
}
}
@@ -0,0 +1,61 @@
---
sidebar_position: 2
description: 'This user guide explains how to manage currencies on the Medusa admin. Learn how to add currencies and set default currency.'
addHowToData: true
---
# Manage Currencies
In this document, youll learn how to set the default currency in your store and how to support more currencies.
## Overview
Medusa supports using more than one currency in your store. When you add currencies, you can set prices for products for each of those currencies.
To make a currency available for your customers, you have to use the currency in a region. Then, your customers will be able to choose the region with the currency that fits them.
:::tip
Before you can use a currency in a region, make sure to [add it to your store](#add-a-currency).
:::
---
## Add a Currency
To make a currency available in your store:
1. Go to Settings → Currencies.
2. Click on the “Edit currencies” button in the Store Currencies section.
3. In the new window that opens:
1. Click on the Add Currencies button.
2. Select all the currencies you want to add.
4. Click on the “Save and close” button.
---
## Set Default Currency
:::tip
Before you can make a currency the default currency, make sure to [add it to your store](#add-a-currency).
:::
To set the default currency of your store:
1. Go to Settings → Currencies.
2. In the "Default store currency” section, choose from the dropdown the currency you want to make the default.
---
## Remove Currencies
To remove a currency from your store:
1. Go to Settings → Currencies.
2. Click on the “Edit currencies” button in the Store Currencies section.
3. In the new window that opens:
1. Select all the currencies you want to remove.
2. Click on the Remove button.
@@ -0,0 +1,118 @@
---
sidebar_position: 4
description: 'This user guide explains how to manage publishable API keys on the Medusa admin. Learn how to create, edit, copy, and revoke publishable API keys.'
addHowToData: true
---
import UiIcon from '@site/src/components/UiIcon';
# Manage Publishable API Keys
In this document, youll learn how to manage publishable API keys in Medusa Admin.
## Overview
Publishable API keys are used by developers or technical teams. They are used to define the resources that an API key is associated with and can access.
Then, this publishable API key is used in storefront development to retrieve or process data based on the scope of the publishable API key.
Currently, publishable API keys can only be used with sales channels.
---
## Create Publishable API Key
To create a publishable API key:
1. Go to Settings → API key management.
2. Click on the “Create API key” button at the top right.
3. In the new form that opens:
1. Enter a name for the API key in the Title field.
2. You can optionally add sales channels. To do that:
1. Click on the “Add sales channels” button.
2. Click on the checkbox next to the sales channels you want to add.
3. Click on the “Save and close” button.
4. Once youre done, click on the “Publish API key” button.
---
## Copy Token of API Key
To copy the token of an API key:
1. Go to Settings → API key management.
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 next to the API key you want to copy.
3. Click on “Copy token” from the dropdown.
---
## Edit API Key Details
To edit the details of an API key:
1. Go to Settings → API key management.
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 next to the API key you want to edit.
3. Click on “Edit API key details” from the dropdown.
4. Change the title of the API Key in the side window that opens.
5. Click on the “Save and close” button.
---
## Manage Sales Channels of a Publishable API Key
:::info
Making any changes in the sales channels here does not affect the sales channel itself or any of its data. This only impacts the relation between sales channels and publishable API keys.
:::
You can add or delete sales channels from a publishable API key. Adding a sales channel makes it accessible using the publishable API key. Removing a sales channel from a publishable API key removes the API keys access to the sales channel.
To manage sales channels of a publishable API key:
1. Go to Settings → API key management.
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 next to the API key you want to manage its sales channels.
3. Click on “Edit sales channels” from the dropdown.
4. In the side window that opens:
1. To add a sales channel to the publishable API key:
1. Click on the “Add channels” button.
2. Click on the checkbox next to the sales channels you want to add.
3. Once done, click on the “Add and go back” button to add the sales channels and continue editing, or click on the “Add and close” to add the sales channels and close the side menu.
2. To delete a sales channel from the publishable API key:
1. Click on the checkbox next to the sales channels you want to delete.
2. Click on the “Remove” button.
5. Once youre done editing, click on the Close button.
---
## Revoke Publishable API Key
:::warning
Revoking a publishable API key does not remove it, but the API key cant be used in development anymore. It can't be undone.
:::
To revoke a publishable API key:
1. Go to Settings → API key management.
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 next to the API key you want to revoke.
3. Click on “Revoke token” from the dropdown.
4. Confirm revoking the publishable API key by clicking the “Yes, revoke” button in the pop-up.
---
## Delete Publishable API Key
:::warning
Deleting a publishable API key completely removes it and the API key cant be used in development anymore. It can't be undone.
:::
To delete a publishable API key:
1. Go to Settings → API key management.
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 next to the API key you want to delete.
3. Click on “Delete API key” from the dropdown.
4. Confirm deleting the publishable API key by clicking the “Yes, delete” button in the pop-up.
@@ -0,0 +1,66 @@
---
sidebar_position: 3
description: 'This user guide explains how to manage return reasons on the Medusa admin. Learn how to add, edit, and remove return reasons.'
addHowToData: true
---
import UiIcon from '@site/src/components/UiIcon';
# Manage Return Reasons
In this document, youll learn how to add, edit, and remove return reasons.
## Overview
Return reasons are used when issuing returns or exchanges of orders. When you want to request an exchange or return of an item in an order, you must specify the reason for that return.
Return reasons are custom and are created by merchants. For example, you can create the return reason “damaged”, then use it when you want to request a return for an item in an order because it has been damaged.
:::note
Creating at least one return reason is required before you can handle order returns and exchanges.
:::
---
## Add Return Reason
To add a return reason:
1. Go to Settings → Return Reasons.
2. Click on the “Add reason” button in the Return Reasons section.
3. In the new window:
1. You are required to enter a value and a label for the return reason. The value is for internal use and must not include spaces. The label is what the customer will see in their order returns or exchanges.
2. You can optionally enter a description for the return reason.
4. Once done, click on the Create button.
---
## Duplicate a Return Reason
To duplicate a return reason:
1. Go to Settings → Return Reasons.
2. Choose the return reason you want to duplicate from the left section.
3. 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 top right of the Details section.
4. Click on “Duplicate reason” from the dropdown.
5. In the new window that opens, make changes as necessary for the new return reason.
6. Once done, click on the Create button.
---
## Edit a Return Reason
:::info
A return reasons value cant be edited.
:::
To edit a return reason:
1. Go to Settings → Return Reasons.
2. Choose the return reason you want to edit from the left section.
3. In the Details section, make changes to the label or description of the return reason.
4. Once done, click on the Save button.
@@ -0,0 +1,21 @@
---
sidebar_position: 1
description: 'This user guide explains how to manage the store details on the Medusa admin.'
---
# Manage Store Details
In this document, youll learn how to edit the stores details.
## Edit Store Details
To edit the stores details:
1. Go to Settings → Store Details
2. In the Store Details form:
1. You can change the stores name.
2. You can set the template link for swaps, draft orders, and invites. When making a change to the link template, make sure to use the following placeholders within the link:
1. **Swaps**: Use the `{swap_id}` placeholder to indicate where the ID of the swap should be in the link.
2. **Draft Order**: Use the `{payment_id}` placeholder to indicate where the ID of the payment should be in the link.
3. **Invites:** Use the `{invite_token}` placeholder to indicate where the invite token should be in the link.
3. Once done, click on the Save button.
@@ -0,0 +1,9 @@
{
"position": 10,
"collapsed": false,
"link": null,
"label": "Taxes",
"customProps": {
"sidebar_is_group_headline": true
}
}
@@ -0,0 +1,39 @@
---
sidebar_position: 1
description: 'Medusa admin allows merchants to manage their taxes. Merchants can specify and configure taxes per region.'
---
# Taxes Overview
In this document, youll get an overview of taxes in Medusa and learn about their importance in your ecommerce store.
## Overview
Taxes in Medusas are directly associated with [Regions](../regions/index.md). As regions and countries often have different tax rates and rules, Medusa supports specifying the tax rate for each region.
Taxes are calculated for products and shipping methods on checkout. Medusa provides a default tax provider to calculate the taxes, and merchants and developers can also integrate custom tax providers for advanced calculation of taxes.
---
## How are Taxes Created
Once a region is created, a default tax rate is created for that region. You can specify the rate and code of the tax rate during the creation of the region.
This also means that tax rates are deleted when a region is deleted.
---
## Customizing Tax Rates
A regions default tax rate is applied for all products and shipping options. You can also have more customized tax rates.
Adding tax rates alongside the default one allows you to override the prices of specific products, product types, or shipping options. This further increase the customization capabilities of your ecommerce store.
---
## Learn More About Taxes
- [Manage Taxes](./manage.md)
- [Manage Tax Rates](./tax-rates.mdx)
- [Manage Tax Overrides](./tax-overrides.mdx)
- [Tax Inclusive Pricing Overview](./tax-inclusive.mdx)
@@ -0,0 +1,80 @@
---
sidebar_position: 2
description: 'This user guide explains how to manage taxes on the Medusa admin. Learn how to edit their configurations.'
addHowToData: true
---
# Manage Taxes
In this document, youll learn how to view and manage taxes in your Medusa Admin.
## View Taxes
To view taxes:
1. Click on Settings in the sidebar.
2. Choose Taxes from the list of settings.
This opens the Taxes page where you can find a list of regions. This is because every time you create a region, a default tax rate is associated with that region.
---
## Edit a Regions Taxes
To edit a regions taxes:
1. Go to Settings → Taxes.
2. Click on the region you want to edit the taxes for in the Regions section.
This opens a Details form to the right where you can edit the taxes calculation settings and [manage the tax rates](./tax-rates.mdx).
---
## Change Tax Calculation Settings
:::tip
The save button only appears when you make changes to the settings.
:::
### Change Tax Provider
The tax provider that you choose defines how taxes are calculated for products and shipping options on checkout. Medusa provides a default tax provider with the name “System Tax Provider”.
If you have integrated a custom tax provider and want to use it to calculate taxes in a region:
1. Go to Settings → Taxes.
2. Select a region whose taxes you want to edit.
3. Change the selected tax provider in the Tax Provider field.
4. Click Save at the bottom right.
### Disable Automatic Taxes Calculation
By default, taxes are calculated automatically by Medusa. Theyre calculated in different places during checkout, such as when a shipping method is chosen or when a new product is added to the cart.
If you use a third-party tax provider and you want to avoid sending too many requests to the tax provider, you can disable this behavior.
:::caution
If you switch off automatic taxes calculation, the taxes must be calculated manually on checkout. If youre unsure how that works, please contact your technical team.
:::
To disable automatic taxes calculation:
1. Go to Settings → Taxes.
2. Select a region whose tax you want to edit.
3. Check off the “Calculate taxes automatically” input.
4. Click Save at the bottom right.
### Disable Taxes for Gift Cards
To disable applying taxes for Gift Cards:
1. Go to Settings → Taxes.
2. Select a region whose tax you want to edit.
3. Check off the “Apply tax to gift cards” input.
4. Click Save at the bottom right.
Enabling taxes for Gift Cards follows the same process, except you check the input.
@@ -0,0 +1,131 @@
---
sidebar_position: 5
description: 'This user guide explains how to manage tax inclusive pricing on the Medusa admin.'
addHowToData: true
---
import UiIcon from '@site/src/components/UiIcon';
# Tax Inclusive Pricing Overview
In this document, youll learn how to change tax-inclusive settings, and how prices are applied based on whether tax-inclusive pricing is enabled or not.
:::note
Tax-inclusive pricing is currently in beta mode and need to be manually enabled in your store using [feature flags](../../development/feature-flags/toggle.md). If youre unsure how that works, please contact your technical team.
:::
## Overview
If you sell in multiple countries or regions that share the same currency, you might run into an issue when specifying prices without taxes, as countries that have the same currency might have different tax rates.
In that case, if you want to show the same price for a currency regardless of what region the customer is browsing from, youd have to manually run calculations to specify the correct price for all regions.
Tax-inclusive pricing saves you the manual work. When tax-inclusive pricing is enabled, you can just enter the price you want the customer to see on the storefront. Medusa then takes care of calculating the tax amount applied to the item based on the tax rate.
Tax-inclusive pricing can be managed for the following domains:
- Regions
- Currencies
- Price Lists
- Shipping Options
The settings for these domains can affect other domains associated with them.
:::info
Tax-Inclusive pricing is disabled by default for all these domains.
:::
---
## Tax-Inclusive Pricing for Regions
When tax-inclusive pricing is enabled for a region, it is subsequently enabled for product prices, the tax calculation on the line items in a cart, and the carts subtotal calculations.
### Change Tax-Inclusive Pricing for Existing Regions
To change the tax-inclusive pricing setting for an existing region:
1. Go to Settings → Regions.
2. Select a region to edit.
3. In the first section on the right, 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.
4. Click on Edit Region Details from the dropdown.
5. In the window that opens, find the Tax Inclusive Prices field and enable or disable it.
6. Click on the “Save and close” button.
### Set Tax-Inclusive Pricing for New Regions
To set the tax-inclusive pricing setting for a new region:
1. Go to Settings → Regions.
2. Click on the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999131/Medusa%20Docs/UI%20Icons/1hL8NiW_lqmjcq.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999150/Medusa%20Docs/UI%20Icons/8LtkPqW_jyqz5i.png" alt="plus" /> icon at the top right of the Regions section.
3. In the form that opens and among other Region details, find the Tax Inclusive Prices field and enable or disable it.
---
## Tax-Inclusive Pricing for Currencies
When tax-inclusive pricing is enabled for a currency, it is subsequently enabled for:
- Prices of product variants in this currency.
- Tax calculation on the line items or products in a cart using this currency.
- Prices in this currency of product variants in a price list.
### Change Tax-Inclusive Pricing for Currencies
To change the tax-inclusive pricing setting for a currency:
1. Go to Settings → Currencies.
2. Under Store Currencies, find the currency youre making the change to.
3. On the right of the currency, enable or disable tax-inclusive pricing.
---
## Tax-Inclusive Pricing for Price Lists
When tax-inclusive pricing is enabled for a price list, it is subsequently enabled for all product variants in that price list.
:::info
If tax-inclusive pricing is not enabled for a price list, but a price for a product variant in the price list uses a currency that has tax-inclusive pricing enabled, then tax-inclusive pricing is subsequently enabled on that price.
:::
### Change Tax-Inclusive Pricing for Existing Price Lists
To change the tax-inclusive pricing setting for an existing price list:
1. Go to Pricing
2. Click on the price list you want to make the change to.
3. 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 top right of the first section.
4. Choose “Edit price list details” from the dropdown.
5. In the new form that opens, expand the General collapsible and find the “Tax inclusive prices” field and enable or disable it.
6. Click on the “Save and Close” button.
### Set Tax-Inclusive Pricing for New Price Lists
To set the tax-inclusive pricing setting for a new price list:
1. Go to Pricing.
2. Click on the “Add price list” button at the top right.
3. In the new form that opens, expand the General collapsible.
4. Find the “Tax inclusive prices” field and enable or disable it.
---
## Tax-Inclusive Pricing for Shipping Options
When tax-inclusivity is enabled for a shipping option, it is subsequently enabled for the shipping method a customer uses on checkout and for the carts shipping calculations.
Tax-inclusive pricing is enabled or disabled on creation based on whether the Region it is in has the tax-inclusive pricing enabled or not.
---
## Tax-Inclusive Pricing for Products
Tax-inclusivity for products pricing is affected by the tax-inclusive options of currencies, regions, or price lists.
When specifying the price of a product for a currency or a region, the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1668071655/Medusa%20Docs/UI%20Icons/taxes_hoogia.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1668071655/Medusa%20Docs/UI%20Icons/taxes-dark_mwu0us.png" alt="tax-inclusive" /> icon will be greyed out if its disabled for that currency/region. If its enabled, the icon will be colored.
@@ -0,0 +1,81 @@
---
sidebar_position: 4
description: 'This user guide explains how to manage tax overrides on the Medusa admin. Learn how to add, edit, and delete overrides.'
addHowToData: true
---
import UiIcon from '@site/src/components/UiIcon';
# Manage Tax Overrides
In this document, youll learn how to manage tax overrides in your Medusa Admin.
## Overview
When you create or edit a [tax rate](./tax-rates.mdx), you can add, edit, and delete overrides. Overrides are used to customize the tax rate applied for some products, product types, or shipping options.
### Override Types
There are three override types:
1. **Products**: Used to override the tax rate applied on specific products during checkout.
2. **Product Types:** Used to override the tax rate applied on a product type. This subsequently overrides the tax rate of any product having this type during checkout.
3. **Shipping Options:** Used to override the tax rate applied on selected shipping methods during checkout.
---
## Add Override
To add an override while [adding or editing a tax rate](./tax-rates.mdx#create-tax-rate):
1. Go to Settings → Taxes
2. Select the region that the tax rate you want to edit belongs to.
3. Either [add a tax rate](./tax-rates.mdx#create-tax-rate) or [edit an existing one](./tax-rates.mdx#edit-tax-rate). This will open the tax rate form in a pop-up.
3. Under the Overrides section, click Add Overrides
4. Choose the type of the override, then choose the specific entries in that type that you want to apply the tax rate to. For example, if you chose the Products type, choose at least one product to apply the override to.
5. Once done, click on Add.
6. In the tax rate form, click on Save.
:::info
If you already have an override for one of the types, and you choose to add a new override for that same type, the new override replaces the old one. If you want to add new entries to the same type (for example, add more products to the Products override), you should [edit the existing override](#edit-override) instead.
:::
---
## Edit Override
You can edit an override to select more entries for or remove entries from an override type.
To edit an override:
1. Go to Settings → Taxes
2. Select the region that the tax rate you want to edit belongs to.
3. From the list of tax rates in the Details section, find the tax rate that the override you want to edit belongs to and click 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.
4. Under the overrides section, find the override type you want to edit. For example, if you want to add a product to the overrides, find the override with the title “Product Rules”.
5. 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 override type.
6. Choose Edit from the dropdown.
7. You can then change the selected entries for the override type.
8. Once done, click Add.
9. In the edit form of the tax rate, click Save.
---
## Delete Override
:::caution
If you delete an override you wont be able to restore it and it wont be applied during checkout. If you want to, instead, remove some entries from an override type, you should [edit the override](#edit-override) instead.
:::
To delete an override:
1. Go to Settings → Taxes
2. Select the region that the tax rate you want to edit belongs to.
3. From the list of tax rates in the Details section, find the tax rate that the override you want to delete belongs to and click 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.
4. Under the overrides section, find the override type you want to delete.
5. 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 override type.
6. Choose “Delete rule” from the dropdown.
7. Click Save.
@@ -0,0 +1,65 @@
---
sidebar_position: 3
description: 'This user guide explains how to manage tax rates on the Medusa admin. Learn how to create, edit, and delete tax rates.'
addHowToData: true
---
import UiIcon from '@site/src/components/UiIcon';
# Manage Tax Rates
In this document, youll learn how to manage tax rates in your Medusa Admin.
## Overview
Regions have at least one tax rate, which is the default tax rate. You can, however, add more tax rates for further customization. You can also edit or delete tax rates.
---
## Create Tax Rates
To add a tax rate:
1. Go to Settings → Taxes
2. Select a region that you want to add a new tax rate to.
3. Click on New Tax Rate at the top right of the Details section.
4. This opens the tax rate form in a new window. You must enter a name, rate, and tax code of the new tax rate.
5. You can optionally [add overrides to the tax rate](./tax-overrides.mdx).
6. Once done, click Save.
---
## Edit Tax Rate
To edit a tax rate:
1. Go to Settings → Taxes
2. Select the region that the tax rate you want to edit belongs to.
3. From the list of tax rates in the Details section, find the tax rate you want to edit and click 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.
4. Choose Edit from the dropdown.
5. In the form that opens in the new window, you can edit the basic details of the tax rate such as the name or rate. If youre editing a tax rate thats not the default, you can [manage overrides of this tax rate](./tax-overrides.mdx).
6. Once done, click Save.
---
## Delete Tax Rate
:::warning
If you delete a tax rate, you wont be able to restore it or use it during checkout.
:::
To delete a tax rate:
1. Go to Settings → Taxes
2. Select the region that the tax rate you want to delete belongs to.
3. From the list of tax rates in the Details section, find the tax rate you want to delete and click 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.
4. Choose Delete Tax Rate from the dropdown.
5. Confirm deleting the tax rate by clicking the “Yes, confirm” button in the pop-up.
:::info
Default tax rates cant be deleted. If you dont want to apply any taxes in a region, you can instead set the default tax rate to zero.
:::
@@ -0,0 +1,9 @@
{
"position": 12,
"collapsed": false,
"link": null,
"label": "Users",
"customProps": {
"sidebar_is_group_headline": true
}
}
@@ -0,0 +1,21 @@
---
sidebar_position: 1
description: 'Medusa admin can be accessed more than one user. Merchants can have users added into their team to use the Medusa admin.'
---
# Users Overview
In this document, youll get an overview of features related to users and teams.
## Overview
Only users who are part of the stores team can access the Medusa admin. You can have more than one user in a team. Each user must have an email and password to log in.
As an admin, you can manage the users roles and information. You can also invite or remove users.
---
## Learn More About Users
- [Manage Profile](./profile.md)
- [Manage Team](./team.mdx)
@@ -0,0 +1,64 @@
---
sidebar_position: 2
description: 'This user guide explains how to manage user profile on the Medusa admin. Learn how to edit a user profile and reset user password.'
addHowToData: true
---
# Manage Profile
In this document, youll learn how to manage your account including resetting your password and editing your account details.
## Reset Password
To reset your password:
1. On the login screen, click on the “Forget your password?” link.
2. Enter the email of your account.
3. Click on the “Send reset instructions” button.
4. Youll find the instructions to reset your password in the email you receive.
:::note
If you dont receive an email, please get in touch with your technical team to ensure an email service is set up correctly.
:::
---
## Edit Profile
To edit your profile details:
1. Go to Settings → Personal Information.
2. Click on the “Edit information” button.
3. In the form that opens, you can edit your personal information.
4. Once done, click on the “Submit and close” button.
---
## Change Admin Language
The Medusa admin supports multiple languages, and you can change the default language from your profile settings.
To change the language:
1. Go to Settings → Personal Information.
2. For the Language field, select the language you want from the dropdown.
3. The language will be saved and changed.
:::tip
Can't find your language? Learn how you can contribute by translating the admin to other languages [here](../../contribution/admin-translations.md).
:::
---
## Edit Analytics Preferences
To edit your analytics collection preferences:
1. Go to Settings → Personal Information.
2. Click on the “Edit preferences” button.
3. In the form that opens, you can edit any of the options.
4. Once done, click on the “Submit and close” button.
@@ -0,0 +1,105 @@
---
sidebar_position: 3
description: 'This user guide explains how to manage the team on the Medusa admin. Learn how to invite users to your team and edit their details.'
addHowToData: true
---
import UiIcon from '@site/src/components/UiIcon';
# Manage Team
In this document, youll learn how to invite new users, edit other users information, and remove users from your team.
## View your Team
You can view your team by going to Settings → The Team.
---
## Manage Invites
To add a new user to your team, you must invite them. Invites are sent by email, but you can also copy the invite link and send it personally to the user.
:::note
By default, your store doesn't handle sending invites to the user through a notification, such as an email. Your developer team must setup and configure a Notification service that handles this functionality.
:::
### Invite a User
To send an invite to a user:
1. Go to your team page.
2. Click on the Invite Users button.
3. Enter the users email and choose their role.
4. Once done, click on the Invite button.
:::tip
A user's role doesn't actually change the user's privileges. All users have the same admin privileges.
:::
### Resend an Invite
If you want the user to receive a new email with the invite link, you can resend an invite to them.
To resend an invite to a user:
1. Go to your team page.
2. Find the user that you want to resend an invite to, then 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 its right.
3. Click on Resend Invitation from the dropdown.
### Get Invite Link
In addition to sending the user an invite, you can copy the invite link and send it manually to the user.
To copy the invite link:
1. Go to your team page.
2. Find the user invite, then 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 its right.
3. Click on “Copy invite link” from the dropdown.
### Remove Invite
:::info
Removing an invite would prevent the invited user from joining the team, even if they have the invitation link.
:::
To remove an invite:
1. Go to your team page.
2. Find the user invite, then 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 its right.
3. Click on “Remove invitation” from the dropdown.
4. Confirm removing the invitation by clicking the “Yes, remove” button in the pop-up.
---
## Edit a Users Details
To edit a users details in your team:
1. Go to your team page.
2. Find the user and 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 its right.
3. In the new form, edit any of the users information.
4. Once done, click on the Save button.
---
## Remove a User
:::warning
Removing a user from a team cant be done. The users details will be lost.
:::
To remove a user from your team:
1. Go to your team page.
2. Find the user and 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 its right.
3. Click on Remove User from the dropdown.
4. Confirm removing the user by clicking the “Yes, remove” button in the pop-up.