docs: add documentation for v1.8 (#3669)
This commit is contained in:
Shahed Nasser
@@ -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.
|
||||
|
||||
Reference in New Issue
Block a user