docs: add documentation for v1.8 (#3669)
This commit is contained in:
@@ -1,5 +1,5 @@
|
||||
{
|
||||
"position": 5,
|
||||
"position": 4,
|
||||
"collapsed": false,
|
||||
"link": null,
|
||||
"label": "Customers",
|
||||
|
||||
@@ -0,0 +1,9 @@
|
||||
{
|
||||
"position": 5,
|
||||
"collapsed": false,
|
||||
"link": null,
|
||||
"label": "Multi-Warehouse",
|
||||
"customProps": {
|
||||
"sidebar_is_group_headline": true
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,32 @@
|
||||
---
|
||||
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, you’ll 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 you’re 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)
|
||||
@@ -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, you’ll learn how to manage inventory in the Medusa Admin.
|
||||
|
||||
## Check Inventory
|
||||
|
||||
To check your store’s inventory, go to the Inventory page. Here, you’ll 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 variant’s 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, you’ll 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 you’re 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 location’s details.
|
||||
6. Once you’re 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 you’re done, click the Close button.
|
||||
|
||||
---
|
||||
|
||||
## Delete a Location
|
||||
|
||||
:::warning
|
||||
|
||||
Deleting a location can’t be undone, and its data can’t 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.
|
||||
@@ -26,6 +26,12 @@ If you create a claim of type Refund, a refund is issued to the customer right a
|
||||
|
||||
:::
|
||||
|
||||
:::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.
|
||||
@@ -38,6 +44,7 @@ If you create a claim of type Refund, a refund is issued to the customer right a
|
||||
- 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.
|
||||
|
||||
@@ -21,7 +21,8 @@ To find customers’ requested order exchanges:
|
||||
|
||||
:::info
|
||||
|
||||
An exchange can only be created if the order’s payment is captured and the items have been fulfilled.
|
||||
- An exchange can only be created if the order’s 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).
|
||||
|
||||
:::
|
||||
|
||||
@@ -39,12 +40,13 @@ To create an order exchange:
|
||||
2. Choose a Shipping Method to return the customer’s 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. In the “Items to send” section, click on the Add Product button. Then:
|
||||
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 you’re done, click the Add button.
|
||||
3. You can remove products you’ve 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.
|
||||
4. If you don’t want the customer to receive an email that an exchange has been registered, uncheck the “Send notifications” checkbox.
|
||||
5. If you don’t want the customer to receive an email that an exchange has been registered, uncheck the “Send notifications” checkbox.
|
||||
5. Once you’re done, click the Complete button.
|
||||
|
||||
## Mark an Exchange’s Return as Received
|
||||
|
||||
@@ -25,7 +25,7 @@ If some items of the order are fulfilled, the order’s fulfillment status will
|
||||
|
||||
:::info
|
||||
|
||||
You can only create a fulfillment in an order while there are items in the order that haven’t been shipped.
|
||||
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).
|
||||
|
||||
:::
|
||||
|
||||
@@ -35,10 +35,11 @@ To create a fulfillment for an order:
|
||||
2. Scroll down to the Fulfillment section.
|
||||
3. Click on the Create Fulfillment button.
|
||||
4. In the window that opens:
|
||||
- Choose the items you want to create the fulfillment for. These are the items you’ll ship together. You can also choose a specific quantity of an item to ship 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 under the Quantity column.
|
||||
- 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 don’t want the customer to receive an email that a fulfillment has been created, uncheck the “Send notifications” checkbox.
|
||||
5. Once done, click on the Complete button.
|
||||
5. Once done, click on the "Create fulfillment" button.
|
||||
|
||||
You can check the fulfillment details in the Fulfillment and Timeline sections.
|
||||
|
||||
|
||||
@@ -50,6 +50,56 @@ This section includes the customer’s 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 orderd 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:
|
||||
|
||||
@@ -35,6 +35,12 @@ To find return requests of an order:
|
||||
|
||||
## 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.
|
||||
@@ -44,6 +50,7 @@ To request a return for an order:
|
||||
- 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.
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
{
|
||||
"position": 4,
|
||||
"position": 3,
|
||||
"collapsed": false,
|
||||
"link": null,
|
||||
"label": "Products",
|
||||
|
||||
@@ -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, you’ll 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 don’t 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 you’re creating the category, but you’re still not ready to use it.
|
||||
4. You can change the Visibility to “Private” if you’re creating an internal category that shouldn’t be shown to the customer.
|
||||
4. Once you’re 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 you’re 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 you’re 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 you’re 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 can’t be undone, and its data can’t 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.
|
||||
@@ -1,5 +1,5 @@
|
||||
---
|
||||
sidebar_position: 3
|
||||
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
|
||||
---
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
---
|
||||
sidebar_position: 4
|
||||
sidebar_position: 5
|
||||
description: 'This user guide explains how to export a list of products on the Medusa admin.'
|
||||
addHowToData: true
|
||||
---
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
---
|
||||
sidebar_position: 5
|
||||
sidebar_position: 6
|
||||
description: 'This user guide explains how to import a list of products into Medusa using the admin.'
|
||||
addHowToData: true
|
||||
---
|
||||
|
||||
@@ -15,7 +15,9 @@ Products are the goods you sell in your store. They can be physical or digital p
|
||||
|
||||
You can create products and edit their details. That includes basic info, sales channels, inventory management, prices management, and much more.
|
||||
|
||||
Part of the products domain is Collections. Collections are used to split products based on their type or function. For example, if you sell furniture and clothing, you can have two collections: Furniture and Clothing.
|
||||
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.
|
||||
|
||||
---
|
||||
|
||||
@@ -50,6 +52,7 @@ In the list, you can see collection details such as the title, handle, and the n
|
||||
## Learn More About Products
|
||||
|
||||
- [Manage Products](./manage.mdx)
|
||||
- [Manage Categories](./categories.mdx)
|
||||
- [Manage Collections](./collections.mdx)
|
||||
- [Export Products](./export.mdx)
|
||||
- [Import Products](./import.mdx)
|
||||
@@ -28,11 +28,18 @@ This opens a new form with different sections. The only field required is the Ti
|
||||
|
||||
### 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. Tags are comma-separated. After entering a tag’s 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.
|
||||
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 tag’s 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
|
||||
|
||||
@@ -94,6 +101,8 @@ 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 product’s details:
|
||||
@@ -101,6 +110,8 @@ To view a product’s details:
|
||||
1. Go to the Products page.
|
||||
2. Click on the product you want to view.
|
||||
|
||||
---
|
||||
|
||||
## Edit a Product’s General Information
|
||||
|
||||
To edit a product’s general information:
|
||||
@@ -111,6 +122,8 @@ To edit a product’s general information:
|
||||
4. Edit any of the information in the window.
|
||||
5. Once done, click on the Save button.
|
||||
|
||||
---
|
||||
|
||||
## Change a Product’s Status
|
||||
|
||||
A product’s status can either be Draft or Published.
|
||||
@@ -121,6 +134,8 @@ To change a product’s status:
|
||||
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
|
||||
@@ -140,13 +155,18 @@ To manage a product’s option:
|
||||
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 you’re done, click on the "Save and close" button.
|
||||
|
||||
---
|
||||
|
||||
## Manage Product Variants
|
||||
|
||||
### Add a Variant
|
||||
|
||||
:::info
|
||||
|
||||
Multiple variants can’t have the same options combination.
|
||||
Please note the following:
|
||||
|
||||
- Multiple variants can’t 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.
|
||||
|
||||
:::
|
||||
|
||||
@@ -162,8 +182,13 @@ To add a variant to a product:
|
||||
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 product’s 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 it’s out-of-stock.
|
||||
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 it’s 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 you’re done, click on the “Save and close” button.
|
||||
|
||||
@@ -216,6 +241,8 @@ To delete a variant:
|
||||
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 a Product’s Attributes
|
||||
|
||||
To edit a product’s attributes:
|
||||
@@ -226,6 +253,8 @@ To edit a product’s attributes:
|
||||
4. In the new window that opens, you can edit any of the attribute information of the product.
|
||||
5. Once you’re done, click on the Save button.
|
||||
|
||||
---
|
||||
|
||||
## Manage Thumbnails
|
||||
|
||||
### Set Thumbnail
|
||||
@@ -259,6 +288,8 @@ To delete a thumbnail:
|
||||
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
|
||||
@@ -280,6 +311,8 @@ To manage a product’s images
|
||||
2. Click on Delete from the dropdown.
|
||||
4. Once you’re done, click Save and close.
|
||||
|
||||
---
|
||||
|
||||
## Duplicate a Product
|
||||
|
||||
To duplicate a product:
|
||||
@@ -290,6 +323,8 @@ To duplicate a product:
|
||||
|
||||
This creates a product with the same information as the original but as a draft.
|
||||
|
||||
---
|
||||
|
||||
## Delete a Product
|
||||
|
||||
:::warning
|
||||
|
||||
Reference in New Issue
Block a user