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
@@ -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, 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)
|
||||
- [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, 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.
|
||||
@@ -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, you’ll 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 order’s 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 you’re 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 aren’t 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 you’re done, click the “Save and close” button.
|
||||
|
||||
---
|
||||
|
||||
## Delete Reservation
|
||||
|
||||
:::warning
|
||||
|
||||
Deleting a reservation can’t be undone, and the reservation data can’t 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.
|
||||
Reference in New Issue
Block a user