docs: update inventory user guide (#11509)
* docs: update inventory user guide * fix build error * fix build
This commit is contained in:
Shahed Nasser authored and 
GitHub committed
1 parent
084f76b73f
commit
25a7826f0c
8 files changed
+318
-77
No files matched your search
@@ -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.
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## 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.
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## 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.
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## 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 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.
|
||||
Reference in new issue
Block a user