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
@@ -125,14 +125,15 @@ To create a shipping option:
|
||||
- If you chose Fixed, you'll set the price in the next step of the form.
|
||||
- If you choose Calculated and the fulfillment provider you choose doesn't support calculated prices, the shipping option creation will fail.
|
||||
- In the Name field, enter a name for the shipping option. Customers will see this option during checkout.
|
||||
- In the Shipping Profile field, choose the shipping profile that this option can be used for. Only products belonging to this shipping profile can be shipped with this shipping option.
|
||||
- In the Shipping Profile field, choose the [shipping profile](../shipping-profiles/page.mdx) that this option can be used for. Only products belonging to this shipping profile can be shipped with this shipping option.
|
||||
- In the Shipping Option Type field, choose the [shipping option type](../shipping-option-types/page.mdx) that this option belongs to. Shipping option types are useful to group similar shipping options together, allowing you to apply promotions at a group level.
|
||||
- In the Fulfillment Provider field, choose the fulfillment provider that will handle shipping orders using this option.
|
||||
- If you don't find the fulfillment provider you're looking for, make sure it's [added to the location](#manage-fulfillment-providers).
|
||||
- In the Fulfillment Option field, choose a fulfillment option from the fulfillment provider. For example, UPS may provide express or standard fulfillment options.
|
||||
- If you're unsure about which fulfillment option to choose, contact your technical team for assistance based on the integrated [fulfillment service](!resources!/commerce-modules/fulfillment/fulfillment-provider).
|
||||
- If you don't want this shipping option to be used by customers during checkout, disable the "Enable in store" toggle. This is useful if you're creating a shipping option that's only used internally.
|
||||
|
||||
|
||||
|
||||
|
||||
If you chose a "Calculated" price type, you can click the "Save" button to create the shipping option. Otherwise click Continue to proceed to the Prices step.
|
||||
|
||||
@@ -235,10 +236,16 @@ To edit a shipping option's details:
|
||||
1. Go to the location's details page.
|
||||
2. In the "Pickup" or "Shipping" sections, find the shipping option and click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at its right.
|
||||
3. Choose "Edit option" from the dropdown.
|
||||
4. In the side window that opens, you can edit the shipping option's price type, name, shipping profile, and whether it's enabled in store for customers to use.
|
||||
4. In the side window that opens, you can edit the shipping option's price type, name, shipping profile, shipping option type, and whether it's enabled in store for customers to use.
|
||||
5. Once you're done, click the Save button.
|
||||
|
||||
|
||||
<Note>
|
||||
|
||||
You can't edit a shipping option's fulfillment provider or fulfillment option after its creation.
|
||||
|
||||
</Note>
|
||||
|
||||
|
||||
|
||||
### Edit Shipping Option Prices
|
||||
|
||||
|
||||
@@ -27,9 +27,11 @@ A stock location:
|
||||
|
||||
A shipping profile groups similar products that require a different way of fulfillment. For example, fragile products are fulfilled differently than normal products. You can then provide shipping options specific for products that belong to the Fragile shipping profile.
|
||||
|
||||
A shipping option type groups shipping options with similar characteristics. For example, you can group all express shipping options together and apply a promotion to all of them at once.
|
||||
|
||||
To view location and shipping settings, go to Settings → Locations & Shipping.
|
||||
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
@@ -37,3 +39,4 @@ To view location and shipping settings, go to Settings → Locations & Shipping.
|
||||
|
||||
- [Manage Locations](./locations/page.mdx)
|
||||
- [Manage Shipping Profiles](./shipping-profiles/page.mdx)
|
||||
- [Manage Shipping Option Types](./shipping-option-types/page.mdx)
|
||||
+107
@@ -0,0 +1,107 @@
|
||||
---
|
||||
sidebar_position: 9
|
||||
sidebar_label: "Manage Shipping Option Types"
|
||||
tags:
|
||||
- user guide
|
||||
- fulfillment
|
||||
products:
|
||||
- fulfillment
|
||||
---
|
||||
|
||||
import { EllipsisHorizontal } from "@medusajs/icons"
|
||||
|
||||
export const metadata = {
|
||||
title: `Manage Shipping Option Types in Medusa Admin`,
|
||||
}
|
||||
|
||||
# {metadata.title}
|
||||
|
||||
In this guide, you’ll learn what shipping option types are and how to manage them in the Medusa Admin.
|
||||
|
||||
<Note>
|
||||
|
||||
The settings page for Shipping Option Types was added in [Medusa v2.10.0](https://github.com/medusajs/medusa/releases/tag/v2.10.0).
|
||||
|
||||
</Note>
|
||||
|
||||
## What is a Shipping Option Type?
|
||||
|
||||
A shipping option type is a classification of shipping options that share similar characteristics. For example, you can have a shipping option type for "Standard Shipping" and another for "Express Shipping".
|
||||
|
||||
Shipping option types help you organize and manage your shipping options. They also allow you to set promotions for specific types of shipping options.
|
||||
|
||||
By default, Medusa comes with two shipping option types: "Standard" and "Express". You can manage these types or create new ones to better fit your business needs.
|
||||
|
||||
---
|
||||
|
||||
## View Shipping Option Types
|
||||
|
||||
To view shipping option types in your store:
|
||||
|
||||
1. Go to Settings → Location & Shipping.
|
||||
2. In the Shipping Configuration section, click on Shipping Option Types.
|
||||
|
||||
Here, you can see a list of all the shipping option types you have set up in your store. You can also search, filter, and sort the shipping option types to find the one you are looking for.
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Create Shipping Option Type
|
||||
|
||||
To create a shipping option type:
|
||||
|
||||
1. Go to Settings → Location & Shipping.
|
||||
2. In the Shipping Configuration section, click on Shipping Option Types.
|
||||
3. Click the Create button at the top right.
|
||||
4. In the form that opens, enter the following information:
|
||||
- **Label**: The name of the shipping option type that can be displayed to customers. For example, "Same Day".
|
||||
- **Code**: A unique identifier for the shipping option type. For example, `same_day`.
|
||||
- **Description**: A brief description of the shipping option type. This is optional but can be helpful to provide more context about the type. For example, "Delivery within the same day".
|
||||
5. Once you're done, click the Create button at the bottom right.
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## View Shipping Option Type Details
|
||||
|
||||
To view the details of a shipping option type:
|
||||
|
||||
1. Go to Settings → Shipping Option Types.
|
||||
2. Click on the shipping option type you want to view.
|
||||
|
||||
This opens the shipping option type's details page, where you can also manage the shipping option type.
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Edit Shipping Option Type Details
|
||||
|
||||
To edit the details of a shipping option type:
|
||||
|
||||
1. Go to the shipping option type's details page.
|
||||
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> button in the top right corner of the first section.
|
||||
3. Select "Edit" from the dropdown menu.
|
||||
4. In the side window that opens, you can edit the shipping option type's label, code, and description.
|
||||
5. Once you're done, click the Save button.
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Delete Shipping Option Type
|
||||
|
||||
<Note type="warning">
|
||||
|
||||
Deleting a shipping option type is irreversible.
|
||||
|
||||
</Note>
|
||||
|
||||
To delete a shipping option type:
|
||||
|
||||
1. Go to the shipping option type's details page.
|
||||
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> button in the top right corner of the first section.
|
||||
3. Select "Delete" from the dropdown menu.
|
||||
4. Confirm the deletion of the shipping option type in the pop-up.
|
||||
@@ -7,7 +7,7 @@ products:
|
||||
- product
|
||||
---
|
||||
|
||||
import { EllipsisHorizontal } from "@medusajs/icons"
|
||||
import { EllipsisHorizontal, ArrowUpRightOnBox, EllipsisVertical } from "@medusajs/icons"
|
||||
|
||||
export const metadata = {
|
||||
title: `Manage Product Tags in Medusa Admin`,
|
||||
@@ -47,9 +47,9 @@ To view the details of a product tag:
|
||||
1. Go to Settings → Product Tags.
|
||||
2. Click on a product tag from the list.
|
||||
|
||||
This opens the product tag's details page where you can also manage the product tag.
|
||||
This opens the product tag's details page where you can also manage the product tag and its metadata.
|
||||
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
@@ -73,6 +73,31 @@ You can manage the tag of a product in the [product's details page](../../produc
|
||||
|
||||
---
|
||||
|
||||
## Manage Product Tag Metadata
|
||||
|
||||
<Note>
|
||||
|
||||
Management of product tag metadata was added in [Medusa v2.10.0](https://github.com/medusajs/medusa/releases/tag/v2.10.0).
|
||||
|
||||
</Note>
|
||||
|
||||
Metadata is custom data that can be associated with the product tag in key-value pairs. This is usually used by developers for custom integrations or to store additional information about the product tag.
|
||||
|
||||
To edit the product tag'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={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.
|
||||
3. Once you're done, click the Save button.
|
||||
|
||||
---
|
||||
|
||||
## Delete Product Tag
|
||||
|
||||
<Note type="warning">
|
||||
|
||||
@@ -20,9 +20,9 @@ In this guide, you'll learn what tax regions are and how to manage them.
|
||||
|
||||
## What is a Tax Region?
|
||||
|
||||
A Tax Region represents a geographical area where you have to apply specific tax rates. For example, if you operate in the United States and Canada, you might have different tax rates for each country, and even in different states or provinces of each country.
|
||||
A Tax Region represents a geographical area where you must apply specific tax rates. For example, if you operate in the United States and Canada, you might have different tax rates for each country, and even in different states or provinces within each country.
|
||||
|
||||
In this case, you can create a tax region for each country you operate in and set up [sublevel tax regions](#sublevel-tax-regions) for each state or province in the country.
|
||||
In this case, you can create a tax region for each country you operate in and set up [sublevel tax regions](#sublevel-tax-regions) for each state or province within the country.
|
||||
|
||||
Each tax region has its own tax rate, and you can override the default tax rate in a region for specific products or product types.
|
||||
|
||||
@@ -58,7 +58,7 @@ To view the details of a tax region:
|
||||
1. Go to Settings → Tax Regions.
|
||||
2. Click on a tax region from the list.
|
||||
|
||||
This opens the tax region's details page where you can also manage the tax region.
|
||||
This opens the tax region's details page, where you can also manage the tax region.
|
||||
|
||||
|
||||
|
||||
@@ -80,10 +80,10 @@ To edit a tax region:
|
||||
|
||||
## Edit Default Tax Rate
|
||||
|
||||
To edit the default tax rate of the region:
|
||||
To edit the default tax rate of a region:
|
||||
|
||||
1. Go to the tax region's details page.
|
||||
2. In the first section, you'll find details of the default tax rate, including its tax rate and code. Click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at its right.
|
||||
2. In the first section, you'll find details of the default tax rate, including its tax rate and code. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at its right.
|
||||
|
||||
|
||||
|
||||
@@ -97,7 +97,7 @@ To edit the default tax rate of the region:
|
||||
|
||||
## Manage Tax Rate Overrides
|
||||
|
||||
You can override the default tax rate of a region for specific products or product types. This is useful when you have different tax rates for certain products or product types in a region.
|
||||
You can override the default tax rate of a region for specific products, product types, or shipping options. This is useful if you have different tax rates for certain products or shipping options in a region.
|
||||
|
||||
You can override tax rates for tax regions and [sublevel tax regions](#sublevel-tax-regions).
|
||||
|
||||
@@ -110,9 +110,9 @@ To create a tax rate override for a product or product type in a tax region:
|
||||
3. In the form that opens:
|
||||
- Enter the tax override's name, rate, and code in their respective fields.
|
||||
- If the override should be combined with the default tax rate, enable the "Combinable" toggle.
|
||||
- Under the "Targets" section, you can select which products or product types this override applies to. You can add a target by clicking "Add target". For each target:
|
||||
- Choose the target type (Product or Product Type).
|
||||
- Choose the product or product types that the override applies to, based on the target type you chose.
|
||||
- Under the "Targets" section, you can select the target of this override. You can add a target by clicking "Add target". For each target:
|
||||
- Choose the target type (Product, Product Type, or Shipping Option).
|
||||
- Choose the product, product type, or shipping option that the override applies to, based on the target type you chose.
|
||||
4. Once you're done, click the Save button.
|
||||
|
||||
|
||||
@@ -148,11 +148,11 @@ To delete a tax rate override:
|
||||
|
||||
## Sublevel Tax Regions
|
||||
|
||||
Tax regions for some countries like the United States have a States, Province, or Cantons section in the tax region details page. Here, you can add sublevel regions for the country.
|
||||
Tax regions for some countries, like the United States, have a States, Province, or Cantons section in the tax region details page. Here, you can add sublevel regions for the country.
|
||||
|
||||
|
||||
|
||||
You can also enable it for other countries that don't show this section by default. For those countries, you'll find a note at the top of the page where you can enable the sublevel regions.
|
||||
You can also enable it for other countries that don't show this section by default. For those countries, you'll find a note at the top of the page where you can enable sublevel regions.
|
||||
|
||||
|
||||
|
||||
@@ -168,7 +168,7 @@ To create a sublevel tax region in a tax region:
|
||||
- If the country supports a sublevel by default, you'll find an input to select a state, province, or canton.
|
||||
- If the country doesn't support a sublevel by default, you'll find an input to enter the lower-case [ISO 3166-2 code](https://en.wikipedia.org/wiki/ISO_3166-2) of the sublevel.
|
||||
- Under the "Default tax rate" section, you can optionally enter a name, tax rate, and tax code in their respective fields.
|
||||
- If the tax region's rates should be combined with the parent's rates, enable the "Combinable" toggle.
|
||||
- If the sublevel tax region's rates should be combined with the parent's rates, enable the "Combinable" toggle.
|
||||
4. Once you're done, click the Save button.
|
||||
|
||||
|
||||
@@ -180,7 +180,7 @@ To view the details of a sublevel tax region:
|
||||
1. Go to the tax region's details page.
|
||||
2. Under the "Sublevels" section or its equivalent, click on a sublevel tax region.
|
||||
|
||||
This opens the sublevel tax region's details page where you can also manage the sublevel tax region.
|
||||
This opens the sublevel tax region's details page, where you can also manage the sublevel tax region.
|
||||
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user