docs: docs for next release (#13303)
* added draft order plugin docs * fix vale error * added note about draft order being optional * add new shipping option - shipping method link * update user guides * generate * fix github icon * changes to shipping option type * document logger * reorder list * fixes * fixes
This commit is contained in:
Shahed Nasser
@@ -0,0 +1,62 @@
|
||||
---
|
||||
sidebar_position: 9
|
||||
sidebar_label: "Create Draft Order"
|
||||
tags:
|
||||
- user guide
|
||||
- order
|
||||
products:
|
||||
- order
|
||||
---
|
||||
|
||||
export const metadata = {
|
||||
title: `Create Draft Orders in Medusa Admin`,
|
||||
}
|
||||
|
||||
# {metadata.title}
|
||||
|
||||
In this guide, you'll learn how to create draft orders in the Medusa Admin.
|
||||
|
||||
<Note title="Prerequisite">
|
||||
|
||||
If you're using a version earlier than v2.10.0, you must [install the Draft Orders Plugin manually](!resources!/commerce-modules/order/draft-orders). Your technical team should handle the plugin installation.
|
||||
|
||||
</Note>
|
||||
|
||||
## When to Create a Draft Order
|
||||
|
||||
You should create a draft order in the following scenarios:
|
||||
|
||||
- When handling customer support requests that require creating an order on behalf of the customer.
|
||||
- When processing orders that are taken offline, such as over the phone or in-store.
|
||||
- When a customer wants to place an order but needs to finalize details later.
|
||||
|
||||
You can create the draft order and convert it to a regular order once it is ready for processing.
|
||||
|
||||
---
|
||||
|
||||
## Create a Draft Order
|
||||
|
||||
To create a draft order:
|
||||
|
||||
1. Go to Orders -> Drafts.
|
||||
2. Click on the Create button at the top right.
|
||||
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.
|
||||
- **Customer** (optional): Select an existing customer that the draft order belongs to. You can also set the customer at a later point or not set it at all.
|
||||
- **Email**: Set the customer's email address. The customer may receive order updates at this email.
|
||||
- **Shipping Address**: Enter the shipping address details for the draft order, or select an existing address if the customer is set.
|
||||
- **Billing Address**: Either set the billing address to be the same as the shipping address or enter a different billing address.
|
||||
4. Once you're done, click the Save button.
|
||||
|
||||
The draft order will be created, and you will be redirected to the draft order's details page.
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Next Steps: Manage Items and Shipping Methods
|
||||
|
||||
After creating the draft order, you can add items to the order and manage its shipping methods.
|
||||
|
||||
Learn how to do that in the [Manage Draft Order Details](../manage/page.mdx) guide.
|
||||
@@ -0,0 +1,270 @@
|
||||
---
|
||||
sidebar_position: 9
|
||||
sidebar_label: "Manage Draft Order"
|
||||
tags:
|
||||
- user guide
|
||||
- order
|
||||
products:
|
||||
- order
|
||||
---
|
||||
|
||||
import {
|
||||
ArrowUpRightOnBox,
|
||||
EllipsisHorizontal,
|
||||
Plus,
|
||||
PencilSquare,
|
||||
XMark
|
||||
} from "@medusajs/icons"
|
||||
|
||||
export const metadata = {
|
||||
title: `Manage Draft Order Details in Medusa Admin`,
|
||||
}
|
||||
|
||||
# {metadata.title}
|
||||
|
||||
In this guide, you'll learn how to manage draft order details in the Medusa Admin.
|
||||
|
||||
<Note title="Prerequisite">
|
||||
|
||||
If you're using a version earlier than v2.10.0, you must [install the Draft Orders Plugin manually](!resources!/commerce-modules/order/draft-orders). Your technical team should handle the plugin installation.
|
||||
|
||||
</Note>
|
||||
|
||||
## View Draft Order Details
|
||||
|
||||
To view the details of a draft order:
|
||||
|
||||
1. Go to Orders -> Drafts.
|
||||
2. Click on the draft order you want to view.
|
||||
|
||||
This will open the draft order's details page, which is divided into several sections.
|
||||
|
||||
### Summary Section
|
||||
|
||||
The Summary section includes a summary of the items the customer purchased, as well as totals related to taxes, shipping, and more. Use this section to get a quick overview of the draft order, [convert it to a regular order](#convert-draft-order-to-regular-order), or [manage its items](#manage-draft-orders-items).
|
||||
|
||||
|
||||
|
||||
### Customer Section
|
||||
|
||||
The Customer section shows the customer’s details, including their contact information and shipping address. Use this section to view and [edit the customer’s details pertaining to the order](#manage-draft-orders-customer-details).
|
||||
|
||||
|
||||
|
||||
### Activity Section
|
||||
|
||||
The Activity section of the draft order details page shows a summary of the changes made to the draft order. That includes updates to items and shipping methods.
|
||||
|
||||
|
||||
|
||||
### Shipping Section
|
||||
|
||||
The Shipping section shows the draft order's shipping details, including the shipping methods chosen for each shipping profile associated with the draft order's items. Use this section to view and [manage the shipping methods for the draft order](#manage-draft-orders-shipping-methods).
|
||||
|
||||
|
||||
|
||||
## Metadata Section
|
||||
|
||||
The Metadata section allows you to view and [manage custom metadata associated with the draft order](#manage-draft-orders-metadata). Metadata can be useful for storing additional information about the order that is not covered by the default fields.
|
||||
|
||||
### JSON Section
|
||||
|
||||
The JSON section is useful for developers to view the raw order data in JSON format. Developers can use this section to debug and troubleshoot issues related to the order.
|
||||
|
||||
To view the JSON structure, click the <InlineIcon Icon={ArrowUpRightOnBox} alt="Expand" /> icon.
|
||||
|
||||
---
|
||||
|
||||
## Edit Draft Order's Sales Channel
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Manage Draft Order's Items
|
||||
|
||||
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.
|
||||
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:
|
||||
- **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.
|
||||
- To remove an item, click the <InlineIcon Icon={PencilSquare} alt="pencil" /> button in the item's row, then set the item's quantity to zero. This will remove the item from the draft order.
|
||||
5. Once you're done, click the "Save" button.
|
||||
|
||||
The items in the Summary section will be updated accordingly.
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Manage Draft Order's Promotions
|
||||
|
||||
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.
|
||||
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.
|
||||
- To remove a promotion, click the <InlineIcon Icon={XMark} alt="x-mark" /> icon next to the promotion you want to remove.
|
||||
5. Once you're done, click the "Save" button.
|
||||
|
||||
The Summary section will be updated accordingly with the discount changes.
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Manage Draft Order's Shipping Methods
|
||||
|
||||
To manage the shipping methods of a draft order:
|
||||
|
||||
1. Go to the draft order's details page.
|
||||
2. In the Shipping section, click on the "Add shipping" or "Edit shipping" button.
|
||||
3. In the form that opens, you can perform the following steps to manage the shipping methods of every shipping profile:
|
||||
- To add a shipping option, click the "Add shipping option" button for the shipping profile.
|
||||
- In the form that opens, set the following information:
|
||||
- **Location**: Choose the location to ship the items from. This will affect the available shipping options.
|
||||
- **Shipping option**: After choosing a location, select a shipping option from that location that will be used to ship the items.
|
||||
- **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.
|
||||
4. Once you're done managing the shipping methods, click the "Save" button.
|
||||
|
||||
The Shipping section will be updated accordingly.
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Manage Draft Order's Customer Details
|
||||
|
||||
### Transfer Draft Order to Another Customer
|
||||
|
||||
If you've associated the draft order with a customer in your store, you can transfer the draft order to another existing customer.
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
|
||||
|
||||
### Edit Email
|
||||
|
||||
The draft order has an associated email address that is used to send order updates to the customer.
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
Updates related to the order will be sent to the new email address.
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Edit Draft Order's Shipping 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.
|
||||
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.
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Edit Draft Order's Billing Address
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Manage Draft Order's Metadata
|
||||
|
||||
Metadata is custom data that can be associated with the draft order in key-value pairs. This is usually used by developers for custom integrations or to store additional information about the draft order.
|
||||
|
||||
When the draft order is converted to an order, the metadata will be carried over to the order.
|
||||
|
||||
To edit the draft order's metadata:
|
||||
|
||||
1. Click the <InlineIcon Icon={ArrowUpRightOnBox} alt="arrow" /> icon at the right of 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.
|
||||
- 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.
|
||||
- Choose "Delete row" from the dropdown.
|
||||
3. Once you're done, click the Save button.
|
||||
|
||||
---
|
||||
|
||||
## Convert Draft Order to Regular Order
|
||||
|
||||
Once you're done managing the draft order and it is ready to be processed, you can convert it to a regular order.
|
||||
|
||||
<Note title="Important">
|
||||
|
||||
This action can't be undone. If you convert the draft order to a regular order by mistake, you can [cancel the order](../../manage/page.mdx#cancel-an-order).
|
||||
|
||||
</Note>
|
||||
|
||||
To convert the draft order to a regular order:
|
||||
|
||||
1. Go to the draft order's details page.
|
||||
2. In the Summary section of the draft order's details page, click the "Convert to order" button.
|
||||
3. Confirm converting the draft order by clicking the "Confirm" button in the pop-up.
|
||||
|
||||
You'll then be redirected to the order's details page. Learn more about it in the [Manage Orders](../../manage/page.mdx) guide.
|
||||
|
||||
---
|
||||
|
||||
## Delete Draft Order
|
||||
|
||||
<Note type="warning">
|
||||
|
||||
Deleting a draft order is irreversible.
|
||||
|
||||
</Note>
|
||||
|
||||
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.
|
||||
3. Choose "Delete draft order" from the dropdown menu.
|
||||
@@ -0,0 +1,44 @@
|
||||
---
|
||||
sidebar_position: 9
|
||||
sidebar_label: "Draft Orders"
|
||||
tags:
|
||||
- user guide
|
||||
- order
|
||||
products:
|
||||
- order
|
||||
---
|
||||
|
||||
export const metadata = {
|
||||
title: `Draft Orders in Medusa Admin`,
|
||||
}
|
||||
|
||||
# {metadata.title}
|
||||
|
||||
<Note title="Prerequisite">
|
||||
|
||||
If you're using a version earlier than v2.10.0, you must [install the Draft Orders Plugin manually](!resources!/commerce-modules/order/draft-orders). Your technical team should handle the plugin installation.
|
||||
|
||||
</Note>
|
||||
|
||||
The Draft Orders section of the Medusa Admin allows you to create and manage draft orders on behalf of customers.
|
||||
|
||||
Draft orders are useful for handling customer support scenarios or when a customer places an order offline, such as over the phone or in-store.
|
||||
|
||||
You can view the list of available draft orders in your commerce store by clicking on Orders -> Drafts from the sidebar menu.
|
||||
|
||||
|
||||
|
||||
In the list, you can see draft order details such as the ID, date, customer, sales channel, and region. You can also search, filter, and sort the orders to find the specific draft order you are looking for.
|
||||
|
||||
<Note title="Tip">
|
||||
|
||||
Find tips for using lists effectively in [this guide](../../tips/lists/page.mdx).
|
||||
|
||||
</Note>
|
||||
|
||||
---
|
||||
|
||||
## Manage Draft Orders
|
||||
|
||||
- [Create Draft Orders](./create/page.mdx)
|
||||
- [Manage Draft Orders](./manage/page.mdx)
|
||||
Reference in New Issue
Block a user