docs: many improvements to settings user guides (#11536)
* docs: many improvements to settings user guides * fix build errors
This commit is contained in:
Shahed Nasser
GitHub
@@ -32,7 +32,7 @@ To create an inventory item:
|
||||
- Optionally add the inventory item's attributes, including width, length, height, weight, MID code, HS code, country of origin, and material.
|
||||
- Once you're done, click the Next button.
|
||||
2. Availability step using the [Bulk Editor](../../tips/bulk-editor/page.mdx):
|
||||
- If you have locations in your store, which you can create in [Settings](../../settings/locations/page.mdx), you can specify the inventory item's quantity in each location.
|
||||
- If you have locations in your store, which you can create in [Settings](../../settings/locations-and-shipping/locations/page.mdx), you can specify the inventory item's quantity in each location.
|
||||
4. Once you're done, click the Save button.
|
||||
|
||||
|
||||
|
||||
@@ -31,4 +31,4 @@ Find tips to use lists effectively in [this guide](../tips/lists/page.mdx).
|
||||
- [Manage Inventory](./inventory/page.mdx)
|
||||
- [Manage Reservations](./reservations/page.mdx)
|
||||
|
||||
You can also manage locations under [Settings](../settings/locations/page.mdx).
|
||||
You can also manage stock locations under [Settings](../settings/locations-and-shipping/locations/page.mdx).
|
||||
@@ -91,7 +91,7 @@ In the third "Variants" step, you can manage the product's variants you added in
|
||||
- Price columns that have the <InlineIcon Icon={TaxExclusive} alt="tax-exclusive" /> icon are tax-exclusive prices. Medusa will calculate taxes during checkout and add them to this price.
|
||||
- Price columns that have the <InlineIcon Icon={TaxInclusive} alt="tax-inclusive" /> icon are tax-inclusive prices. Medusa will calculate taxes during checkout as part of this price.
|
||||
|
||||
Tax-inclusive pricing is configured in the [currency's](../../settings/store/page.mdx) or [region's](../../settings/regions/page.mdx) settings.
|
||||
Tax-inclusive pricing is configured in the [currency's](../../settings/store/page.mdx#edit-tax-inclusive-setting-for-currency) or [region's](../../settings/regions/page.mdx#tax-inclusive-pricing-for-regions) settings.
|
||||
|
||||
</Note>
|
||||
|
||||
|
||||
@@ -58,7 +58,7 @@ You can create a variant to be multi-part or a bundle, as explained in [this gui
|
||||
- Price columns that have the <InlineIcon Icon={TaxExclusive} alt="tax-exclusive" /> icon are tax-exclusive prices. Medusa will calculate taxes during checkout and add them to this price.
|
||||
- Price columns that have the <InlineIcon Icon={TaxInclusive} alt="tax-inclusive" /> icon are tax-inclusive prices. Medusa will calculate taxes during checkout as part of this price.
|
||||
|
||||
Tax-inclusive pricing is configured in the [currency's](../../settings/store/page.mdx) or [region's](../../settings/regions/page.mdx) settings.
|
||||
Tax-inclusive pricing is configured in the [currency's](../../settings/store/page.mdx#edit-tax-inclusive-setting-for-currency) or [region's](../../settings/regions/page.mdx#tax-inclusive-pricing-for-regions) settings.
|
||||
|
||||
</Note>
|
||||
|
||||
@@ -95,7 +95,7 @@ To edit the prices of product variants:
|
||||
- Price columns that have the <InlineIcon Icon={TaxExclusive} alt="tax-exclusive" /> icon are tax-exclusive prices. Medusa will calculate taxes during checkout and add them to this price.
|
||||
- Price columns that have the <InlineIcon Icon={TaxInclusive} alt="tax-inclusive" /> icon are tax-inclusive prices. Medusa will calculate taxes during checkout as part of this price.
|
||||
|
||||
Tax-inclusive pricing is configured in the [currency's](../../settings/store/page.mdx) or [region's](../../settings/regions/page.mdx) settings.
|
||||
Tax-inclusive pricing is configured in the [currency's](../../settings/store/page.mdx#edit-tax-inclusive-setting-for-currency) or [region's](../../settings/regions/page.mdx#tax-inclusive-pricing-for-regions) settings.
|
||||
|
||||
</Note>
|
||||
|
||||
|
||||
@@ -0,0 +1,290 @@
|
||||
---
|
||||
sidebar_position: 7
|
||||
sidebar_label: "Locations"
|
||||
---
|
||||
|
||||
import { EllipsisHorizontal, TaxExclusive, TaxInclusive } from "@medusajs/icons"
|
||||
|
||||
export const metadata = {
|
||||
title: `Manage Locations`,
|
||||
}
|
||||
|
||||
# {metadata.title}
|
||||
|
||||
In this guide, you’ll learn how to manage the stock locations using the Medusa Admin.
|
||||
|
||||
## What is a Stock Location?
|
||||
|
||||
A location represents a physical stocking location, such as a warehouse. You can then manage [inventory item](../../../inventory/inventory/page.mdx) quantities in those locations.
|
||||
|
||||
For each location, you can specify the sales channels it's associated with, the fulfillment providers available in that location, and the shipping options available from that location.
|
||||
|
||||
Then, during checkout, a customer can only choose shipping options available from the location associated with the sales channel they're ordering from. After they place the order, the items are fulfilled from the stock location associated with the order's sales channel.
|
||||
|
||||
---
|
||||
|
||||
## Create Location
|
||||
|
||||
To create a stock location:
|
||||
|
||||
1. Go to Settings → Locations & Shipping.
|
||||
2. Click the Create button at the top right.
|
||||
3. In the form that opens:
|
||||
- Enter the location's name, such as "Main Warehouse".
|
||||
- Enter the address details. It's only required to enter an address line and choose a country.
|
||||
4. Once you're done, click the Save button.
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## View Location Details
|
||||
|
||||
To view the details of a location:
|
||||
|
||||
1. Go to Settings → Locations.
|
||||
2. Click on "View details" at the top right of the location's section.
|
||||
|
||||
This opens the location's details page where you can also manage the location.
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Edit Location
|
||||
|
||||
To edit a stock location:
|
||||
|
||||
1. Open the location's details page.
|
||||
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the top right of the first section.
|
||||
3. Choose Edit from the dropdown.
|
||||
4. In the side window that opens, you can edit the location's name and address details.
|
||||
5. Once you're done, click the Save button.
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Create Shipping Options
|
||||
|
||||
A location can have shipping options for the pickup and shipping modes. You can manage these options from the location's details page.
|
||||
|
||||
Shipping options are organized by service zones in each shipping mode. A service zone is a geographical area where you can specify the shipping options available. For example, you can create a service zone for the United States, and specify the shipping options available in the US.
|
||||
|
||||
So, to create a shipping option for either pick-up or shipping, you need to enable the pick-up or shipping mode, create a service zone for that mode, and create the shipping option within that zone.
|
||||
|
||||
### 1. Enable Shipping Mode
|
||||
|
||||
By default, pick-up and shipping are disabled in a location. To enable either:
|
||||
|
||||
1. Go to the location's details page.
|
||||
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the top right of the "Pickup" or "Shipping" section.
|
||||
3. Choose Enable from the dropdown.
|
||||
|
||||
You can also disable the shipping mode by following the same steps.
|
||||
|
||||
### 2. Create Service Zone
|
||||
|
||||
To ceate a service zone for pick-up or shipping:
|
||||
|
||||
1. Go to the location's details page.
|
||||
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the top right of the "Pickup" or "Shipping" section.
|
||||
3. Choose "Create service zone" from the dropdown.
|
||||
4. In the form that opens:
|
||||
- In the Name field, enter the name of the service zone. For example, "United States".
|
||||
- Under the Areas section, you'll choose the countries that are covered by this service zone:
|
||||
- Click the "Manage areas" button.
|
||||
- Check the countries to add to the service zone.
|
||||
- Click the Save button.
|
||||
5. Once you're done, click the Save button.
|
||||
|
||||
|
||||
|
||||
Learn how you can further manage this service zone in the [Manage Service Zones section](#manage-service-zones).
|
||||
|
||||
### 3. Create Shipping Options
|
||||
|
||||
You can now add shipping options to the service zone you created. You can either add a standard shipping option that's used during checkout, or a return shipping option, which is only used to return items from the customer.
|
||||
|
||||
To create a shipping option:
|
||||
|
||||
1. Go to the location's details page.
|
||||
2. In the "Pickup" or "Shipping" section, find the service zone you want to add the shipping option to.
|
||||
3. Click the "Create option" at the right of either "Shipping options" or "Return options", based on the type of shipping option you're creating.
|
||||
4. In the form that opens:
|
||||
- For the "Price type", chose **Fixed** if you want to apply fixed pricing for the shipping option, or **Calculated** if the price should be calculated dynamically during checkout. Calculated prices are useful if you're using a third-party fulfillment provider that calculates prices dynamically.
|
||||
- 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 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.
|
||||
- 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.
|
||||
|
||||
In the Prices step, use the [Bulk Editor](../../../tips/bulk-editor/page.mdx) to enter the shipping option's prices for every currency and region in your store. Once you're done, click the Save button.
|
||||
|
||||
Learn how you can further manage the shipping option in the [Manage Shipping Options section](#manage-shipping-options).
|
||||
|
||||
<Note title="Tips">
|
||||
|
||||
- Price columns that have the <InlineIcon Icon={TaxExclusive} alt="tax-exclusive" /> icon are tax-exclusive prices. Medusa will calculate taxes during checkout and add them to this price.
|
||||
- Price columns that have the <InlineIcon Icon={TaxInclusive} alt="tax-inclusive" /> icon are tax-inclusive prices. Medusa will calculate taxes during checkout as part of this price.
|
||||
|
||||
Tax-inclusive pricing is configured in the [currency's](../../store/page.mdx#edit-tax-inclusive-setting-for-currency) or [region's](../../regions/page.mdx#tax-inclusive-pricing-for-regions) settings.
|
||||
|
||||
</Note>
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Manage Service Zones
|
||||
|
||||
You can manage service zones in pick-up or shipping mode by [creating](#2-create-service-zone), editing, or deleting them.
|
||||
|
||||
### Edit Service Zone Details
|
||||
|
||||
To edit a service zone in a location:
|
||||
|
||||
1. Go to the location's details page.
|
||||
2. In the "Pickup" or "Shipping" sections, find the service zone and click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at its right.
|
||||
3. Choose Edit from the dropdown.
|
||||
4. In the side window that opens, you can edit the service zone's name.
|
||||
5. Once you're done, click the Save button.
|
||||
|
||||
|
||||
|
||||
### Manage Service Zone Areas
|
||||
|
||||
To manage the areas in a service zone:
|
||||
|
||||
1. Go to the location's details page.
|
||||
2. In the "Pickup" or "Shipping" sections, find the service zone and click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at its right.
|
||||
3. Choose "Manage areas" from the dropdown.
|
||||
4. In the form that opens, manage the areas in the service zone:
|
||||
- Click the "Manage areas" button.
|
||||
- Check the countries to add to the service zone, and uncheck the countries to remove from the service zone.
|
||||
- Click the Save button.
|
||||
5. Once you're done, click the Save button.
|
||||
|
||||
|
||||
|
||||
### Delete Service Zone
|
||||
|
||||
<Note type="warning">
|
||||
|
||||
Deleting a service zone is irreversible. It will delete all shipping options in the service zone.
|
||||
|
||||
</Note>
|
||||
|
||||
To delete a service zone:
|
||||
|
||||
1. Go to the location's details page.
|
||||
2. In the "Pickup" or "Shipping" sections, find the service zone and click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at its right.
|
||||
3. Choose Delete from the dropdown.
|
||||
4. Confirm deleting the service zone by clicking the Delete button in the pop-up.
|
||||
|
||||
---
|
||||
|
||||
## Manage Shipping Options
|
||||
|
||||
You can manage shipping options in pick-up and shipping modes by [creating](#create-shipping-options), editing, or deleting them.
|
||||
|
||||
### Edit Shipping Option Details
|
||||
|
||||
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.
|
||||
5. Once you're done, click the Save button.
|
||||
|
||||
|
||||
|
||||
### Edit Shipping Option Prices
|
||||
|
||||
To edit the prices of shipping options whose price type is Fixed:
|
||||
|
||||
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 prices" from the dropdown.
|
||||
4. In the [Bulk Editor](../../../tips/bulk-editor/page.mdx) that opens, you can edit the shipping option's price for every currency and region in your store.
|
||||
5. Once you're done, click the Save button.
|
||||
|
||||
<Note title="Tips">
|
||||
|
||||
- Price columns that have the <InlineIcon Icon={TaxExclusive} alt="tax-exclusive" /> icon are tax-exclusive prices. Medusa will calculate taxes during checkout and add them to this price.
|
||||
- Price columns that have the <InlineIcon Icon={TaxInclusive} alt="tax-inclusive" /> icon are tax-inclusive prices. Medusa will calculate taxes during checkout as part of this price.
|
||||
|
||||
Tax-inclusive pricing is configured in the [currency's](../../store/page.mdx#edit-tax-inclusive-setting-for-currency) or [region's](../../regions/page.mdx#tax-inclusive-pricing-for-regions) settings.
|
||||
|
||||
</Note>
|
||||
|
||||
|
||||
|
||||
### Delete Shipping Option
|
||||
|
||||
<Note type="warning">
|
||||
|
||||
Deleting a shipping option is irreversible.
|
||||
|
||||
</Note>
|
||||
|
||||
To delete a shipping option:
|
||||
|
||||
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 Delete from the dropdown.
|
||||
4. Confirm deleting the shipping option by entering its name in the pop-up and clicking the "Delete" button.
|
||||
|
||||
---
|
||||
|
||||
## Change Associated Sales Channels
|
||||
|
||||
To change the sales channels associated with a location:
|
||||
|
||||
1. Go to the location's details page.
|
||||
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the top right of the "Sales Channels" section.
|
||||
3. Choose Edit from the dropdown.
|
||||
4. In the list that opens, you can select the sales channels to associate with the location, or unselect the ones you want to remove.
|
||||
5. Once you're done, click the Save button.
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Manage Fulfillment Providers
|
||||
|
||||
To manage the fulfillment providers available in a location:
|
||||
|
||||
1. Go to the location's details page.
|
||||
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the top right of the "Fulfillment Providers" section.
|
||||
3. Choose Edit from the dropdown.
|
||||
4. In the list that opens, you can select the fulfillment providers to associate with the location, or unselect the ones you want to remove.
|
||||
5. Once you're done, click the Save button.
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Delete Location
|
||||
|
||||
<Note type="warning">
|
||||
|
||||
Deleting a location is irreversible and will delete its service zones and shipping options.
|
||||
|
||||
</Note>
|
||||
|
||||
To delete a location:
|
||||
|
||||
1. Open the location's details page.
|
||||
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the top right of the first section.
|
||||
3. Choose Delete from the dropdown.
|
||||
4. Confirm deleting the location by entering its name and clicking the Delete button.
|
||||
@@ -0,0 +1,28 @@
|
||||
import { EllipsisHorizontal } from "@medusajs/icons"
|
||||
|
||||
export const metadata = {
|
||||
title: `Locations & Shipping Overview`,
|
||||
}
|
||||
|
||||
# {metadata.title}
|
||||
|
||||
In the Locations & Shipping settings, you can manage stock locations and their shipping options, and other shipping-related configurations, such as shipping profiles.
|
||||
|
||||
A stock location:
|
||||
|
||||
- Is associated with sales channels. This is useful to fulfill orders from the location associated with the sales channel that the order was placed on.
|
||||
- Has fulfillment providers that can be used in that location. For example, you can use UPS in the United States and DHL in Europe.
|
||||
- Has shipping and pick up modes that you can add shipping options to. These are the shipping options used to fulfill items from this 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.
|
||||
|
||||
To view location and shipping settings, go to Settings → Locations & Shipping.
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Manage Location & Shipping Settings
|
||||
|
||||
- [Manage Locations](./locations/page.mdx)
|
||||
- [Manage Shipping Profiles](./shipping-profiles/page.mdx)
|
||||
@@ -0,0 +1,98 @@
|
||||
import { EllipsisHorizontal, ArrowUpRightOnBox, EllipsisVertical } from "@medusajs/icons"
|
||||
|
||||
export const metadata = {
|
||||
title: `Manage Shipping Profiles`,
|
||||
}
|
||||
|
||||
# {metadata.title}
|
||||
|
||||
In this guide, you’ll learn what shipping profiles are and how to manage them in the Medusa Admin.
|
||||
|
||||
## What is a Shipping Profile?
|
||||
|
||||
A shipping profile groups products with similar shipping requirements, allowing you to cater shipping options specifically for those products.
|
||||
|
||||
For example, if your store has fragile items that are shipped differently from other products, you can create a "Fragile" shipping profile and associate it with the fragile products. Then, you can [create shipping options](../locations/page.mdx#create-shipping-options) for fragile products, and options for other products.
|
||||
|
||||
---
|
||||
|
||||
## View Shipping Profiles
|
||||
|
||||
To view shipping profiles in your store:
|
||||
|
||||
1. Go to Settings → Location & Shipping.
|
||||
2. In the Shipping Configuration section, click on "Shipping Profiles".
|
||||
|
||||
Here, you can see a list of all the shipping profiles you have set up in your store. You can also search, filter, and sort the shipping profiles to find the one you are looking for.
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Create Shipping Profile
|
||||
|
||||
To create a shipping profile:
|
||||
|
||||
1. Go to Settings → Location & Shipping -> Shipping Profiles.
|
||||
2. Click the Create button at the top right.
|
||||
3. In the form that opens:
|
||||
- In the Name field, enter a name for the shipping profile. For example, "Fragile".
|
||||
- In the Type field, enter the type of products that belong to the shipping profile. For example, "fragile" or "heavy".
|
||||
4. Once you're done, click the Save button.
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## View Shipping Profile Details
|
||||
|
||||
To view the details of a shipping profile:
|
||||
|
||||
1. Go to Settings → Location & Shipping -> Shipping Profiles.
|
||||
2. Click on a shipping profile from the list.
|
||||
|
||||
This opens the shipping profile's details page where you can also manage the shipping profile.
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Manage Products of Shipping Profile
|
||||
|
||||
You can manage the shipping profile of a product in the [product's details page](../../../products/edit/page.mdx#edit-products-shipping-profile).
|
||||
|
||||
---
|
||||
|
||||
## Manage Shipping Profile Metadata
|
||||
|
||||
Metadata is custom data that can be associated with the shipping profile in key-value pairs. This is usually used by developers for custom integrations or to store additional information about the shipping profile.
|
||||
|
||||
To edit the shipping profile'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 Shipping Profile
|
||||
|
||||
<Note type="warning">
|
||||
|
||||
Deleting a shipping profile is irreversible.
|
||||
|
||||
</Note>
|
||||
|
||||
To delete a shipping profile:
|
||||
|
||||
1. Go to the shipping profile's details page.
|
||||
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the top right of the first section.
|
||||
3. Choose Delete from the dropdown.
|
||||
4. Confirm the deletion by entering the shipping profile's name in the pop-up and clicking the Delete button.
|
||||
@@ -1,79 +0,0 @@
|
||||
---
|
||||
sidebar_position: 7
|
||||
sidebar_label: "Locations"
|
||||
---
|
||||
|
||||
import { EllipsisHorizontal } from "@medusajs/icons"
|
||||
|
||||
export const metadata = {
|
||||
title: `Manage Locations`,
|
||||
}
|
||||
|
||||
# {metadata.title}
|
||||
|
||||
In this document, you’ll learn how to manage the locations using the Medusa Admin.
|
||||
|
||||
## Overview
|
||||
|
||||
A location represents a physical stocking location, such as a warehouse. It's associated with a sales channel.
|
||||
|
||||
When fulfilling an order, you can select the location to fulfill the items from. Similarly, when requesting or handling a return, you can select the location to return the item to. This automatically increments or decrements the quantity as necessary.
|
||||
|
||||
An [inventory item's](../../inventory/page.mdx) quantity is set per location.
|
||||
|
||||
---
|
||||
|
||||
## Create a Location
|
||||
|
||||
{/* TODO check info for correctness */}
|
||||
|
||||
To create a location:
|
||||
|
||||
1. Go to Settings → Locations.
|
||||
2. Click the Add Location button.
|
||||
3. In the form that opens:
|
||||
1. Enter the location's name and address details.
|
||||
2. To associate the location with one or more sales channel:
|
||||
1. Enable the Sales Channels field.
|
||||
2. Check the sales channels that the location is associated with.
|
||||
3. Under the Metadata section, you can add additional data as key-value pairs.
|
||||
4. Once you're done, click the "Add location" button.
|
||||
|
||||
---
|
||||
|
||||
## Edit a Location
|
||||
|
||||
To edit a location:
|
||||
|
||||
1. Go to Settings → Locations.
|
||||
2. Click on the location to edit.
|
||||
3. Choose Edit from the dropdown.
|
||||
4. In the drawer that opens, edit the location's details.
|
||||
5. Once you're done, click the Save button.
|
||||
|
||||
---
|
||||
|
||||
## Change Associated Sales Channel
|
||||
|
||||
{/* TODO check info for correctness */}
|
||||
|
||||
1. Go to Settings → Locations.
|
||||
2. Click on the location to edit.
|
||||
3. Under the Sales Channels section:
|
||||
1. To add a sales channel:
|
||||
1. Click the "Add sales channels" button at the top right.
|
||||
2. Check the sales channels you want to associate with the location.
|
||||
3. Once you're done, click the Save button.
|
||||
2. To delete a sales channel:
|
||||
1. Find in the list the sales channel to delete and click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at its right.
|
||||
2. Choose Delete from the dropdown.
|
||||
3. Confirm deleting the sales channel by clicking the Delete button.
|
||||
|
||||
---
|
||||
|
||||
## Delete a Location
|
||||
|
||||
1. Go to Settings → Locations.
|
||||
2. Find the location to edit and click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at its right.
|
||||
3. Choose Delete from the dropdown.
|
||||
4. Confirm deleting the location by entering its name and clicking the Delete button in the pop-up.
|
||||
@@ -25,12 +25,12 @@ You can also go back to the main sidebar by clicking the <InlineIcon Icon={Arrow
|
||||
- [Manage Store](./store/page.mdx)
|
||||
- [Manage Users](./users/page.mdx)
|
||||
- [Manage Regions](./regions/page.mdx)
|
||||
- [Manage Tax Regions](#)
|
||||
- [Manage Tax Regions](./tax-regions/page.mdx)
|
||||
- [Manage Return Reasons](./return-reasons/page.mdx)
|
||||
- [Manage Sales Channels](./sales-channels/page.mdx)
|
||||
- [Manage Product Types](#)
|
||||
- [Manage Product Tags](#)
|
||||
- [Manage Location & Shipping Settings](./locations/page.mdx)
|
||||
- [Manage Product Types](./product-types/page.mdx)
|
||||
- [Manage Product Tags](./product-tags/page.mdx)
|
||||
- [Manage Location & Shipping Settings](./locations-and-shipping/page.mdx)
|
||||
- [Manage Publishable API Keys](#)
|
||||
- [Manage Secret API Keys](#)
|
||||
- [Manage Workflow Executions](./developer/executions/page.mdx)
|
||||
|
||||
80
www/apps/user-guide/app/settings/product-tags/page.mdx
Normal file
80
www/apps/user-guide/app/settings/product-tags/page.mdx
Normal file
@@ -0,0 +1,80 @@
|
||||
import { EllipsisHorizontal } from "@medusajs/icons"
|
||||
|
||||
export const metadata = {
|
||||
title: `Manage Product Tags`,
|
||||
}
|
||||
|
||||
# {metadata.title}
|
||||
|
||||
In this guide, you’ll learn how to manage product tags in the Medusa Admin.
|
||||
|
||||
## View Product Tags
|
||||
|
||||
Product tags allow you to group products in your store by common tags. For example, you can create tags for "electronics" or "clothing" and assign them to products.
|
||||
|
||||
To view product tags in your store, go to Settings → Product Tags. Here, you can see a list of all the product tags you have set up in your store. You can also search, filter, and sort the product tags to find the one you are looking for.
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Create Product Tag
|
||||
|
||||
To create a product tag:
|
||||
|
||||
1. Go to Settings → Product Tags.
|
||||
2. Click the Create button at the top right.
|
||||
3. In the form that opens, enter a value for the product tag in the Value field. For example, "Digital".
|
||||
4. Once you're done, click the Create button.
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## View Product Tag Details
|
||||
|
||||
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.
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Edit Product Tag Details
|
||||
|
||||
To edit the details of a product tag:
|
||||
|
||||
1. Go to the product tag's details page.
|
||||
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the top right of the first section.
|
||||
3. Choose Edit from the dropdown.
|
||||
4. In the side window that opens, you can edit the product tag's value.
|
||||
5. Once you're done, click the Save button.
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Manage Products in Tag
|
||||
|
||||
You can manage the tag of a product in the [product's details page](../../products/edit/page.mdx#manage-product-organization).
|
||||
|
||||
---
|
||||
|
||||
## Delete Product Tag
|
||||
|
||||
<Note type="warning">
|
||||
|
||||
Deleting a product tag is irreversible.
|
||||
|
||||
</Note>
|
||||
|
||||
To delete a product tag:
|
||||
|
||||
1. Go to the product tag's details page.
|
||||
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the top right of the first section.
|
||||
3. Choose Delete from the dropdown.
|
||||
4. Confirm the deletion by clicking the Delete button in the pop-up.
|
||||
99
www/apps/user-guide/app/settings/product-types/page.mdx
Normal file
99
www/apps/user-guide/app/settings/product-types/page.mdx
Normal file
@@ -0,0 +1,99 @@
|
||||
import { EllipsisHorizontal, ArrowUpRightOnBox, EllipsisVertical } from "@medusajs/icons"
|
||||
|
||||
export const metadata = {
|
||||
title: `Manage Product Types`,
|
||||
}
|
||||
|
||||
# {metadata.title}
|
||||
|
||||
In this guide, you’ll learn how to manage product types in the Medusa Admin.
|
||||
|
||||
## View Product Types
|
||||
|
||||
Product types are useful to group products by a general type, such as "Physical" and "Digital" product types.
|
||||
|
||||
To view product types in your store, go to Settings → Product Types. Here, you can see a list of all the product types you have set up in your store. You can also search, filter, and sort the product types to find the one you are looking for.
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Create Product Type
|
||||
|
||||
To create a product type:
|
||||
|
||||
1. Go to Settings → Product Types.
|
||||
2. Click the Create button at the top right.
|
||||
3. In the form that opens, enter a value for the product type in the Value field. For example, "Digital".
|
||||
4. Once you're done, click the Create button.
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## View Product Type Details
|
||||
|
||||
To view the details of a product type:
|
||||
|
||||
1. Go to Settings → Product Types.
|
||||
2. Click on a product type from the list.
|
||||
|
||||
This opens the product type's details page where you can also manage the product type.
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Edit Product Type Details
|
||||
|
||||
To edit the details of a product type:
|
||||
|
||||
1. Go to the product type's details page.
|
||||
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the top right of the first section.
|
||||
3. Choose Edit from the dropdown.
|
||||
4. In the side window that opens, you can edit the product type's value.
|
||||
5. Once you're done, click the Save button.
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Manage Products in Type
|
||||
|
||||
You can manage the type of a product in the [product's details page](../../products/edit/page.mdx#manage-product-organization).
|
||||
|
||||
---
|
||||
|
||||
## Manage Product Type Metadata
|
||||
|
||||
Metadata is custom data that can be associated with the product type in key-value pairs. This is usually used by developers for custom integrations or to store additional information about the product type.
|
||||
|
||||
To edit the product type'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 Type
|
||||
|
||||
<Note type="warning">
|
||||
|
||||
Deleting a product type is irreversible.
|
||||
|
||||
</Note>
|
||||
|
||||
To delete a product type:
|
||||
|
||||
1. Go to the product type's details page.
|
||||
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the top right of the first section.
|
||||
3. Choose Delete from the dropdown.
|
||||
4. Confirm the deletion by clicking the Delete button in the pop-up.
|
||||
@@ -1,37 +0,0 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
sidebar_label: "Manage Countries"
|
||||
---
|
||||
|
||||
import { EllipsisHorizontal } from "@medusajs/icons"
|
||||
|
||||
export const metadata = {
|
||||
title: `Manage Countries in a Region`,
|
||||
}
|
||||
|
||||
# {metadata.title}
|
||||
|
||||
In this document, you'll learn how to manage countries in a region.
|
||||
|
||||
## Add Countries
|
||||
|
||||
To add a country to a region:
|
||||
|
||||
1. Go to Settings → Regions.
|
||||
2. Click on the region you want to edit.
|
||||
3. Under the Countries section, click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the top right.
|
||||
4. Choose "Add countries" from the dropdown.
|
||||
5. In the list that shows, check the checkboxes next to the countries you want to add.
|
||||
6. Once you're done, click the Save button.
|
||||
|
||||
---
|
||||
|
||||
## Remove Countries
|
||||
|
||||
To remove countries from a region:
|
||||
|
||||
1. Go to Settings → Regions.
|
||||
2. Click on the region you want to edit.
|
||||
3. Under the Countries section, check the checkbox next to the countries you want to remove.
|
||||
4. Once you're done, press <Kbd>R</Kbd>.
|
||||
5. Confirm removing the country by typing "Remove" in the field and clicking the Remove button in the pop-up.
|
||||
@@ -1,83 +0,0 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
import { EllipsisHorizontal } from "@medusajs/icons"
|
||||
|
||||
export const metadata = {
|
||||
title: `Manage Regions`,
|
||||
}
|
||||
|
||||
# {metadata.title}
|
||||
|
||||
In this document, you’ll learn how to view and manage regions in your Medusa Admin.
|
||||
|
||||
## View Regions
|
||||
|
||||
To view your regions, go to Settings → Regions. You'll find a list of available regions in your store.
|
||||
|
||||
---
|
||||
|
||||
## Create a Region
|
||||
|
||||
To create a region:
|
||||
|
||||
1. Go to Settings → Regions.
|
||||
2. Click the Create button.
|
||||
3. In the form that opens:
|
||||
1. Enter the region's name in the Name field.
|
||||
2. Choose the region's currency in the Currency field. If you can't find a currency, make sure to [add it to the store first](../../store/page.mdx#add-currencies).
|
||||
3. Enter the tax rate and, optionally, the tax code of the region.
|
||||
4. Enable the "Tax inclusive pricing" field to specify that all prices of that region include taxes.
|
||||
5. To add countries to the region:
|
||||
1. Click the "Add countries" button.
|
||||
2. In the list shown, check the checkbox next to the countries to add.
|
||||
3. Once you're done, click the Save button.
|
||||
6. Under the Providers section, select the available payment and fulfillment providers in the region.
|
||||
4. Once you’re done, click on the Save button.
|
||||
|
||||
---
|
||||
|
||||
## Edit a Region
|
||||
|
||||
To edit a region's details:
|
||||
|
||||
1. Go to Settings → Regions.
|
||||
2. Click on the region you want to edit.
|
||||
3. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the top right of the first section.
|
||||
4. Choose Edit from the dropdown.
|
||||
5. In the drawer that opens, edit the region's details.
|
||||
6. Once done, click the Save button.
|
||||
|
||||
---
|
||||
|
||||
## Edit Region's Tax Settings
|
||||
|
||||
When you create a region, taxes settings are created for that region as well.
|
||||
|
||||
To view and edit a region's tax settings:
|
||||
|
||||
1. Go to Settings → Regions.
|
||||
2. Click on the region you want to edit.
|
||||
3. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the top right of the first section.
|
||||
4. Choose "Tax settings" from the dropdown.
|
||||
|
||||
This opens the taxes page of the region. Learn more about managing taxes in [this guide](../../taxes/manage/page.mdx).
|
||||
|
||||
---
|
||||
|
||||
## Delete a Region
|
||||
|
||||
<Note type="warning">
|
||||
|
||||
Deleting a region is irreversible.
|
||||
|
||||
</Note>
|
||||
|
||||
To delete a region:
|
||||
|
||||
1. Go to Settings → Regions.
|
||||
2. Click on the region you want to delete.
|
||||
3. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the top right of the first section.
|
||||
4. Choose Delete from the dropdown.
|
||||
5. Confirm deleting the region by entering its name and clicking the Delete button in the pop-up.
|
||||
@@ -2,40 +2,147 @@
|
||||
sidebar_position: 4
|
||||
---
|
||||
|
||||
import { EllipsisHorizontal, ArrowUpRightOnBox, EllipsisVertical } from "@medusajs/icons"
|
||||
|
||||
export const metadata = {
|
||||
title: `Regions`,
|
||||
title: `Manage Regions`,
|
||||
}
|
||||
|
||||
# {metadata.title}
|
||||
|
||||
In this document, you’ll get an overview of regions and learn about their importance in your commerce store.
|
||||
In this guide, you’ll learn what regions are and how to manage them.
|
||||
|
||||
## Overview
|
||||
## What is a Region?
|
||||
|
||||
Regions are essential to your commerce store. You use regions to specify available currencies, payment providers, fulfillment providers, tax rates, and more for different regions.
|
||||
A Region represents different countries or areas that your commerce store serves customers in. A region can have multiple countries with the same settings, but a region can also be specific to a single country with its own settings.
|
||||
|
||||
Regions represent different countries that your commerce store serves customers in. A region can have multiple countries with the same settings, but a region can also be specific to a single country with its own settings.
|
||||
Each region has its own settings, such as currencies, payment providers, and fulfillment providers. You can set up regions to manage different aspects of your store based on the location of your customers.
|
||||
|
||||
### Tax-Inclusive Pricing for Regions
|
||||
|
||||
A region has a tax-inclusive pricing setting that determines how taxes are added to prices for the region. During checkout, after Medusa calculates the tax of a product or shipping, it will either:
|
||||
|
||||
- Add the tax to the product's price (tax-exclusive pricing).
|
||||
- Include the tax in the product's price (tax-inclusive pricing).
|
||||
|
||||
You can manage this setting during region creation or update.
|
||||
|
||||
---
|
||||
|
||||
## Currencies in Regions
|
||||
## View Regions
|
||||
|
||||
Each region uses one currency, and you can set prices across your store for each region.
|
||||
To view regions in your store, go to Settings → Regions. Here, you can see a list of all the regions you have set up in your store. You can also search, filter, and sort the regions to find the one you are looking for.
|
||||
|
||||
For example, when you create a product variant, you set the price of that variant for each currency and region in your store.
|
||||
|
||||
|
||||
---
|
||||
|
||||
## How Customers Use Regions
|
||||
## Create Region
|
||||
|
||||
When a customer browses your storefront, they choose the region based on their location. Then, the prices, shipping providers, payment providers, and taxes available and applied are based on the chosen region.
|
||||
To create a region:
|
||||
|
||||
For example, if you have Stripe enabled as a payment provider in a region created for the United States, but have it disabled in a region created for European countries, only customers in the United States region can use Stripe for payment on checkout.
|
||||
1. Go to Settings → Regions.
|
||||
2. Click the Create button at the top right.
|
||||
3. In the form that opens:
|
||||
- In the Name field, enter a name for the region. For example, "Europe".
|
||||
- In the Currency field, select the region's currency. A region can only have one currency.
|
||||
- If you don't want taxes to be calculated automatically during checkout, you can disable the "Automatic Taxes" toggle. This input is mostly useful for developers and should be administered by your technical team.
|
||||
- If you want to enable [tax-inclusive pricing](#tax-inclusive-pricing-for-regions), toggle the "Tax inclusive pricing" setting.
|
||||
- Under the Countries section, you can add the countries that are part of the region. To add countries:
|
||||
- Click the "Add countries" button.
|
||||
- Check the countries to add to the region.
|
||||
- Click the Save button.
|
||||
- In the Payment Providers field, choose the payment providers that customers in this region can use to pay for their orders.
|
||||
4. Once you're done, click the Save button.
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Learn More About Regions
|
||||
## View Region Details
|
||||
|
||||
- [Manage Regions](./manage/page.mdx)
|
||||
- [Manage Payment and Fulfillment Providers](./providers/page.mdx)
|
||||
- [Manage Shipping Options in a Region](./shipping-options/page.mdx)
|
||||
To view the details of a region:
|
||||
|
||||
1. Go to Settings → Regions.
|
||||
2. Click on the region you want to view.
|
||||
|
||||
This opens the region's details page where you can also manage the region.
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Edit Region Details
|
||||
|
||||
To edit a region's details:
|
||||
|
||||
1. Go to the region's details page.
|
||||
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the top right of the first section.
|
||||
3. Choose Edit from the dropdown.
|
||||
4. In the side window that opens, you can edit the region's name, currency, payment providers, and settings for automatic taxes and [tax-inclusive pricing](#tax-inclusive-pricing-for-regions).
|
||||
5. Once you're done, click the Save button.
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Manage Region's Countries
|
||||
|
||||
You can manage a region's countries to add or remove them from the region.
|
||||
|
||||
### Add Countries to Region
|
||||
|
||||
To add countries to a region:
|
||||
|
||||
1. Go to the region's details page.
|
||||
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the top right of the "Countries" section.
|
||||
3. Choose "Add countries" from the dropdown.
|
||||
4. In the list that opens, check the countries you want to add to the region.
|
||||
5. Once you're done, click the Add button.
|
||||
|
||||
### Remove Countries from Region
|
||||
|
||||
To remove countries from a region:
|
||||
|
||||
1. Go to the region's details page.
|
||||
2. Under the "Countries" section, check the countries you want to remove from the region.
|
||||
3. Press <Kbd>R</Kbd> or click the Remove button at the bottom center of the page.
|
||||
4. Confirm removing the country by typing "Remove" in the pop-up and clicking the Remove button.
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Manage Region Metadata
|
||||
|
||||
Metadata is custom data that can be associated with the region in key-value pairs. This is usually used by developers for custom integrations or to store additional information about the region.
|
||||
|
||||
To edit the region'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 Region
|
||||
|
||||
<Note type="warning">
|
||||
|
||||
Deleting a region is irreversible.
|
||||
|
||||
</Note>
|
||||
|
||||
To delete a region from your store:
|
||||
|
||||
1. Go to the region's details page.
|
||||
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the top right of the first section.
|
||||
3. Choose Delete from the dropdown.
|
||||
4. Confirm deleting the region by typing the region's name in the pop-up and clicking the Delete button.
|
||||
|
||||
@@ -1,29 +0,0 @@
|
||||
---
|
||||
sidebar_position: 3
|
||||
sidebar_label: Manage Providers
|
||||
---
|
||||
|
||||
import { EllipsisHorizontal } from "@medusajs/icons"
|
||||
|
||||
export const metadata = {
|
||||
title: `Manage Payment and Fulfillment Providers in a Region`,
|
||||
}
|
||||
|
||||
# {metadata.title}
|
||||
|
||||
In this document, you’ll learn how to manage a region’s payment and fulfillment providers in your Medusa Admin.
|
||||
|
||||
<Note>
|
||||
|
||||
Before customers can use your payment or fulfillment provider, you must add that provider to one or more region.
|
||||
|
||||
</Note>
|
||||
|
||||
To add or remove a payment or fulfillment provider in a region:
|
||||
|
||||
1. Go to Settings → Regions.
|
||||
2. Click on the region you want to edit.
|
||||
4. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the top right of the first section.
|
||||
4. Choose Edit from the dropdown.
|
||||
5. In the drawer that opens and under the Providers section, change the payment and fulfillment providers of the region.
|
||||
6. Once you're done, click the Save button.
|
||||
@@ -1,74 +0,0 @@
|
||||
---
|
||||
sidebar_position: 4
|
||||
sidebar_label: Manage Shipping Options
|
||||
---
|
||||
|
||||
import { EllipsisHorizontal } from "@medusajs/icons"
|
||||
|
||||
export const metadata = {
|
||||
title: `Manage Shipping Options in a Region`,
|
||||
}
|
||||
|
||||
# {metadata.title}
|
||||
|
||||
In this document, you’ll learn how to manage a region’s shipping options in your Medusa Admin.
|
||||
|
||||
## What is a Shipping Option?
|
||||
|
||||
A shipping option has two types:
|
||||
|
||||
- **Outbound**: these options are used in customers' orders. During checkout, a customer chooses one of these shipping options to receive their order. These shipping options are used when you create draft orders as well.
|
||||
- **Return**: these options are used when the customer returns an item, whether the return is requested by the customer or the admin user.
|
||||
|
||||
---
|
||||
|
||||
## Create a Shipping Option
|
||||
|
||||
To create a shipping option in a region:
|
||||
|
||||
1. Go to Settings → Regions.
|
||||
2. Under the Shipping Options section, click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the top right of the section.
|
||||
3. Choose Create from the dropdown.
|
||||
4. In the form that opens:
|
||||
1. Under the Type section, choose the shipping option's type.
|
||||
2. To only show and use the shipping option in the admin dashboard, enable the "Admin only" field.
|
||||
3. To specify that the shipping option's price is tax-inclusive, enable the "Tax inclusive pricing" field.
|
||||
4. Specify the shipping option's name in the Name field. This name is shown to customers if "Admin only" is disabled.
|
||||
5. For the Price Type field, specify the shipping option's price type:
|
||||
- **Flat rate**: The shipping option has a fixed price. In this case, you must enter the shipping option's price in the Price field.
|
||||
- **Calculated**: The shipping option's price is calculated, meaning that the amount is shown while placing the order or creating the return.
|
||||
6. For the Shipping Profile field, specify the profile of the items that this shipping option can be used with:
|
||||
- For gift cards, choose Gift Card Profile.
|
||||
- For all other products, choose Default Shipping Profile.
|
||||
7. For the Fulfillment Provider field, choose the region's fulfillment provider used to handle the fulfillment and shipping when this shipping option is used. If you can't find a fulfillment provider, make sure to [add it to the region first](../providers/page.mdx).
|
||||
8. Under the Requirements section, you can specify a minimum and maximum cart subtotal amount. When specified, the shipping option can only be used when this condition is met.
|
||||
5. Once you're done, click the Save button.
|
||||
|
||||
---
|
||||
|
||||
## Edit a Shipping Option
|
||||
|
||||
To edit a shipping option in a region:
|
||||
|
||||
1. Go to Settings → Regions.
|
||||
2. Under the Shipping Options section, find the shipping option to edit and click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> at its right.
|
||||
3. Choose Edit from the dropdown.
|
||||
4. In the drawer, edit any of the shipping option's details.
|
||||
5. Once you're done, click the Save button.
|
||||
|
||||
---
|
||||
|
||||
## Delete a Shipping Option
|
||||
|
||||
<Note type="warning">
|
||||
|
||||
Deleting a shipping option is irreversible.
|
||||
|
||||
</Note>
|
||||
|
||||
To delete a shipping option in a region:
|
||||
|
||||
1. Go to Settings → Regions.
|
||||
2. Under the Shipping Options section, find the shipping option to delete and click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> at its right.
|
||||
3. Choose Delete from the dropdown.
|
||||
4. Confirm deleting the shipping option by clicking the Delete button in the pop-up.
|
||||
@@ -11,13 +11,21 @@ export const metadata = {
|
||||
|
||||
# {metadata.title}
|
||||
|
||||
In this document, you’ll learn how to add, edit, and remove return reasons.
|
||||
In this guide, you’ll learn what return reasons are and how to manage them.
|
||||
|
||||
## What's a Return Reason?
|
||||
|
||||
A return reason is used when requesting a return or creating an exchange or claim. It's used to specify why an item is being returned.
|
||||
A return reason is useful when returning an item in an order. It's used to specify why an item is being returned. For example, a customer might return an item because it's damaged, the wrong size, or they changed their mind.
|
||||
|
||||
So, before you can handle returns, exchanges, and claims, you must create at least one return reason.
|
||||
To specify the return reason when creating a return, exchange, or claim, you can choose from a list of return reasons that you've set up in your settings.
|
||||
|
||||
---
|
||||
|
||||
## View Return Reasons
|
||||
|
||||
To view return reasons in your store, go to Settings → Return Reasons. Here, you can see a list of all the return reasons you have set up in your store. You can also search, filter, and sort the return reasons to find the one you are looking for.
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
@@ -27,12 +35,14 @@ To create a return reason:
|
||||
|
||||
1. Go to Settings → Return Reasons.
|
||||
2. Click the Create button at the top right.
|
||||
3. In the new form that opens, enter the reason's details:
|
||||
- The Label is used when showing the return reason to the customer or admin users.
|
||||
- The Value is used as a unique identifier internally.
|
||||
3. In the form that opens:
|
||||
- Enter in the Value field a unique identifier for the reason that's used internally. It's recommended to use only lowercase letters and underscores (`_`). For example, "damaged" or "wrong_size".
|
||||
- Enter in the Label field what is shown to customers or admin users.
|
||||
- You can optionally enter a description of the return reason in the Description field.
|
||||
4. Once done, click the Save button.
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Edit a Return Reason
|
||||
@@ -42,14 +52,16 @@ To edit a return reason:
|
||||
1. Go to Settings → Return Reasons.
|
||||
2. Find the return reason to edit and click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at its right.
|
||||
3. Choose Edit from the dropdown.
|
||||
4. In the drawer that opens, edit the return reason's details.
|
||||
4. In the side window that opens, you can edit the return reason's value, label, and description.
|
||||
5. Once you're done, click the Save button.
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Delete a Return Reason
|
||||
|
||||
<Note>
|
||||
<Note type="warning">
|
||||
|
||||
Deleting a return reason is irreversible.
|
||||
|
||||
|
||||
@@ -1,53 +0,0 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
import { EllipsisHorizontal } from "@medusajs/icons"
|
||||
|
||||
export const metadata = {
|
||||
title: `Manage Sales Channels`,
|
||||
}
|
||||
|
||||
# {metadata.title}
|
||||
|
||||
In this document, you’ll learn how to manage sales channels in your Medusa Admin.
|
||||
|
||||
## Create a Sales Channel
|
||||
|
||||
To create a sales channel:
|
||||
|
||||
1. Go to Settings → Sales Channels.
|
||||
2. Click the Create button.
|
||||
3. In the form that opens, enter the sales channel's details.
|
||||
4. Once you're done, click the Save button.
|
||||
|
||||
---
|
||||
|
||||
## Edit a Sales Channel
|
||||
|
||||
To edit a sales channel:
|
||||
|
||||
1. Go to Settings → Sales Channels.
|
||||
2. Find the sales channel in the list and click on it.
|
||||
3. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the top right of the first section.
|
||||
4. Choose Edit from the dropdown.
|
||||
5. In the drawer that opens, edit the sales channel's details.
|
||||
6. Once you're done, click the Save button.
|
||||
|
||||
---
|
||||
|
||||
## Delete a Sales Channel
|
||||
|
||||
<Note type="warning">
|
||||
|
||||
Deleting a sales channel is irreversible.
|
||||
|
||||
</Note>
|
||||
|
||||
To delete a sales channel:
|
||||
|
||||
1. Go to Settings → Sales Channels.
|
||||
2. Find the sales channel in the list and click on it.
|
||||
3. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the top right of the first section.
|
||||
4. Choose Delete from the dropdown.
|
||||
5. Confirm deleting the sales channel by entering its name in the field and clicking the Delete button in the pop-up.
|
||||
@@ -2,41 +2,134 @@
|
||||
sidebar_position: 8
|
||||
---
|
||||
|
||||
import { EllipsisHorizontal } from "@medusajs/icons"
|
||||
|
||||
export const metadata = {
|
||||
title: `Sales Channels`,
|
||||
title: `Manage Sales Channels`,
|
||||
}
|
||||
|
||||
# {metadata.title}
|
||||
|
||||
In this document, you’ll get an overview of sales channels in Medusa.
|
||||
In this guide, you’ll learn what sales channels are and how to manage them in the Medusa Admin.
|
||||
|
||||
## What is a Sales Channel?
|
||||
|
||||
A sales channel is a channel that you sell your products through. For example, you can have a sales channel for the web storefront, another for the mobile app, and another for selling across social media platforms.
|
||||
|
||||
By default, there’s a default sales channel in a Medusa store. You can add multiple sales channels.
|
||||
You can set a default sales channel in your [store settings](../store/page.mdx) that is used when no sales channel is specified. This is also useful if you're not selling through multiple channels.
|
||||
|
||||
### How Sales Channels Work
|
||||
|
||||
Sales channels are associated with other data and settings in your commerce store:
|
||||
|
||||
- You can choose which products are available in a sales channel. This is useful when you provide different products for different types of channels. For example, you can have a B2B sales channel and only make B2B products available in it.
|
||||
- When a customer places an order from a sales channel, the order is associated with it. This is useful if you're processing orders differently for each sales channel. For example, orders placed through an offline store are processed differently than through an online storefront.
|
||||
- Stock locations and shipping options are also associated with sales channels. So, when a customer places an order, the items are fulfilled from the stock location associated with the order's sales channel.
|
||||
|
||||
<Note title="Technical Tip">
|
||||
|
||||
{/* TODO add link */}
|
||||
|
||||
Developers can use [Publishable API Keys](#) to easily associate a storefront or client with a sales channel.
|
||||
|
||||
</Note>
|
||||
|
||||
---
|
||||
|
||||
## How Sales Channels Work
|
||||
## View Sales Channels
|
||||
|
||||
Sales channels are associated with data and settings in your commerce store:
|
||||
To view sales channels in your store, go to Settings → Sales Channels. Here, you can see a list of all the sales channels you have set up in your store. You can also search, filter, and sort the sales channels to find the one you are looking for.
|
||||
|
||||
- You can choose which products are available in a sales channel.
|
||||
- When a customer places an order from a sales channel, the order is associated with it.
|
||||
- Locations used with inventory are also associated with sales channels.
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Sales Channels Settings Overview
|
||||
## Create Sales Channel
|
||||
|
||||
To view the available sales channels and settings, go to Settings → Sales channels.
|
||||
To create a sales channel:
|
||||
|
||||
The sales channels settings page shows available sales channels and allows you to manage sales channels.
|
||||
1. Go to Settings → Sales Channels.
|
||||
2. Click the Create button at the top right.
|
||||
3. In the form that opens:
|
||||
- In the Name field, enter a name for the sales channel. For example, "Web Storefront".
|
||||
- In the Description field, enter a description of the sales channel.
|
||||
- If you don't want to enable the sales channel immediately, disable the "Enabled" toggle.
|
||||
4. Once you're done, click the Save button.
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Learn More About Sales Channels
|
||||
## View Sales Channel Details
|
||||
|
||||
- [Manage Sales Channels](./manage/page.mdx)
|
||||
- [Manage Products in Sales Channels](./products/page.mdx)
|
||||
To view the details of a sales channel:
|
||||
|
||||
1. Go to Settings → Sales Channels.
|
||||
2. Click on a sales channel from the list.
|
||||
|
||||
This opens the sales channel's details page where you can also manage the sales channel.
|
||||
|
||||
|
||||
|
||||
### Sales Channel Status
|
||||
|
||||
The status of a sales channel is shown at the top right of the first section in the details page. The status can be either "Enabled" or "Disabled". You can change the status by [editing the sales channel details](#edit-sales-channel-details).
|
||||
|
||||
---
|
||||
|
||||
## Edit Sales Channel Details
|
||||
|
||||
To edit the details of a sales channel:
|
||||
|
||||
1. Go to the sales channel's details page.
|
||||
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the top right of the first section.
|
||||
3. Choose Edit from the dropdown.
|
||||
4. In the side window that opens, you can edit the sales channel's name, description, and whether it's enabled.
|
||||
5. Once you're done, click the Save button.
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Manage Products in Sales Channel
|
||||
|
||||
You can manage the products available in a sales channel from the sales channel's details page.
|
||||
|
||||
### Add Products to Sales Channel
|
||||
|
||||
To add products to a sales channel:
|
||||
|
||||
1. Go to the sales channel's details page.
|
||||
2. Click the "Add" button in the "Products" section.
|
||||
3. In the list that opens, check the products you want to add to the sales channel.
|
||||
4. Click the Save button.
|
||||
|
||||
|
||||
|
||||
### Remove Products from Sales Channel
|
||||
|
||||
To remove products from a sales channel:
|
||||
|
||||
1. Go to the sales channel's details page.
|
||||
2. Under the "Products" section, check the products you want to remove from the sales channel.
|
||||
3. Press <Kbd>R</Kbd> or click the Remove button at the bottom center of the page.
|
||||
4. Confirm removing the product by clicking the Delete button in the pop-up.
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Delete Sales Channel
|
||||
|
||||
<Note type="warning">
|
||||
|
||||
Deleting a sales channel is irreversible.
|
||||
|
||||
</Note>
|
||||
|
||||
To delete a sales channel:
|
||||
|
||||
1. Go to the sales channel's details page.
|
||||
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the top right of the first section.
|
||||
3. Choose Delete from the dropdown.
|
||||
4. Confirm deleting the sales channel by entering the sales channel's name and clicking the "Delete" button in the pop-up.
|
||||
@@ -1,41 +0,0 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
sidebar_label: Manage Products
|
||||
---
|
||||
|
||||
import { EllipsisHorizontal } from "@medusajs/icons"
|
||||
|
||||
export const metadata = {
|
||||
title: `Manage Products in Sales Channels`,
|
||||
}
|
||||
|
||||
# {metadata.title}
|
||||
|
||||
In this document, you’ll learn how to manage products in Sales Channels.
|
||||
|
||||
<Note>
|
||||
|
||||
This guide covers managing products from the Sales Channels page. It’s also possible to manage the Sales Channels of products in the Products page.
|
||||
|
||||
</Note>
|
||||
|
||||
## Add Products to Sales Channels
|
||||
|
||||
To add products to a sales channel:
|
||||
|
||||
1. Go to Settings → Sales Channels
|
||||
2. Find the sales channel in the list and click on it.
|
||||
3. Under the Products section, click the Add button at the top right.
|
||||
4. In the list of products shown, check the checkboxes next to the products to add.
|
||||
5. Once you're done, click the Save button.
|
||||
|
||||
---
|
||||
|
||||
## Remove Product from Sales Channel
|
||||
|
||||
To remove a product from a sales channel:
|
||||
|
||||
1. Go to Settings → Sales Channels
|
||||
2. Find the sales channel in the list and click on it.
|
||||
3. Under the Products section, find the product to remove and click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon to its right.
|
||||
4. Choose Remove from the dropdown.
|
||||
169
www/apps/user-guide/app/settings/tax-regions/page.mdx
Normal file
169
www/apps/user-guide/app/settings/tax-regions/page.mdx
Normal file
@@ -0,0 +1,169 @@
|
||||
---
|
||||
sidebar_position: 6
|
||||
---
|
||||
|
||||
import { EllipsisHorizontal } from "@medusajs/icons"
|
||||
|
||||
export const metadata = {
|
||||
title: `Tax Regions`,
|
||||
}
|
||||
|
||||
# {metadata.title}
|
||||
|
||||
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.
|
||||
|
||||
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.
|
||||
|
||||
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.
|
||||
|
||||
---
|
||||
|
||||
## View Tax Regions
|
||||
|
||||
To view tax regions in your store, go to Settings → Tax Regions. Here, you can see a list of all the tax regions you have set up in your store. You can also search, filter, and sort the tax regions to find the one you are looking for.
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Create Tax Region
|
||||
|
||||
To create a tax region:
|
||||
|
||||
1. Go to Settings → Tax Regions.
|
||||
2. Click the Create button at the top right.
|
||||
3. In the form that opens:
|
||||
- In the Country field, select the country that this tax region applies to.
|
||||
- Under the "Default tax rate" section, you can optionally enter a name, tax rate, and tax code in their respective fields.
|
||||
4. Once you're done, click the Save button.
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## View Tax Region Details
|
||||
|
||||
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.
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Edit Default Tax Rate
|
||||
|
||||
To edit the default tax rate of the region:
|
||||
|
||||
1. Go to the 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.
|
||||
|
||||
|
||||
|
||||
3. Choose Edit from the dropdown.
|
||||
4. In the side window that opens, you can edit the tax rate's name, code, and rate to charge.
|
||||
5. Once you're done, click the Save button.
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## 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 tax rates for tax regions and [sublevel tax regions](#sublevel-tax-regions).
|
||||
|
||||
### Create Tax Rate Override
|
||||
|
||||
To create a tax rate override for a product or product type in a tax region:
|
||||
|
||||
1. Go to the region's details page.
|
||||
2. In the "Overrides" section, click the Create button.
|
||||
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.
|
||||
4. Once you're done, click the Save button.
|
||||
|
||||
|
||||
|
||||
### Edit Tax Rate Override
|
||||
|
||||
To edit a tax rate override:
|
||||
|
||||
1. Go to the region's details page.
|
||||
2. In the "Overrides" section, click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the right of the override you want to edit.
|
||||
3. Choose Edit from the dropdown.
|
||||
4. In the side window that opens, you can edit the override's name, rate, code, and whether the tax rate should be combined with the default rate. You can also edit the targets of the override.
|
||||
5. Once you're done, click the Save button.
|
||||
|
||||
|
||||
|
||||
### Delete Tax Rate Override
|
||||
|
||||
<Note type="warning">
|
||||
|
||||
Deleting a tax rate override is irreversible.
|
||||
|
||||
</Note>
|
||||
|
||||
To delete a tax rate override:
|
||||
|
||||
1. Go to the region's details page.
|
||||
2. In the "Overrides" section, click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the right of the override you want to delete.
|
||||
3. Choose Delete from the dropdown.
|
||||
4. Confirm deleting the override by clicking the Delete button in the pop-up.
|
||||
|
||||
---
|
||||
|
||||
## 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.
|
||||
|
||||
|
||||
|
||||
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.
|
||||
|
||||
|
||||
|
||||
After enabling this setting, you'll find a "Sublevels" section in the tax region details page where you can add sublevel regions.
|
||||
|
||||
### Create Sublevel Tax Region
|
||||
|
||||
To create a sublevel tax region in a tax region:
|
||||
|
||||
1. Go to the tax region's details page.
|
||||
2. In the "Sublevels" section or its equivalent (such as States, Province, or Cantons), click the "Create" button.
|
||||
3. In the form that opens:
|
||||
- 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 ISO 3166-2 code 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.
|
||||
4. Once you're done, click the Save button.
|
||||
|
||||
|
||||
|
||||
### View Sublevel Tax Region Details
|
||||
|
||||
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.
|
||||
|
||||
|
||||
|
||||
### Manage Sublevel Tax Region's Rates
|
||||
|
||||
You can manage the sublevel tax region's [default](#edit-default-tax-rate) and [override](#manage-tax-rate-overrides) rates the same way you manage the parent tax region's rates.
|
||||
@@ -1,38 +0,0 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
import { EllipsisHorizontal } from "@medusajs/icons"
|
||||
|
||||
export const metadata = {
|
||||
title: `Manage Taxes`,
|
||||
}
|
||||
|
||||
# {metadata.title}
|
||||
|
||||
In this document, you’ll learn how to view and manage taxes in your Medusa Admin.
|
||||
|
||||
## View Taxes
|
||||
|
||||
To view taxes, go to Settings → Taxes.
|
||||
|
||||
In the Taxes page, you'll find a list of regions. If you click on a region, you'll find its tax settings and rates.
|
||||
|
||||
---
|
||||
|
||||
## Edit a Region’s Tax Settings
|
||||
|
||||
To edit a region’s tax settings:
|
||||
|
||||
1. Go to Settings → Taxes.
|
||||
2. Click on the region to edit its tax settings.
|
||||
3. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the top right of the first section.
|
||||
4. Choose Edit from the dropdown.
|
||||
5. In the drawer that opens, edit the tax settings:
|
||||
- In the Tax Provider field, you can change the system tax provider to a custom one.
|
||||
- In the "Default tax rate" field, you can change the default tax rate of the region.
|
||||
- In the "Default tax code" field, you can change the default tax code of the region.
|
||||
- By default, taxes are created automatically during checkout. However, in some cases you may choose to disable this behavior if you don't want many requests sent to a custom third-party service. In that case, you can disable the "Calculate taxes automatically" field, but beware that you or your developer has to implement the tax calculation functionality during checkout manually.
|
||||
- By default, taxes aren't applied on gift cards during checkout. To enable applying them on gift cards, enable the "Apply taxes on gift cards" field.
|
||||
- You can change whether a region's prices are tax-inclusive by toggling the "Tax inclusive pricing" field.
|
||||
6. Once you're done, click the Save button.
|
||||
@@ -1,38 +0,0 @@
|
||||
---
|
||||
sidebar_position: 6
|
||||
---
|
||||
|
||||
export const metadata = {
|
||||
title: `Taxes`,
|
||||
}
|
||||
|
||||
# {metadata.title}
|
||||
|
||||
In this document, you’ll get an overview of taxes in Medusa and learn about their importance.
|
||||
|
||||
## Overview
|
||||
|
||||
Taxes in Medusas are directly associated with [Regions](../regions/page.mdx). As regions and countries often have different tax rates and rules, Medusa supports specifying the tax rate for each region.
|
||||
|
||||
Taxes are calculated for products and shipping methods on checkout. Medusa provides a default tax provider to calculate the taxes, and merchants and developers can also integrate custom tax providers for advanced taxes calculation.
|
||||
|
||||
---
|
||||
|
||||
## How are Taxes Created?
|
||||
|
||||
When you create a region, its taxes settings are created as well.
|
||||
|
||||
If you specify the tax rate during the region's creation, a default tax rate is created that's applied on all products and shipping options.
|
||||
|
||||
---
|
||||
|
||||
## Override Tax Rates
|
||||
|
||||
You can create tax rates to override the default tax rate. Tax rates can be condition to products, product types, and shipping options.
|
||||
|
||||
---
|
||||
|
||||
## Learn More About Taxes
|
||||
|
||||
- [Manage Taxes](./manage/page.mdx)
|
||||
- [Manage Tax Rates](./tax-rates/page.mdx)
|
||||
@@ -1,105 +0,0 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
---
|
||||
|
||||
import { EllipsisHorizontal, XMark } from "@medusajs/icons"
|
||||
|
||||
export const metadata = {
|
||||
title: `Manage Tax Rates`,
|
||||
}
|
||||
|
||||
# {metadata.title}
|
||||
|
||||
In this document, you’ll learn how to manage tax rates in your Medusa Admin.
|
||||
|
||||
## Create a Tax Rate
|
||||
|
||||
To create a tax rate:
|
||||
|
||||
1. Go to Settings → Taxes.
|
||||
2. Click on the region to create a tax rate in.
|
||||
3. Under the Tax Rates section, click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the top right.
|
||||
4. Choose Create from the dropdown.
|
||||
5. In the form that opens:
|
||||
1. Enter the name, rate, and code of the tax rate in their respective fields.
|
||||
2. If the tax rate overrides product taxes:
|
||||
1. Enable the "Product overrides" field.
|
||||
2. Click the "Add product overrides" button.
|
||||
3. From the list of shown products, check the checkbox next to the product to add.
|
||||
4. Once you're done, click the Save button at the bottom.
|
||||
3. If the tax rate overrides product type taxes:
|
||||
1. Enable the "Product type overrides" field.
|
||||
2. Click the "Add product type overrides" button.
|
||||
3. From the list of shown product types, check the checkbox next to the type to add.
|
||||
4. Once you're done, click the Save button at the bottom.
|
||||
4. If the tax rate overrides shipping option taxes:
|
||||
1. Enable the "Shipping option overrides" field.
|
||||
2. Click the "Add shipping option overrides" button.
|
||||
3. From the list of shown shipping options, check the checkbox next to the type to add.
|
||||
4. Once you're done, click the Save button at the bottom.
|
||||
6. Once you're done, click the Save button.
|
||||
|
||||
---
|
||||
|
||||
## Edit Tax Rates
|
||||
|
||||
To edit a tax rate:
|
||||
|
||||
1. Go to Settings → Taxes.
|
||||
2. Click on the region to edits its tax rate.
|
||||
3. Find the tax rate in the list under the Tax Rates section and click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at its right.
|
||||
4. Choose "Edit rate" from the dropdown.
|
||||
5. In the drawer that opens, edit the tax rate's details.
|
||||
6. Once done, click the Save button.
|
||||
|
||||
---
|
||||
|
||||
## Edit Tax Rate Overrides
|
||||
|
||||
To edit the overrides of a tax rate:
|
||||
|
||||
1. Go to Settings → Taxes.
|
||||
2. Click on the region to edits its tax rate.
|
||||
3. Find the tax rate in the list under the Tax Rates section and click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at its right.
|
||||
4. Choose "Edit overrides" from the dropdown.
|
||||
5. In the form that opens:
|
||||
1. To change the product overrides
|
||||
1. Enable the "Product overrides" field if it's not enabled.
|
||||
2. To add products:
|
||||
1. Click the "Add product overrides" button.
|
||||
2. From the list of shown products, check the checkbox next to the product to add.
|
||||
3. Once you're done, click the Save button at the bottom.
|
||||
3. To remove a product, click the <InlineIcon Icon={XMark} alt="X" /> icon next to the product.
|
||||
2. To change the product type overrides
|
||||
1. Enable the "Product type overrides" field if it's not enabled.
|
||||
2. To add products:
|
||||
1. Click the "Add product type overrides" button.
|
||||
2. From the list of shown product types, check the checkbox next to the type to add.
|
||||
3. Once you're done, click the Save button at the bottom.
|
||||
3. To remove a product type, click the <InlineIcon Icon={XMark} alt="X" /> icon next to the product.
|
||||
3. To change the shipping option overrides
|
||||
1. Enable the "Shipping option overrides" field if it's not enabled.
|
||||
2. To add shipping options:
|
||||
1. Click the "Add shipping option overrides" button.
|
||||
2. From the list of shown shipping options, check the checkbox next to the shipping option to add.
|
||||
3. Once you're done, click the Save button at the bottom.
|
||||
3. To remove a shipping option, click the <InlineIcon Icon={XMark} alt="X" /> icon next to the shipping option.
|
||||
6. Once you're done, click the Save button.
|
||||
|
||||
---
|
||||
|
||||
## Delete a Tax Rate
|
||||
|
||||
<Note type="warning">
|
||||
|
||||
Deleting a tax rate is irreversible.
|
||||
|
||||
</Note>
|
||||
|
||||
To delete a tax rate:
|
||||
|
||||
1. Go to Settings → Taxes.
|
||||
2. Click on the region to delete its tax rate.
|
||||
3. Find the tax rate in the list under the Tax Rates section and click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at its right.
|
||||
4. Choose Delete from the dropdown.
|
||||
5. Confirm deleting the tax rate by clicking the Delete button.
|
||||
@@ -2,41 +2,31 @@ export const generatedEditDates = {
|
||||
"app/tips/languages/page.mdx": "2025-02-14T14:16:04.867Z",
|
||||
"app/tips/bulk-editor/page.mdx": "2025-02-14T14:16:04.867Z",
|
||||
"app/tips/lists/page.mdx": "2025-02-14T14:16:04.867Z",
|
||||
"app/settings/sales-channels/page.mdx": "2024-05-03T17:36:38+03:00",
|
||||
"app/settings/sales-channels/page.mdx": "2025-02-19T17:33:55.584Z",
|
||||
"app/settings/users/page.mdx": "2025-02-19T11:34:00.736Z",
|
||||
"app/settings/regions/manage/page.mdx": "2024-05-03T17:36:38+03:00",
|
||||
"app/settings/taxes/tax-rates/page.mdx": "2024-05-03T17:36:38+03:00",
|
||||
"app/page.mdx": "2025-02-14T11:18:46.636Z",
|
||||
"app/settings/page.mdx": "2025-02-19T10:57:33.537Z",
|
||||
"app/settings/page.mdx": "2025-02-19T15:46:09.018Z",
|
||||
"app/products/export/page.mdx": "2025-02-18T12:16:52.639Z",
|
||||
"app/settings/return-reasons/page.mdx": "2024-05-03T17:36:38+03:00",
|
||||
"app/settings/regions/page.mdx": "2024-05-03T17:36:38+03:00",
|
||||
"app/settings/regions/shipping-options/page.mdx": "2024-05-03T17:36:38+03:00",
|
||||
"app/settings/return-reasons/page.mdx": "2025-02-19T17:34:01.942Z",
|
||||
"app/settings/regions/page.mdx": "2025-02-19T17:37:17.896Z",
|
||||
"app/orders/page.mdx": "2025-02-17T15:13:42.484Z",
|
||||
"app/settings/users/invites/page.mdx": "2025-02-19T11:38:54.009Z",
|
||||
"app/settings/taxes/page.mdx": "2024-05-03T17:36:38+03:00",
|
||||
"app/settings/developer/page.mdx": "2024-05-03T17:36:38+03:00",
|
||||
"app/settings/taxes/manage/page.mdx": "2024-05-03T17:36:38+03:00",
|
||||
"app/settings/profile/page.mdx": "2024-05-03T17:36:38+03:00",
|
||||
"app/settings/regions/countries/page.mdx": "2024-05-03T17:36:38+03:00",
|
||||
"app/settings/store/page.mdx": "2025-02-19T11:19:01.136Z",
|
||||
"app/products/import/page.mdx": "2025-02-18T12:15:03.830Z",
|
||||
"app/settings/regions/providers/page.mdx": "2024-05-03T17:36:38+03:00",
|
||||
"app/settings/locations/page.mdx": "2024-05-03T17:36:38+03:00",
|
||||
"app/settings/developer/api-key-management/page.mdx": "2024-05-03T17:36:38+03:00",
|
||||
"app/products/categories/page.mdx": "2025-02-19T10:21:42.058Z",
|
||||
"app/inventory/reservations/page.mdx": "2025-02-18T13:56:28.134Z",
|
||||
"app/settings/developer/api-key-management/sales-channels/page.mdx": "2024-05-03T17:36:38+03:00",
|
||||
"app/discounts/manage/page.mdx": "2024-05-03T17:36:38+03:00",
|
||||
"app/products/page.mdx": "2025-02-18T12:24:19.794Z",
|
||||
"app/settings/sales-channels/products/page.mdx": "2024-05-03T17:36:38+03:00",
|
||||
"app/settings/developer/executions/page.mdx": "2024-05-03T17:36:38+03:00",
|
||||
"app/inventory/inventory/page.mdx": "2025-02-18T13:59:16.960Z",
|
||||
"app/customers/groups/page.mdx": "2025-02-18T15:41:30.730Z",
|
||||
"app/orders/manage/page.mdx": "2025-02-18T15:38:17.544Z",
|
||||
"app/orders/returns/page.mdx": "2025-02-17T15:10:11.039Z",
|
||||
"app/inventory/page.mdx": "2025-02-18T13:58:42.393Z",
|
||||
"app/settings/sales-channels/manage/page.mdx": "2024-05-03T17:36:38+03:00",
|
||||
"app/orders/claims/page.mdx": "2025-02-17T15:16:27.380Z",
|
||||
"app/orders/fulfillments/page.mdx": "2025-02-17T15:12:20.431Z",
|
||||
"app/customers/page.mdx": "2025-02-18T15:38:17.543Z",
|
||||
@@ -47,9 +37,9 @@ export const generatedEditDates = {
|
||||
"app/orders/payments/page.mdx": "2025-02-17T15:10:24.250Z",
|
||||
"app/discounts/page.mdx": "2024-05-03T17:36:38+03:00",
|
||||
"app/orders/exchanges/page.mdx": "2025-02-17T15:14:13.676Z",
|
||||
"app/products/create/page.mdx": "2025-02-19T10:13:12.047Z",
|
||||
"app/products/create/page.mdx": "2025-02-19T12:44:48.560Z",
|
||||
"app/products/edit/page.mdx": "2025-02-19T10:18:34.689Z",
|
||||
"app/products/variants/page.mdx": "2025-02-18T12:10:36.029Z",
|
||||
"app/products/variants/page.mdx": "2025-02-19T12:45:06.674Z",
|
||||
"app/products/create/bundle/page.mdx": "2025-02-18T12:17:32.166Z",
|
||||
"app/products/create/multi-part/page.mdx": "2025-02-18T12:17:29.629Z",
|
||||
"app/promotions/campaigns/page.mdx": "2025-02-19T09:02:49.193Z",
|
||||
@@ -58,5 +48,11 @@ export const generatedEditDates = {
|
||||
"app/promotions/page.mdx": "2025-02-19T09:00:12.501Z",
|
||||
"app/price-lists/create/page.mdx": "2025-02-19T10:11:33.113Z",
|
||||
"app/price-lists/manage/page.mdx": "2025-02-19T10:35:49.881Z",
|
||||
"app/price-lists/page.mdx": "2025-02-19T09:51:32.546Z"
|
||||
"app/price-lists/page.mdx": "2025-02-19T09:51:32.546Z",
|
||||
"app/settings/tax-regions/page.mdx": "2025-02-19T17:33:43.806Z",
|
||||
"app/settings/locations-and-shipping/locations/page.mdx": "2025-02-19T17:28:36.838Z",
|
||||
"app/settings/locations-and-shipping/page.mdx": "2025-02-19T17:23:45.824Z",
|
||||
"app/settings/locations-and-shipping/shipping-profiles/page.mdx": "2025-02-19T17:36:46.339Z",
|
||||
"app/settings/product-tags/page.mdx": "2025-02-19T17:36:25.102Z",
|
||||
"app/settings/product-types/page.mdx": "2025-02-19T17:36:16.496Z"
|
||||
}
|
||||
@@ -395,7 +395,7 @@ export const generatedSidebar = [
|
||||
"isPathHref": true,
|
||||
"type": "link",
|
||||
"title": "Tax Regions",
|
||||
"path": "#",
|
||||
"path": "/settings/tax-regions",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -419,7 +419,7 @@ export const generatedSidebar = [
|
||||
"isPathHref": true,
|
||||
"type": "link",
|
||||
"title": "Product Types",
|
||||
"path": "#",
|
||||
"path": "/settings/product-types",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -427,7 +427,7 @@ export const generatedSidebar = [
|
||||
"isPathHref": true,
|
||||
"type": "link",
|
||||
"title": "Product Tags",
|
||||
"path": "#",
|
||||
"path": "/settings/product-tags",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -435,8 +435,25 @@ export const generatedSidebar = [
|
||||
"isPathHref": true,
|
||||
"type": "link",
|
||||
"title": "Location & Shipping",
|
||||
"path": "/settings/locations",
|
||||
"children": []
|
||||
"path": "/settings/locations-and-shipping",
|
||||
"children": [
|
||||
{
|
||||
"loaded": true,
|
||||
"isPathHref": true,
|
||||
"type": "link",
|
||||
"title": "Locations",
|
||||
"path": "/settings/locations-and-shipping/locations",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"loaded": true,
|
||||
"isPathHref": true,
|
||||
"type": "link",
|
||||
"title": "Shipping Profiles",
|
||||
"path": "/settings/locations-and-shipping/shipping-profiles",
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"loaded": true,
|
||||
|
||||
@@ -244,7 +244,7 @@ export const sidebar = sidebarAttachHrefCommonOptions([
|
||||
{
|
||||
type: "link",
|
||||
title: "Tax Regions",
|
||||
path: "#",
|
||||
path: "/settings/tax-regions",
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
@@ -259,17 +259,29 @@ export const sidebar = sidebarAttachHrefCommonOptions([
|
||||
{
|
||||
type: "link",
|
||||
title: "Product Types",
|
||||
path: "#",
|
||||
path: "/settings/product-types",
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
title: "Product Tags",
|
||||
path: "#",
|
||||
path: "/settings/product-tags",
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
title: "Location & Shipping",
|
||||
path: "/settings/locations",
|
||||
path: "/settings/locations-and-shipping",
|
||||
children: [
|
||||
{
|
||||
type: "link",
|
||||
title: "Locations",
|
||||
path: "/settings/locations-and-shipping/locations",
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
title: "Shipping Profiles",
|
||||
path: "/settings/locations-and-shipping/shipping-profiles",
|
||||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
type: "category",
|
||||
|
||||
Reference in New Issue
Block a user