docs: update stale information (#4790)

2023-08-17 14:19:51 +03:00
parent b08337deb7
commit 26c78bbc03
19 changed files with 181 additions and 136 deletions
@@ -34,7 +34,7 @@ To create a region:

 :::tip

-If you can’t find the currency you want to use in the Currency field, make sure to add the Currency to the store’s currencies in the settings.
+If you can’t find the currency you want to use in the Currency field, make sure to [add the Currency to the store’s currencies in the settings](../settings/currencies.md#add-a-currency).

 :::

@@ -48,9 +48,10 @@ 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. This shows sections to the right to edit different information and data related to the region.
-4. Click on the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999308/Medusa%20Docs/UI%20Icons/1ordBC6_ssysel.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999326/Medusa%20Docs/UI%20Icons/dSwWYBH_stzgoi.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.
+4. Click on the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999308/Medusa%20Docs/UI%20Icons/1ordBC6_ssysel.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999326/Medusa%20Docs/UI%20Icons/dSwWYBH_stzgoi.png" alt="three dots" /> icon at the top right of the first section.
+5. Click on "Edit Region Details" from the dropdown.
+6. This opens a new window where you can edit the region's details.
+7. Once done, click on the "Save and close" button.

 ---

@@ -65,7 +66,7 @@ If you delete a region, you will not be able to restore it or its data. Data rel
 To delete a region:

 1. Go to Settings → Regions.
-2. Click on the region you want to duplicate from the Regions section.
+2. Click on the region you want to delete from the Regions section.
 3. In the first section on the right, click on the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999308/Medusa%20Docs/UI%20Icons/1ordBC6_ssysel.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999326/Medusa%20Docs/UI%20Icons/dSwWYBH_stzgoi.png" alt="three dots" /> icon.
 4. Choose Delete Region from the dropdown list.
-5. Confirm deleting the region by clicking the “Yes, confirm" button in the pop-up.
+5. Confirm deleting the region by entering the name of the region and clicking the “Yes, confirm" button in the pop-up.
@@ -29,7 +29,7 @@ To add or remove a payment provider in a region:
 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.
+7. Click the "Save and close" button.

 ---

@@ -43,4 +43,4 @@ To add or remove a fulfillment provider in a region:
 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.
+7. Click the "Save and close" button.
@@ -15,11 +15,13 @@ In this document, you’ll learn how to manage a region’s shipping options in

 There are two types of shipping options in a region:

-1. Shipping Options are used when a customer places an order or when an admin creates a draft order.
-2. Return Shipping Options are used when a customer requests a return or swap for their order, or when an admin registers an exchange, a claim, or a return for an order.
+1. Shipping Options that are used when a customer places an order or when an admin creates a draft order.
+2. Return Shipping Options that are used when a customer requests a return or exchange for their order, or when an admin registers an exchange, a claim, or a return for an order.

 A shipping option can’t be used for both cases. In a region, you can create an unlimited amount of shipping options and return shipping options.

+---
+
 ## Manage Shipping Options in a Region

 ### Add Shipping Option to a Region
@@ -27,24 +29,26 @@ A shipping option can’t be used for both cases. In a region, you can create an
 To add a shipping option:

 1. Go to Settings → Regions.
-2. Select a region to edit.
+2. Select the shipping option's region.
 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:
+    - **Visible in 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).
    - **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.
+    - **Price Type (Required):** The type of price. It can be either Flat Rate or Calculated. If you choose Flat Rate, this will show a new field **Price**. If you choose Calculated, it's assumed the calculation of the shipping option is handled using custom logic implemented in the Fulfillment provider.
+    - **Price:** This field is only available and required when you set the **Price Type** to Flat Rate. It indicates 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 Save.
+    - **Requirements:** You can use this section to specify a condition for when this shipping option should be available during checkout or draft-order creation. The "Min. subtotal" field indicates the minimum cart subtotal required to use this shipping option, and the "Max. subtotal" field indicates the maximum cart subtotal required to use this shipping option. 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.
+    - **Metadata**: This section allows you to add custom data to the shipping option in the form of a key-value pair. This is mostly helpful for technical teams and developers.
+6. Once you’re done, click the "Save and close" button.

 ### Edit a Shipping Option

 To edit a shipping option:

 1. Go to Settings → Regions.
-2. Select a region to edit.
+2. Select the shipping option's region.
 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.
@@ -62,7 +66,7 @@ If you delete a shipping option, you can’t restore it or its data, customers c
 To delete a shipping option:

 1. Go to Settings → Regions.
-2. Select a region to edit.
+2. Select the shipping option's region.
 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://res.cloudinary.com/dza7lstvk/image/upload/v1667999308/Medusa%20Docs/UI%20Icons/1ordBC6_ssysel.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999326/Medusa%20Docs/UI%20Icons/dSwWYBH_stzgoi.png" alt="three dots" /> icon at its right.
 5. Click on Delete in the dropdown.
@@ -76,16 +80,19 @@ To delete a shipping option:
 To add a return shipping option:

 1. Go to Settings → Regions.
-2. Select a region to edit.
+2. Select the shipping option's region.
 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:
+    - **Visible in Store:** 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 an order return).
    - **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.
+    - **Price Type (Required):** The type of price. It can be either Flat Rate or Calculated. If you choose Flat Rate, this will show a new field **Price**. If you choose Calculated, it's assumed the calculation of the shipping option is handled using custom logic implemented in the Fulfillment provider.
+    - **Price:** This field is only available and required when you set the **Price Type** to Flat Rate. It indicates 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.
+    - **Requirements:** You can use this section to specify a condition for when this shipping option should be available when creating a return or exchange. The "Min. subtotal" field indicates the minimum subtotal required to use this shipping option, and the "Max. subtotal" field indicates the maximum subtotal required to use this shipping option. 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.
+    - **Metadata**: This section allows you to add custom data to the shipping option in the form of a key-value pair. This is mostly helpful for technical teams and developers.
+6. Once you’re done, click the "Save and close" button.
 6. Once you’re done, click the Save and close button.

 ### Edit a Return Shipping Option
@@ -93,7 +100,7 @@ To add a return shipping option:
 To edit a return shipping option:

 1. Go to Settings → Regions.
-2. Select a region to edit.
+2. Select the shipping option's region.
 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://res.cloudinary.com/dza7lstvk/image/upload/v1667999308/Medusa%20Docs/UI%20Icons/1ordBC6_ssysel.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999326/Medusa%20Docs/UI%20Icons/dSwWYBH_stzgoi.png" alt="three dots" /> icon at its right.
 5. Click on Edit in the dropdown.
@@ -111,7 +118,7 @@ If you delete a return shipping option, you can’t restore it or its data, cust
 To delete a return shipping option:

 1. Go to Settings → Regions.
-2. Select a region to edit.
+2. Select the shipping option's region.
 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://res.cloudinary.com/dza7lstvk/image/upload/v1667999308/Medusa%20Docs/UI%20Icons/1ordBC6_ssysel.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999326/Medusa%20Docs/UI%20Icons/dSwWYBH_stzgoi.png" alt="three dots" /> icon at its right.
 5. Click on Delete in the dropdown.