docs: general updates and fixes (#13620)
This commit is contained in:
@@ -42,7 +42,7 @@ You can create an order claim after the order's items have been [delivered](../f
|
||||
To create an order claim:
|
||||
|
||||
1. Go to an order’s details page.
|
||||
2. In the Summary section, click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the top right.
|
||||
2. In the Summary section, click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon in the section's header.
|
||||
3. Choose "Create Claim" from the dropdown.
|
||||
4. In the form that opens:
|
||||
- To add items to be returned:
|
||||
|
||||
@@ -39,7 +39,7 @@ You can create the draft order and convert it to a regular order once it is read
|
||||
To create a draft order:
|
||||
|
||||
1. Go to Orders -> Drafts.
|
||||
2. Click on the Create button at the top right.
|
||||
2. Click on the Create button in the main section's header.
|
||||
3. In the form that opens, enter the following information:
|
||||
- **Region**: Choose the region for the draft order. This determines the currency and tax rules applied to the order.
|
||||
- **Sales Channel**: Select the sales channel for the draft order. This defines where the order is being placed, affects which inventory items are available, and determines which shipping options are applicable to the order.
|
||||
|
||||
@@ -80,7 +80,7 @@ To view the JSON structure, click the <InlineIcon Icon={ArrowUpRightOnBox} alt="
|
||||
To edit the sales channel of a draft order:
|
||||
|
||||
1. Go to the draft order's details page.
|
||||
2. In the first section displaying the order's number and region, click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the right.
|
||||
2. In the first section displaying the order's number and region, click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon in the draft order's row.
|
||||
3. Select "Edit sales channel" from the dropdown menu.
|
||||
4. In the side window that opens, select the new sales channel from the dropdown.
|
||||
5. Click the Save button.
|
||||
@@ -94,10 +94,10 @@ To edit the sales channel of a draft order:
|
||||
To add, edit, or remove items from a draft order:
|
||||
|
||||
1. Go to the draft order's details page.
|
||||
2. In the Summary section, click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the right.
|
||||
2. Click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon in the Summary section's header.
|
||||
3. Select "Edit items" from the dropdown menu.
|
||||
4. In the form that opens:
|
||||
- To add an item, click the <InlineIcon Icon={Plus} alt="plus" /> button at the right of the "Items" section. From the dropdown, you can either choose:
|
||||
- To add an item, click the <InlineIcon Icon={Plus} alt="plus" /> button in the "Items" section's header. From the dropdown, you can either choose:
|
||||
- **Add items**: Add existing product variants to the draft order. This will open the product variant selection window.
|
||||
- **Add custom item**: Add a custom item that's only available in this draft order. This will open a form to enter the item's title, price, and quantity.
|
||||
- To edit an existing item, click the <InlineIcon Icon={PencilSquare} alt="pencil" /> button in the item's row. This will allow you to change the item's quantity and price.
|
||||
@@ -115,7 +115,7 @@ The items in the Summary section will be updated accordingly.
|
||||
To add or remove promotions applied to the draft order:
|
||||
|
||||
1. Go to the draft order's details page.
|
||||
2. In the Summary section, click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the right.
|
||||
2. Click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon in the Summary section's header.
|
||||
3. Select "Edit promotions" from the dropdown menu.
|
||||
4. In the side window that opens:
|
||||
- To add a promotion, choose it from the dropdown menu.
|
||||
@@ -142,8 +142,8 @@ To manage the shipping methods of a draft order:
|
||||
- **Custom amount**: (optional) If you want to override the price of the shipping option, you can set a custom amount.
|
||||
- **Items to ship**: This section only shows you which items this shipping option ships. You cannot edit this section.
|
||||
- Once you're done, click the "Add" button.
|
||||
- To edit the shipping option of a shipping profile, click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the right of the shipping option and choose "Edit shipping option" from the dropdown. You can edit the location, shipping option, and custom amount.
|
||||
- To remove a shipping option from the draft order, click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the right of the shipping option and choose "Remove shipping option" from the dropdown.
|
||||
- To edit the shipping option of a shipping profile, click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon in the shipping option's row and choose "Edit shipping option" from the dropdown. You can edit the location, shipping option, and custom amount.
|
||||
- To remove a shipping option from the draft order, click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon in the shipping option's row and choose "Remove shipping option" from the dropdown.
|
||||
4. Once you're done managing the shipping methods, click the "Save" button.
|
||||
|
||||
The Shipping section will be updated accordingly.
|
||||
@@ -161,7 +161,7 @@ If you've associated the draft order with a customer in your store, you can tran
|
||||
To transfer the draft order to another customer:
|
||||
|
||||
1. Go to the draft order's details page.
|
||||
2. In the Customer section, click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the right.
|
||||
2. Click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon in the Customer section's header.
|
||||
3. Choose "Transfer ownership" from the dropdown menu.
|
||||
4. In the side window that opens, choose the customer to transfer the draft order to in the "New customer" field.
|
||||
5. Once you're done, click the "Save" button.
|
||||
@@ -175,7 +175,7 @@ The draft order has an associated email address that is used to send order updat
|
||||
To edit the email address associated with a draft order:
|
||||
|
||||
1. Go to the draft order's details page.
|
||||
2. In the Customer section, click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the right.
|
||||
2. Click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon in the Customer section's header.
|
||||
3. Choose "Edit email" from the dropdown menu.
|
||||
4. In the side window that opens, enter the new email address in the "Email" field.
|
||||
5. Once you're done, click the "Save" button.
|
||||
@@ -191,7 +191,7 @@ Updates related to the order will be sent to the new email address.
|
||||
To edit the shipping address used for a draft order:
|
||||
|
||||
1. Go to the draft order's details page.
|
||||
2. In the Customer section, click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the right.
|
||||
2. Click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon in the Customer section's header.
|
||||
3. Choose "Edit shipping address" from the dropdown menu.
|
||||
4. In the side window that opens, you can update the shipping address details, including the country, first and last names, company, address lines, city, state, postal code, and phone number.
|
||||
5. Once you're done, click the "Save" button.
|
||||
@@ -205,7 +205,7 @@ To edit the shipping address used for a draft order:
|
||||
To edit the billing address used for a draft order:
|
||||
|
||||
1. Go to the draft order's details page.
|
||||
2. In the Customer section, click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the right.
|
||||
2. Click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon in the Customer section's header.
|
||||
3. Choose "Edit billing address" from the dropdown menu.
|
||||
4. In the side window that opens, you can update the billing address details, including the country, first and last names, company, address lines, city, state, postal code, and phone number.
|
||||
5. Once you're done, click the "Save" button.
|
||||
@@ -222,14 +222,14 @@ When the draft order is converted to an order, the metadata will be carried over
|
||||
|
||||
To edit the draft order's metadata:
|
||||
|
||||
1. Click the <InlineIcon Icon={ArrowUpRightOnBox} alt="arrow" /> icon at the right of the "Metadata" section.
|
||||
1. Click the <InlineIcon Icon={ArrowUpRightOnBox} alt="arrow" /> icon in the "Metadata" section.
|
||||
2. 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={EllipsisHorizontal} alt="three-dots" /> icon at its right.
|
||||
- Hover over the row and click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at its end.
|
||||
- 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={EllipsisHorizontal} alt="three-dots" /> icon at its right.
|
||||
- Hover over the row and click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at its end.
|
||||
- Choose "Delete row" from the dropdown.
|
||||
3. Once you're done, click the Save button.
|
||||
|
||||
@@ -266,5 +266,5 @@ Deleting a draft order is irreversible.
|
||||
To delete a draft order:
|
||||
|
||||
1. Go to the draft order's details page.
|
||||
2. In the first section displaying the order's number and region, click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the right.
|
||||
2. In the first section displaying the order's number and region, click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon.
|
||||
3. Choose "Delete draft order" from the dropdown menu.
|
||||
@@ -88,7 +88,7 @@ Force-confirming an order edit makes irreversible changes to the order.
|
||||
To force confirm an order edit:
|
||||
|
||||
1. Open the order's details page.
|
||||
2. Click the "Force confirm" button at the bottom right of the "Order edit requested" section.
|
||||
2. Click the "Force confirm" button at the bottom of the "Order edit requested" section.
|
||||
|
||||
This applies the changes to the order edit. If there are any additional payments required, you'll have to mark the order as paid or share a payment link manually.
|
||||
|
||||
@@ -115,6 +115,6 @@ If an order edit request hasn't been confirmed yet, you can cancel it.
|
||||
To cancel an order edit request:
|
||||
|
||||
1. Open the order details page.
|
||||
2. Click the "Cancel" button at the bottom right of the "Order edit requested" section.
|
||||
2. Click the "Cancel" button at the bottom of the "Order edit requested" section.
|
||||
|
||||
The order edit will be canceled and the changes won't be saved on the order. The customer also can't confirm the order edit anymore.
|
||||
|
||||
@@ -36,7 +36,7 @@ You can create an order exchange after the order's items have been [delivered](.
|
||||
To create an order exchange:
|
||||
|
||||
1. Go to an order’s details page.
|
||||
2. In the Summary section, click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the top right.
|
||||
2. In the Summary section, click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon in the section's header.
|
||||
3. Choose "Create Exchange" from the dropdown.
|
||||
4. In the form that opens:
|
||||
- To add items to be returned:
|
||||
|
||||
@@ -139,7 +139,7 @@ To add a shipment for a fulfillment:
|
||||
|
||||
1. Open the order's details page.
|
||||
2. Scroll down to the Fulfillment's section. If you have more than one fulfillment, find the fulfillment you're looking for.
|
||||
3. Click on the "Mark as shipped" button at the bottom right of the section.
|
||||
3. Click on the "Mark as shipped" button at the bottom of the section.
|
||||
4. In the form that opens:
|
||||
- To add a tracking number, click on the "Add tracking number" button, then enter a tracking number.
|
||||
- If you don’t want the customer to receive a notification that the fulfillment has been shipped, uncheck the “Send notifications” toggle.
|
||||
@@ -171,7 +171,7 @@ To mark the fulfillment as delivered:
|
||||
|
||||
1. Open the order's details page.
|
||||
2. Scroll down to the Fulfillment section. If you have more than one fulfillment, find the fulfillment you're looking for.
|
||||
3. Click on the "Mark as delivered" button at the bottom right of the section.
|
||||
3. Click on the "Mark as delivered" button at the bottom of the section.
|
||||
4. Confirm marking the fulfillment as delivered by clicking the "Continue" button in the pop-up
|
||||
|
||||

|
||||
@@ -194,7 +194,7 @@ To mark the fulfillment as picked up:
|
||||
|
||||
1. Open the order's details page.
|
||||
2. Scroll down to the Fulfillment section. If you have more than one fulfillment, find the fulfillment you're looking for.
|
||||
3. Click on the "Mark as picked up" button at the bottom right of the section.
|
||||
3. Click on the "Mark as picked up" button at the bottom of the section.
|
||||
4. Confirm marking the fulfillment as picked up by clicking the "Continue" button in the pop-up.
|
||||
|
||||

|
||||
@@ -211,7 +211,7 @@ To cancel a fulfillment in an order:
|
||||
|
||||
1. Open the order's details page.
|
||||
2. Scroll down to the Fulfillment section. If you have more than one fulfillment, find the fulfillment you're looking for.
|
||||
3. Click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the top right of the section.
|
||||
3. Click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon in the section's header.
|
||||
4. Click on Cancel in the dropdown.
|
||||
5. Confirm canceling the fulfillment by clicking the “Continue" button in the pop-up.
|
||||
|
||||
|
||||
@@ -104,7 +104,7 @@ To allocate these items manually:
|
||||
To edit the shipping address used for an order:
|
||||
|
||||
1. Open the order details page.
|
||||
2. Click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dot" /> icon at the top right of the Customer section.
|
||||
2. Click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dot" /> icon in the Customer section header.
|
||||
3. Click on "Shipping address" from the dropdown.
|
||||
4. In the side window that opens, update the address details.
|
||||
5. Once you’re done, click on the Save button.
|
||||
@@ -118,7 +118,7 @@ To edit the shipping address used for an order:
|
||||
To edit the billing address used for an order:
|
||||
|
||||
1. Open the order details page.
|
||||
2. Click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dot" /> icon at the top right of the Customer section.
|
||||
2. Click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dot" /> icon in the Customer section header.
|
||||
3. Click on "Billing address" from the dropdown.
|
||||
4. In the side window that opens, update the address details.
|
||||
5. Once you’re done, click on the Save button.
|
||||
@@ -134,7 +134,7 @@ You can edit the email address of an order to send order-update notifications to
|
||||
To edit the email address associated with an order:
|
||||
|
||||
1. Open the order details page.
|
||||
2. Click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dot" /> icon at the top right of the Customer section.
|
||||
2. Click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dot" /> icon in the Customer section header.
|
||||
3. Click on "Email" from the dropdown.
|
||||
4. In the side window that opens, edit the email address.
|
||||
5. Once you’re done, click on the Save button.
|
||||
@@ -158,7 +158,7 @@ When you transfer the ownership of an order, the original customer will receive
|
||||
To transfer the ownership of an order to another customer:
|
||||
|
||||
1. Open the order details page.
|
||||
2. Click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dot" /> icon at the top right of the Customer section.
|
||||
2. Click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dot" /> icon in the Customer section header.
|
||||
3. Click on "Transfer ownership" from the dropdown.
|
||||
4. In the side window that opens, choose the new customer from the dropdown under the "New owner" section.
|
||||
5. Once you're done, click on the Save button.
|
||||
@@ -193,7 +193,7 @@ Canceling an order is irreversible.
|
||||
To cancel an order:
|
||||
|
||||
1. Open the order details page.
|
||||
2. In the first section showing the order’s number, click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> at its right.
|
||||
2. In the first section showing the order’s number, click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> next to it.
|
||||
3. Click on Cancel from the dropdown.
|
||||
4. Confirm canceling the order by clicking the “Continue” button in the pop-up.
|
||||
|
||||
|
||||
@@ -107,7 +107,7 @@ To refund an order’s negative outstanding amount:
|
||||
|
||||
1. Open the order's details page.
|
||||
2. Scroll to the Payment section.
|
||||
3. Click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the right of the payment to refund.
|
||||
3. Click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the end of the payment to refund.
|
||||
4. Choose "Refund" from the dropdown.
|
||||
5. In the side window that opens, fill out the following fields:
|
||||
- **Select payment to refund**: Choose the payment to refund an amount from.
|
||||
|
||||
@@ -57,7 +57,7 @@ You can create a return from the Medusa Admin for [delivered items](../fulfillme
|
||||
To create a return for an order:
|
||||
|
||||
1. Open the order details page.
|
||||
2. In the Summary section, click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the top right.
|
||||
2. In the Summary section, click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon in the section's header.
|
||||
3. Choose "Create Return" from the dropdown.
|
||||
4. In the form that opens:
|
||||
- To add items to return:
|
||||
|
||||
Reference in New Issue
Block a user