asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

docs: update inventory user guide (#11509)

Browse Source 
* docs: update inventory user guide

* fix build error

* fix build
This commit is contained in:
Shahed Nasser
2025-02-18 17:30:01 +02:00
committed by GitHub
parent 084f76b73f
commit 25a7826f0c
8 changed files with 319 additions and 78 deletions
Download Patch File Download Diff File Expand all files Collapse all files

190
www/apps/user-guide/app/inventory/inventory/page.mdx
View File

@@ -2,40 +2,190 @@
sidebar_position: 1
---
import { EllipsisHorizontal } from "@medusajs/icons"
import { EllipsisHorizontal, ArrowUpRightOnBox, EllipsisVertical } from "@medusajs/icons"
export const metadata = {
title: `Manage Inventory`,
title: `Manage Inventory Items`,
}
# {metadata.title}
In this document, you’ll learn how to manage inventory in the Medusa Admin.
In this guide, you’ll learn how to manage inventory items in the Medusa Admin.
## Check Inventory
<Note>
To check your store’s inventory, go to the Inventory page. Here, you’ll see the all available inventory of product variants.
This guide covers how to manage inventory items in the Inventory domain of the Medusa Admin. You can alternatively manage the inventory of a product's variants from the [product's details page](../../products/variants/page.mdx#manage-product-variant-inventory).
### Filter by Location
</Note>
To filter the shown results by location:
## Create Inventory Item
1. Click on the "Add filter" button.
2. Select Location from the dropdown.
3. Select the location(s) to filter ther results by.
To create an inventory item:
1. Go to the Inventory page from the sidebar.
2. Click on the Create button at the top right.
3. The form that opens has two steps:
1. Details step:
- Enter the inventory item's title and SKU in their respective fields.
- Optionally enter a description.
- If the inventory item shouldn't be shipped when its variant is purchased, toggle off the "Requires shipping" option. This is useful when the inventory item is a digital product, for example.
- Optionally add the inventory item's attributes, including width, length, height, weight, MID code, HS code, country of origin, and material.
- Once you're done, click the Next button.
2. Availability step using the [Bulk Editor](../../tips/bulk-editor/page.mdx):
- If you have locations in your store, which you can create in [Settings](../../settings/locations/page.mdx), you can specify the inventory item's quantity in each location.
4. Once you're done, click the Save button.
![Create Inventory Item Form](https://res.cloudinary.com/dza7lstvk/image/upload/v1739882517/User%20Guide/Screenshot_2025-02-18_at_2.39.03_PM_jsfp3d.png)
---
## Change Variant Inventory Quantity
## View Inventory Item Details
{/* TODO check info for correctness */}
To view an inventory item's details:
To change a product variant’s inventory quantity:
1. Go to the Inventory page from the sidebar.
2. Click on the inventory item you want to view.
1. Go to the Inventory page.
2. Click the product variant to edit its inventory.
3. Under the "Location levels" section, find the location to edit the quantity in.
4. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the right of the location.
5. Choose "Adjust availability" from the dropdown.
6. In the drawer that opens, edit the "In Stock" field with the new stock quantity of the variant.
7. Once you're done, click the Save button.
![Inventory details page](https://res.cloudinary.com/dza7lstvk/image/upload/v1739882587/User%20Guide/Screenshot_2025-02-18_at_2.42.57_PM_dkxudi.png)
---
## Edit Inventory Item Details
To edit an inventory item's details:
1. Go to the inventory item's details page.
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the top right of the first section.
3. Choose "Edit" from the dropdown.
4. In the side window that opens, you can edit the inventory's title and SKU.
5. Once you're done, click the Save button.
![Edit Inventory Item Form](https://res.cloudinary.com/dza7lstvk/image/upload/v1739882721/User%20Guide/Screenshot_2025-02-18_at_2.45.12_PM_scijta.png)
---
## Edit Inventory Item Attributes
To edit an inventory item's attributes, such as height and weight:
1. Go to the inventory item's details page.
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the top right of the "Attributes" section.
3. Choose "Edit" from the dropdown.
4. In the side window that opens, you can edit the inventory item's height, width, length, weight, MID code, HS code, and country of origin.
5. Once you're done, click the Save button.
![Edit Inventory Item Attributes Form](https://res.cloudinary.com/dza7lstvk/image/upload/v1739882880/User%20Guide/Screenshot_2025-02-18_at_2.47.49_PM_uxlvkb.png)
---
## Edit Inventory Item Metadata
Metadata is custom data that can be associated with the inventory item in key-value pairs. This is usually used by developers for custom integrations or to store additional information about the inventory item.
To edit the inventory item's metadata:
1. Go to the inventory item's details page.
2. Click the <InlineIcon Icon={ArrowUpRightOnBox} alt="arrow" /> icon at the right of the "Metadata" section.
3. In the side window that opens:
- Manage the key-value pairs in the table.
- To add a new row of key-value pairs before or after a row:
- Hover over the row and click the <InlineIcon Icon={EllipsisVertical} alt="three-dots" /> icon at its right.
- Choose "Insert row above" or "Insert row below" from the dropdown.
- To delete a row of key-value pairs:
- Hover over the row and click the <InlineIcon Icon={EllipsisVertical} alt="three-dots" /> icon at its right.
- Choose "Delete row" from the dropdown.
4. Once you're done, click the Save button.
---
## Manage the Inventory Item's Availability
You can manage which locations the inventory item is available in, the quantity available in each location, and the item's reservations.
### Manage Locations Availability
To manage the locations that an inventory item is available in:
1. Go to the inventory item's details page.
2. Click the "Manage locations" button at the top right of the "Locations" section.
3. In the side window that opens, you can check or uncheck any location that the item is available in.
4. Once you're done, click the Save button.
![Manage Locations Form](https://res.cloudinary.com/dza7lstvk/image/upload/v1739883050/User%20Guide/Screenshot_2025-02-18_at_2.50.41_PM_zxtz8k.png)
### Manage Quantity Availability
To manage the in-stock quantity of an inventory item in a location:
1. Go to the inventory item's details page.
2. In the "Locations" section, find the location you want to edit the in-stock quantity in, and click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at its right.
3. Choose "Edit" from the dropdown.
4. In the side window that opens, you can edit the inventory item's in-stock quantity in that location.
5. Once you're done, click the Save button.
![Manage Quantity Form](https://res.cloudinary.com/dza7lstvk/image/upload/v1739883219/User%20Guide/Screenshot_2025-02-18_at_2.52.33_PM_jvax7o.png)
### Manage Inventory Item's Reservations
An inventory item may have reservations when a variant associated with it has been purchased but haven't been fulfilled yet. The reservation ensures that the required quantity is available when the order is fulfilled.
You can manage all reservations from the [Reservations page](../reservations/page.mdx). You can also manage the reservations of a specific inventory item from the inventory item's details page.
### Create Reservation for Item
To create a reservation for an inventory item:
1. Go to the inventory item's details page.
2. In the "Reservations" section, click the "Create" button.
3. In the form that opens:
- For the Location field, choose the location to reserve the item in.
- After you choose the location, enter the quantity to reserve in the Quantity field.
- The table above the field shows you how many available quantities of the item in the chosen location. When you make changes to the Quantity field, the availability will be updated in the table to reflect the change.
- Optionally specify a description for the reservation.
4. Once you're done, click the Create button.
![Create Reservation form](https://res.cloudinary.com/dza7lstvk/image/upload/v1739884917/User%20Guide/Screenshot_2025-02-18_at_2.58.41_PM_d8tgpb.png)
### Edit Reservation for Item
To edit a reservation for an inventory item:
1. Go to the inventory item's details page.
2. In the "Reservations" section, find the reservation you want to edit and click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at its right.
3. Choose "Edit" from the dropdown.
4. In the side window that opens, you can edit the reservation's location, quantity, and description.
5. Once you're done, click the Save button.
![Edit Reservation form](https://res.cloudinary.com/dza7lstvk/image/upload/v1739884918/User%20Guide/Screenshot_2025-02-18_at_3.21.36_PM_vjp0eo.png)
### Delete Reservation of an Item
<Note type="warning">
Deleting a reservation is irreversible. If you delete a reservation created for an order, you may need to [allocate the item in the order again](../../orders/manage/page.mdx#allocate-order-items-manually).
</Note>
To delete a reservation for an inventory item:
1. Go to the inventory item's details page.
2. In the "Reservations" section, find the reservation you want to delete and click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at its right.
3. Choose "Delete" from the dropdown.
4. Confirm the action by clicking the Delete button in the pop-up.
---
## Delete Inventory Item
<Note type="warning">
Deleting an inventory item is irreversible. This may affect the associated variant(s) inventory.
</Note>
To delete an inventory item:
1. Go to the Inventory page from the sidebar.
2. Find the inventory item to delete, and click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at its right.
3. Choose "Delete" from the dropdown.
4. Confirm the action by clicking the Delete button in the pop-up.

22
www/apps/user-guide/app/inventory/page.mdx
View File

@@ -3,30 +3,32 @@ sidebar_autogenerate_exclude: true
---
export const metadata = {
title: `Inventory`,
title: `Inventory Overview`,
}
# {metadata.title}
In this document, you’ll get an overview of the inventory domain of the Medusa Admin.
The Inventory domain allows you to manage inventory items, their quantity in different locations, and their reservations.
## Overview
When a product variant's "Manage Inventory" is enabled, inventory items are created for that variant to manage its quantity. You can also create inventory items and link them later to variants, which is most useful for [multi-part](../products/create/multi-part/page.mdx) and [bundled](../products/create/bundle/page.mdx) products.
When a product variant's "Manage Inventory" is enabled, inventory items are created for that variant to manage its quantity.
You can view the list of inventory items in your commerce store by clicking on Inventory from the sidebar menu.
An inventory item has different quantities for each [location](../settings/locations/page.mdx).
In the list, you can see inventory details such as the title, SKU, and in-stock quantity. You can also search, filter, and sort the inventory items to find the specific item you are looking for.
<Note>
<Note title="Tip">
The following aren't explained within this section of the user guide:
- Item allocation and locations in orders: this is explained in the [Manage Orders guide](../orders/manage/page.mdx).
Find tips to use lists effectively in [this guide](../tips/lists/page.mdx).
</Note>
![Inventory List](https://res.cloudinary.com/dza7lstvk/image/upload/v1739881950/User%20Guide/Screenshot_2025-02-18_at_2.32.19_PM_ffxsur.png)
---
## Learn More About Inventory
## Manage Inventory
- [Manage Inventory](./inventory/page.mdx)
- [Manage Reservations](./reservations/page.mdx)
You can also manage locations under [Settings](../settings/locations/page.mdx).

90
www/apps/user-guide/app/inventory/reservations/page.mdx
View File

@@ -2,7 +2,7 @@
sidebar_position: 3
---
import { EllipsisHorizontal } from "@medusajs/icons"
import { EllipsisHorizontal, ArrowUpRightOnBox, EllipsisVertical } from "@medusajs/icons"
export const metadata = {
title: `Manage Reservations`,
@@ -10,70 +10,100 @@ export const metadata = {
# {metadata.title}
In this document, you’ll learn how to manage reservations in your store.
In this guide, you’ll learn how to manage reservations in your store.
## View Reservations
## What is a Reservation?
To view reservations, go to Inventory from the sidebar, the click the Reservations sub-item shown in the sidebar.
A reservation is a reserved quantity of an inventory item. Medusa automatically creates reservations for inventory items whose variants are purchased. This ensures that the inventory item is not sold to another customer while the order is being processed. Once the item in the order is fulfilled, the reservation is removed.
In the reservations page, you can view all reservations.
You can also manually create reservations for inventory items. For example, you can reserve a quantity of an inventory item for an offline sale or a customer who has requested a reservation.
### Filter by Location
### View Reservations
To filter reservations by location:
To view reservations, go to Inventory from the sidebar, then click the Reservations sub-item shown in the sidebar.
1. Click the "Add filter" button.
2. Choose Location from the dropdown.
3. Choose the locations(s) to filter the list by.
In the list, you can see reservation details such as the SKU and reserved quantity. You can also search, filter, and sort the reservations to find the specific item you are looking for.
![Reservations List](https://res.cloudinary.com/dza7lstvk/image/upload/v1739885485/User%20Guide/Screenshot_2025-02-18_at_3.31.14_PM_oegbl9.png)
---
## Create a Reservation
{/* TODO check info for correctness */}
Reservations are created manually when an order is created. You can also manage them from the order’s page.
To manually create a reservation item:
To create a reservation manually:
1. Go to Inventory → Reservations.
2. Click on the Create button.
2. Click on the Create button at the top right.
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 or choose the SKU of the item you want to create a reservation for.
3. Set the reserved quantity in the "Reserve amount" field.
4. You can optionally add a description in the Description field, or add additional data as key-value pairs under the Metadata section.
4. Once you’re done, click the Save button.
- For the “Item to reserve” field, enter or choose the SKU of the item you want to create a reservation for.
- For the “Location” field, select the location where the reservation is created.
- Set the reserved quantity in the "Quantity" field.
- The table above the field shows you how many available quantities of the item are in the chosen location. When you make changes to the Quantity field, the availability will be updated in the table to reflect the change.
- You can optionally add a description in the Description field.
4. Once you’re done, click the Create button.
![Create Reservation form](https://res.cloudinary.com/dza7lstvk/image/upload/v1739885660/User%20Guide/Screenshot_2025-02-18_at_3.34.10_PM_t472gy.png)
---
## View Reservation Details
To view a reservation's details:
1. Go to Inventory → Reservations.
2. Click on the reservation you want to view.
This will open the reservation's details page.
![Reservation details page](https://res.cloudinary.com/dza7lstvk/image/upload/v1739885829/User%20Guide/Screenshot_2025-02-18_at_3.36.57_PM_va4vsr.png)
---
## Edit Reservation
{/* TODO check info for correctness */}
To edit a reservation:
1. Go to Inventory → Reservations
1. Go to Inventory → Reservations.
2. Find the reservation you want to edit, and click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon on its right.
3. Choose Edit from the dropdown.
4. In the drawer that opens, edit the reservation's details.
4. In the side window that opens, you can edit the reservation's location, reserved quantity, and description.
5. Once you’re done, click the Save button.
![Edit Reservation form](https://res.cloudinary.com/dza7lstvk/image/upload/v1739884918/User%20Guide/Screenshot_2025-02-18_at_3.21.36_PM_vjp0eo.png)
---
## Edit Reservation Metadata
Metadata is custom data that can be associated with the reservation in key-value pairs. This is usually used by developers for custom integrations or to store additional information about the reservation.
To edit the reservation's metadata:
1. Go to the reservation's details page.
2. Click the <InlineIcon Icon={ArrowUpRightOnBox} alt="arrow" /> icon at the right of the "Metadata" section.
3. In the side window that opens:
- Manage the key-value pairs in the table.
- To add a new row of key-value pairs before or after a row:
- Hover over the row and click the <InlineIcon Icon={EllipsisVertical} alt="three-dots" /> icon at its right.
- Choose "Insert row above" or "Insert row below" from the dropdown.
- To delete a row of key-value pairs:
- Hover over the row and click the <InlineIcon Icon={EllipsisVertical} alt="three-dots" /> icon at its right.
- Choose "Delete row" from the dropdown.
4. Once you're done, click the Save button.
---
## Delete Reservation
<Note type="warning">
Deleting a reservation is irreversible.
Deleting a reservation is irreversible. If you delete a reservation created for an order, you may need to [allocate the item in the order again](../../orders/manage/page.mdx#allocate-order-items-manually).
</Note>
{/* TODO check info for correctness */}
To delete a reservation:
1. Go to Inventory → Reservations
1. Go to Inventory → Reservations.
2. Find the reservation you want to delete, and click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon on its right.
3. Choose Delete from the dropdown.
4. Confirm deleting the reservation by clicking the Remove button in the pop-up.
4. Confirm deleting the reservation by clicking the Delete button in the pop-up.

22
www/apps/user-guide/app/products/categories/page.mdx
View File

@@ -2,7 +2,7 @@
sidebar_position: 5
---
import { DotsSix, TriangleRightMini, EllipsisHorizontal } from "@medusajs/icons"
import { DotsSix, TriangleRightMini, EllipsisHorizontal, ArrowUpRightOnBox, EllipsisVertical } from "@medusajs/icons"
export const metadata = {
title: `Manage Product Categories`,
@@ -77,6 +77,26 @@ To edit a product category:
---
## Edit Product Category Metadata
Metadata is custom data that can be associated with the product category in key-value pairs. This is usually used by developers for custom integrations or to store additional information about the product category.
To edit the product category's metadata:
1. Go to the product category's details page.
2. Click the <InlineIcon Icon={ArrowUpRightOnBox} alt="arrow" /> icon at the right of the "Metadata" section.
3. In the side window that opens:
- Manage the key-value pairs in the table.
- To add a new row of key-value pairs before or after a row:
- Hover over the row and click the <InlineIcon Icon={EllipsisVertical} alt="three-dots" /> icon at its right.
- Choose "Insert row above" or "Insert row below" from the dropdown.
- To delete a row of key-value pairs:
- Hover over the row and click the <InlineIcon Icon={EllipsisVertical} alt="three-dots" /> icon at its right.
- Choose "Delete row" from the dropdown.
4. Once you're done, click the Save button.
---
## Manage Category's Products
From the product category's details page, you can manage the products in the category.

22
www/apps/user-guide/app/products/collections/page.mdx
View File

@@ -2,7 +2,7 @@
sidebar_position: 4
---
import { EllipsisHorizontal } from "@medusajs/icons"
import { EllipsisHorizontal,ArrowUpRightOnBox, EllipsisVertical } from "@medusajs/icons"
export const metadata = {
title: `Manage Product Collections`,
@@ -66,6 +66,26 @@ To edit a collection:
---
## Edit Product Collection Metadata
Metadata is custom data that can be associated with the product collection in key-value pairs. This is usually used by developers for custom integrations or to store additional information about the product collection.
To edit the product collection's metadata:
1. Go to the product collection's details page.
2. Click the <InlineIcon Icon={ArrowUpRightOnBox} alt="arrow" /> icon at the right of the "Metadata" section.
3. In the side window that opens:
- Manage the key-value pairs in the table.
- To add a new row of key-value pairs before or after a row:
- Hover over the row and click the <InlineIcon Icon={EllipsisVertical} alt="three-dots" /> icon at its right.
- Choose "Insert row above" or "Insert row below" from the dropdown.
- To delete a row of key-value pairs:
- Hover over the row and click the <InlineIcon Icon={EllipsisVertical} alt="three-dots" /> icon at its right.
- Choose "Delete row" from the dropdown.
4. Once you're done, click the Save button.
---
## Manage Collection’s Products
From the product collection's details page, you can manage the products in the collection.

14
www/apps/user-guide/generated/edit-dates.mjs
View File

@@ -25,8 +25,8 @@ export const generatedEditDates = {
"app/settings/regions/providers/page.mdx": "2024-05-03T17:36:38+03:00",
"app/settings/locations/page.mdx": "2024-05-03T17:36:38+03:00",
"app/settings/developer/api-key-management/page.mdx": "2024-05-03T17:36:38+03:00",
"app/products/categories/page.mdx": "2025-02-18T12:12:53.460Z",
"app/inventory/reservations/page.mdx": "2024-05-03T17:36:38+03:00",
"app/products/categories/page.mdx": "2025-02-18T14:00:05.996Z",
"app/inventory/reservations/page.mdx": "2025-02-18T13:56:28.134Z",
"app/settings/developer/api-key-management/sales-channels/page.mdx": "2024-05-03T17:36:38+03:00",
"app/pricing/page.mdx": "2024-05-03T17:36:38+03:00",
"app/pricing/manage/page.mdx": "2024-05-03T17:36:38+03:00",
@@ -35,18 +35,18 @@ export const generatedEditDates = {
"app/products/page.mdx": "2025-02-18T12:24:19.794Z",
"app/settings/sales-channels/products/page.mdx": "2024-05-03T17:36:38+03:00",
"app/settings/developer/executions/page.mdx": "2024-05-03T17:36:38+03:00",
"app/inventory/inventory/page.mdx": "2024-05-03T17:36:38+03:00",
"app/inventory/inventory/page.mdx": "2025-02-18T13:59:16.960Z",
"app/customers/groups/page.mdx": "2024-05-03T17:36:38+03:00",
"app/orders/manage/page.mdx": "2025-02-17T10:29:36.199Z",
"app/orders/returns/page.mdx": "2025-02-17T15:10:11.039Z",
"app/inventory/page.mdx": "2024-05-03T17:36:38+03:00",
"app/inventory/page.mdx": "2025-02-18T13:58:42.393Z",
"app/settings/sales-channels/manage/page.mdx": "2024-05-03T17:36:38+03:00",
"app/orders/claims/page.mdx": "2025-02-17T15:16:27.380Z",
"app/orders/fulfillments/page.mdx": "2025-02-17T15:12:20.431Z",
"app/customers/page.mdx": "2024-05-03T17:36:38+03:00",
"app/customers/page.mdx": "2025-02-18T13:56:28.134Z",
"app/orders/edit/page.mdx": "2025-02-17T15:15:53.489Z",
"app/products/collections/page.mdx": "2025-02-18T12:07:53.371Z",
"app/customers/manage/page.mdx": "2024-05-03T17:36:38+03:00",
"app/products/collections/page.mdx": "2025-02-18T14:00:51.469Z",
"app/customers/manage/page.mdx": "2025-02-18T13:56:28.134Z",
"app/discounts/create/page.mdx": "2024-05-03T17:36:38+03:00",
"app/orders/payments/page.mdx": "2025-02-17T15:10:24.250Z",
"app/discounts/page.mdx": "2024-05-03T17:36:38+03:00",

18
www/apps/user-guide/generated/sidebar.mjs
View File

@@ -211,26 +211,30 @@ export const generatedSidebar = [
"loaded": true,
"isPathHref": true,
"type": "category",
"path": "/inventory",
"title": "Inventory",
"autogenerate_path": "/inventory",
"children": [
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/inventory/inventory",
"title": "Manage Inventory",
"description": "",
"title": "Overview",
"path": "/inventory",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"title": "Manage Inventory",
"path": "/inventory/inventory",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/inventory/reservations",
"title": "Manage Reservations",
"description": "",
"path": "/inventory/reservations",
"children": []
}
]

19
www/apps/user-guide/sidebar.mjs
View File

@@ -123,9 +123,24 @@ export const sidebar = sidebarAttachHrefCommonOptions([
},
{
type: "category",
path: "/inventory",
title: "Inventory",
autogenerate_path: "/inventory",
children: [
{
type: "link",
title: "Overview",
path: "/inventory",
},
{
type: "link",
title: "Manage Inventory",
path: "/inventory/inventory",
},
{
type: "link",
title: "Manage Reservations",
path: "/inventory/reservations",
},
],
},
{
type: "category",