asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

docs: updated region operations in user guide (#2245)

Browse Source
This commit is contained in:
Shahed Nasser
2022-09-22 13:41:25 +03:00
committed by GitHub
parent 6adaf56c73
commit a3f6755f63
7 changed files with 89 additions and 114 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/content/add-plugins/paypal.md
View File

@@ -80,17 +80,7 @@ If you don’t have a Medusa admin installed, make sure to follow along with [th
### Add PayPal to Regions
Run your Medusa server and Medusa admin, then open the Medusa admin and login.
Choose Settings from the Sidebar. Then, choose Regions.
![Region Settings](https://i.imgur.com/wRkmbLY.png)
Then, choose the regions you want to add PayPal as a payment provider. In the right-side settings, scroll down to “Payment Providers” and choose “paypal”.
![Choose PayPal](https://i.imgur.com/AJ2Yez8.png)
Once you’re done, click Save. PayPal is now a payment provider in your store in the regions you added it to.
You can refer to [this documentation in the user guide](../user-guide/regions/providers.mdx#manage-payment-providers) to learn how to add a payment provider like PayPal to a region.
## Storefront Setup

12
docs/content/add-plugins/stripe.md
View File

@@ -107,17 +107,7 @@ If you don’t have a Medusa admin installed, make sure to follow along with [th
### Add Stripe to Regions
First, make sure that both your Medusa server and Medusa Admin are running.
Then, in your Medusa Admin, log in and choose Settings from the Sidebar. Then, choose Regions.
![Settings](https://i.imgur.com/wRkmbLY.png)
Then, choose the regions you want to add Stripe as a payment provider. In the right-side settings, scroll down to “Payment Providers” and choose Stripe.
![Choose Stripe](https://i.imgur.com/FH5vgWh.png)
Once you’re done, click Save. Stripe is now a payment provider in your store in the regions you selected.
You can refer to [this documentation in the user guide](../user-guide/regions/providers.mdx#manage-payment-providers) to learn how to add a payment provider like Stripe to a region.
## Storefront Setup

4
docs/content/user-guide/regions/index.md
View File

@@ -31,5 +31,5 @@ For example, if you have Stripe enabled as a payment provider in a region create
## Learn More About Regions
- [Manage Regions](./manage.mdx)
- [Manage Payment and Fulfillment Providers](./providers.md)
- [Manage Shipping Options in a Region](./shipping-options.md)
- [Manage Payment and Fulfillment Providers](./providers.mdx)
- [Manage Shipping Options in a Region](./shipping-options.mdx)

34
docs/content/user-guide/regions/manage.mdx
View File

@@ -24,11 +24,11 @@ This opens the Regions page where you can find a list of regions.
To create a region:
1. Go to Settings → Regions.
2. Click on Add Region at the top right of the Regions section.
3. In the window that opens you must enter the Regions details:
- It is required to enter a name and choose a currency and at least one country, payment provider, and fulfillment provider.
- You can optionally enter a tax rate and code for the region. Alternatively, you can [edit a region’s tax settings and rates](../taxes/manage.md#edit-a-regions-taxes) after creation.
4. Once you’re done, click Save.
2. Click on the <UiIcon lightIcon="https://i.imgur.com/1hL8NiW.png" darkIcon="https://i.imgur.com/8LtkPqW.png" alt="plus" /> icon at the top right of the Regions section.
3. In the form that opens you must enter the Regions details:
- It is required to enter a title, choose a currency, enter a tax rate, and at least choose one country, payment provider, and fulfillment provider.
- You can optionally enter a tax code for the region. Alternatively, you can [edit a region’s tax settings](../taxes/manage.md#edit-a-regions-taxes) after creation.
4. Once you’re done, click on the "Create region" button.
:::tip
@@ -42,26 +42,16 @@ After you click save, the region will be created and you can see it in the list
## Edit a Region
To edit a region:
To edit a region's basic information:
1. Go to Settings → Regions.
2. Click on the region you want to edit from the Regions section.
3. This opens a Details form to the right. You can edit basic information such as the name or currency.
4. Once you’re done, click Save.
2. Click on the region you want to edit from the Regions section. This shows sections to the right to edit different information and data related to the region.
4. Click on the <UiIcon lightIcon="https://i.imgur.com/1ordBC6.png" darkIcon="https://i.imgur.com/dSwWYBH.png" alt="three dots" /> icon at the top right of the first region.
5. This opens a new window where you can edit the region's details.
6. Once done, click on the "Save and close" button.
---
## Duplicate a Region
Duplicating a region allows you to create a new region with some of its details filled from an existing region. The details that will be copied are the currency, payment providers, and fulfillment providers.
To duplicate a region:
1. Go to Settings → Regions.
2. Click on the region you want to duplicate from the Regions section.
3. In the Details section, click on the <UiIcon lightIcon="https://i.imgur.com/1ordBC6.png" darkIcon="https://i.imgur.com/dSwWYBH.png" alt="three dots" /> icon.
4. Choose Duplicate Region from the dropdown list.
## Delete a Region
:::warning
@@ -74,6 +64,6 @@ To delete a region:
1. Go to Settings → Regions.
2. Click on the region you want to duplicate from the Regions section.
3. In the Details section, click on the <UiIcon lightIcon="https://i.imgur.com/1ordBC6.png" darkIcon="https://i.imgur.com/dSwWYBH.png" alt="three dots" /> icon.
3. In the first section on the right, click on the <UiIcon lightIcon="https://i.imgur.com/1ordBC6.png" darkIcon="https://i.imgur.com/dSwWYBH.png" alt="three dots" /> icon.
4. Choose Delete Region from the dropdown list.
5. Confirm deleting the region by clicking the “Yes, delete” button in the pop-up.
5. Confirm deleting the region by clicking the “Yes, confirm" button in the pop-up.

39
docs/content/user-guide/regions/providers.md
View File

@@ -1,39 +0,0 @@
---
sidebar_position: 3
---
# Manage Payment and Fulfillment Providers
In this document, you’ll learn how to manage a region’s payment and fulfillment providers in your Medusa Admin.
## Overview
You can choose the payment and fulfillment providers available in each region. This allows you to provide customers in specific regions the providers that are available in their country or region.
When a payment or fulfillment provider is added to a region, it means a customer is able to select that payment or fulfillment provider during checkout to complete their purchase.
---
## Manage Payment Providers
To add or remove a payment provider in a region:
1. Go to Settings → Regions.
2. Select a region to edit.
3. Scroll down to the Payment Providers section in the Details form.
4. Select the payment providers you want to add to the region.
5. Unselect the payment providers you want to remove from the region.
6. Click Save.
---
## Manage Fulfillment Providers
To add or remove a fulfillment provider in a region:
1. Go to Settings → Regions.
2. Select a region to edit.
3. Scroll down to the Fulfillment Providers section in the Details form.
4. Select the fulfillment providers you want to add to the region.
5. Unselect the fulfillment providers you want to remove from the region.
6. Click Save.

44
docs/content/user-guide/regions/providers.mdx Normal file
View File

@@ -0,0 +1,44 @@
---
sidebar_position: 3
sidebar_label: Manage Providers
---
import UiIcon from '@site/src/components/UiIcon';
# Manage Payment and Fulfillment Providers
In this document, you’ll learn how to manage a region’s payment and fulfillment providers in your Medusa Admin.
## Overview
You can choose the payment and fulfillment providers available in each region. This allows you to provide customers in specific regions the providers that are available in their country or region.
When a payment or fulfillment provider is added to a region, it means a customer is able to select that payment or fulfillment provider during checkout to complete their purchase.
---
## Manage Payment Providers
To add or remove a payment provider in a region:
1. Go to Settings → Regions.
2. Select a region to edit.
3. Click on the <UiIcon lightIcon="https://i.imgur.com/1ordBC6.png" darkIcon="https://i.imgur.com/dSwWYBH.png" alt="three dots" /> icon at the top right of the first section on the right.
4. Click on Edit Region Details from the dropdown.
5. Under the providers section, select the payment providers you want to add to the region.
6. Unselect the payment providers you want to remove from the region.
7. Click Save.
---
## Manage Fulfillment Providers
To add or remove a fulfillment provider in a region:
1. Go to Settings → Regions.
2. Select a region to edit.
3. Click on the <UiIcon lightIcon="https://i.imgur.com/1ordBC6.png" darkIcon="https://i.imgur.com/dSwWYBH.png" alt="three dots" /> icon at the top right of the first section on the right.
4. Click on Edit Region Details from the dropdown.
5. Under the providers section, select the fulfillment providers you want to add to the region.
6. Unselect the fulfillment providers you want to remove from the region.
7. Click Save.

58
docs/content/user-guide/regions/shipping-options.md → docs/content/user-guide/regions/shipping-options.mdx
View File

@@ -23,15 +23,14 @@ To add a shipping option:
1. Go to Settings → Regions.
2. Select a region to edit.
3. Scroll down to the Shipping Options section in the Details form.
4. Click on Add Option.
3. Scroll down to the Shipping Options section on the right side.
4. Click on the Add Option button.
5. A new window will open with a form with the following fields:
- **Name (Required):** The name of the shipping option. The customer will see this name on the storefront if the “Show on Website” field is checked.
- **Currency:** This is a read-only field and its value depends on the currency of the region.
- **Title (Required):** The name of the shipping option. The customer will see this name on the storefront if the “Show on Website” field is checked.
- **Price (Required):** The price of the shipping option.
- **Show on Website:** Whether or not this option should be available on the website. This is useful if you want to create a shipping option only for use on the Medusa Admin (for example, to create draft orders).
- **Shipping Profile (Required):** The shipping profile this option belongs to.
- **Fulfillment Method (Required):** the fulfillment provider that will handle fulfilling this shipping option.
- **Visible is Store:** Whether or not this option should be available on the website. This is useful if you want to create a shipping option only for use on the Medusa Admin (for example, to create draft orders).
- **Requirements:** You can use this to specify a condition for when this shipping option should be available. The first field indicates the minimum cart subtotal, and the second field indicates the maximum cart subtotal. For example, you can fill in the first field “100” to only allow using this shipping option if the cart’s subtotal is at least $100.
6. Once you’re done, click Save.
@@ -41,10 +40,11 @@ To edit a shipping option:
1. Go to Settings → Regions.
2. Select a region to edit.
3. Scroll down to the Shipping Options section in the Details form.
4. Find the shipping option you want to edit and click on Edit at the right of its name.
5. A new window will open with the fields that you can edit. You can edit all of the fields you chose while adding the shipping option except for the Shipping Profile and Fulfillment Method.
6. Once done, click Save.
3. Scroll down to the Shipping Options section on the right side.
4. Find the shipping option you want to edit and click on the three dots icon at its right.
5. Click on Edit in the dropdown.
6. A new window will open with the fields that you can edit. You can edit all of the fields you chose while adding the shipping option except for the Shipping Profile and Fulfillment Method.
7. Once you’re done, click the Save and close button.
### Delete a Shipping Option
@@ -58,10 +58,9 @@ To delete a shipping option:
1. Go to Settings → Regions.
2. Select a region to edit.
3. Scroll down to the Shipping Options section in the Details form.
4. Find the shipping option you want to edit and click on Edit at the right of its name.
5. A new window will open. Click on Delete under the Danger Zone section.
6. Confirm deleting the shipping option by clicking the “Yes, remove” button in the pop-up.
3. Scroll down to the Shipping Options section on the right side.
4. Find the shipping option you want to edit and click on the <UiIcon lightIcon="https://i.imgur.com/1ordBC6.png" darkIcon="https://i.imgur.com/dSwWYBH.png" alt="three dots" /> icon at its right.
5. Click on Delete in the dropdown.
---
@@ -73,15 +72,16 @@ To add a return shipping option:
1. Go to Settings → Regions.
2. Select a region to edit.
3. Scroll down to the Return Shipping Options section in the Details form.
4. Click on Add Return.
3. Scroll down to the Return Shipping Options section on the right side.
4. Click on the Add Option button.
5. A new window will open with a form with the following fields:
- **Name (Required):** The name of the return shipping option. The customer will see this name on the storefront if the “Show on Website” field is checked.
- **Currency:** This is a read-only field and its value depends on the currency of the region.
- **Price (Required):** The price of the return shipping option.
- **Show on Website:** Whether or not this option should be available on the website. This is useful if you want to create a return shipping option only for use on the Medusa Admin (for example, to create claims or return requests from the Medusa Admin).
- **Fulfillment Method (Required):** the fulfillment provider that will handle fulfilling this return shipping option.
6. Once you’re done, click Save.
- **Title (Required):** The name of the shipping option. The customer will see this name on the storefront if the “Show on Website” field is checked.
- **Price (Required):** The price of the shipping option.
- **Shipping Profile (Required):** The shipping profile this option belongs to.
- **Fulfillment Method (Required):** the fulfillment provider that will handle fulfilling this shipping option.
- **Visible is Store:** Whether or not this option should be available on the website. This is useful if you want to create a shipping option only for use on the Medusa Admin (for example, to create draft orders).
- **Requirements:** You can use this to specify a condition for when this shipping option should be available. The first field indicates the minimum cart subtotal, and the second field indicates the maximum cart subtotal. For example, you can fill in the first field “100” to only allow using this shipping option if the cart’s subtotal is at least $100.
6. Once you’re done, click the Save and close button.
### Edit a Return Shipping Option
@@ -89,10 +89,11 @@ To edit a return shipping option:
1. Go to Settings → Regions.
2. Select a region to edit.
3. Scroll down to the Return Shipping Options section in the Details form.
4. Find the return shipping option you want to edit and click on Edit at the right of its name.
5. A new window will open with the fields that you can edit. You can edit all of the fields you chose while adding the shipping profile except for the Fulfillment Method.
6. Once done, click Save.
3. Scroll down to the Return Shipping Options section on the right side.
4. Find the shipping option you want to edit and click on the <UiIcon lightIcon="https://i.imgur.com/1ordBC6.png" darkIcon="https://i.imgur.com/dSwWYBH.png" alt="three dots" /> icon at its right.
5. Click on Edit in the dropdown.
6. A new window will open with the fields that you can edit. You can edit all of the fields you chose while adding the shipping option except for the Shipping Profile and Fulfillment Method.
7. Once you’re done, click the Save and close button.
### Delete a Return Shipping Option
@@ -106,7 +107,6 @@ To delete a return shipping option:
1. Go to Settings → Regions.
2. Select a region to edit.
3. Scroll down to the Return Shipping Options section in the Details form.
4. Find the return shipping option you want to edit and click on Edit at the right of its name.
5. A new window will open. Click on Delete under the Danger Zone section.
6. Confirm deleting the return shipping option by clicking the “Yes, remove” button in the pop-up.
3. Scroll down to the Return Shipping Options section on the right side.
4. Find the shipping option you want to edit and click on the <UiIcon lightIcon="https://i.imgur.com/1ordBC6.png" darkIcon="https://i.imgur.com/dSwWYBH.png" alt="three dots" /> icon at its right.
5. Click on Delete in the dropdown.