Files
medusa-store/docs/content/user-guide/multiwarehouse/reservations.mdx
Shahed Nasser 76c4bf4acb docs: documentation changes for release (#4300)
* docs: added manage reservations user guide (#4290)

* docs: added manage reservations user guide

* removed feature flag details

* docs: added how-to for custom reservations (#4292)

* docs: added how-to for custom reservations

* eslint fixes

* docs: added product module documentation (#4287)

* docs: added product module documentation

* added details about optional environment variables

* small fixes

* Remove reference link

* added example usages

* added link to sample project

* address PR feedback

* docs: moved product module guide + added product module tabs (#4307)

* added product module tab

* adjust design of badge

* docs: added onboarding features (#4168)

* added marketplace page

* added subscription roadmap

* added rating for onboarding

* added learning path components

* small fixes

* fix build error

* fix eslint errors

* change roadmaps to recipes

* small change in text

* optimize learning path and notifications

* fix tracking usage

* fix eslint errors

* added enter/exit animation

* allow starting a path using a query parameter

* fix gap between notifications

* address vercel comments

* fixed links issue

* changed create-medusa-app docs steps

* move troubleshooting section

* improved tracking across docs

* fix build errors

* remove console

* added a note about `boilerplate` option

* added troubleshooting section for eagain

* added invite option in cli reference

* added track event for finished onboarding

* update boilerplate option name

* redesigned learning path component

* docs: added how to create widget docs (#4318)

* docs: added how to create widget docs

* remove development guide

* added types

* docs: added details about createCustomAdminHooks (#4288)

* docs: added details about createCustomAdminHooks

* small improvement

* added missing import

* small changes

* docs: added onboarding guide (#4320)

* docs: added how to create widget docs

* remove development guide

* docs: added onboarding guide

* added types

* added recipes link

* small adjustments

* fixed eslint errors

* styling fixes

* change to singular product module

* updated the what's new section

* shorten down medusa react card

* updated tailwind configurations

* fix build error

* fix newspaper icon

* style fixes

* change modal shadow

* fix color of line numbers

* fix code fade color

* docs: updated admin documentations

* eslint fixes

* text changes

* added a note about beta version

* remove empty object argument

* remove demo repo url

* fix selection color for code headers

* general fixes

* fix eslint error

* changed code theme

* added preparation step

* changes regarding beta version

* Update docs/content/modules/products/serverless-module.md

Co-authored-by: Riqwan Thamir <rmthamir@gmail.com>

* Update docs/content/modules/products/serverless-module.md

Co-authored-by: Riqwan Thamir <rmthamir@gmail.com>

---------

Co-authored-by: Riqwan Thamir <rmthamir@gmail.com>
Co-authored-by: Oliver Windall Juhl <59018053+olivermrbl@users.noreply.github.com>
2023-06-20 12:25:22 +02:00

100 lines
4.7 KiB
Plaintext
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
---
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.