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
@@ -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.
|
||||
Reference in New Issue
Block a user