docs: added settings user guides (#2586)

This commit is contained in:
Shahed Nasser
2022-11-10 16:31:56 +02:00
committed by GitHub
parent 699bb1d57b
commit 7b96bb1f1a
6 changed files with 151 additions and 2 deletions

View File

@@ -31,7 +31,7 @@ To create an order exchange:
4. In the new window that opens:
1. Choose the items you want the customer to return. For each item you select:
1. Click on the Select Reason button.
2. Choose a reason from available Reasons. If you cant find any Reasons, make sure to add Return Reasons in Settings first.
2. Choose a reason from available Reasons. If you cant find any Reasons, make sure to add [Return Reasons in Settings](../settings/return-reasons.mdx#add-return-reason) first.
3. You can optionally add a Note.
4. Once youre done, click on the Add button.
2. Choose a Shipping Method to return the customers items.

View File

@@ -41,7 +41,7 @@ To request a return for an order:
4. In the new window that opens:
- Choose the items in the order that you want to request the return.
- For each item that you choose, click on the Select Reason below that item.
- Choose a Return Reason, optionally enter a Note, then click the Add button.
- Choose a [Return Reason](../settings/return-reasons.mdx#add-return-reason), optionally enter a Note, then click the Add button.
- Select a shipping method you want to use for this return.
- If you want to change the default price of the shipping method, click on the “Add custom price” button and enter the price you want to use.
- If you want to remove the custom price, you can click on the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999273/Medusa%20Docs/UI%20Icons/7hztVhj_mj6mxu.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999290/Medusa%20Docs/UI%20Icons/1yp4PNt_vzwnhf.png" alt="trash" /> icon.

View File

@@ -0,0 +1,6 @@
{
"position": 13,
"collapsed": false,
"link": null,
"label": "Settings"
}

View File

@@ -0,0 +1,59 @@
---
sidebar_position: 2
---
# Manage Currencies
In this document, youll learn how to set the default currency in your store and how to support more currencies.
## Overview
Medusa supports using more than one currency in your store. When you add currencies, you can set prices for products for each of those currencies.
To make a currency available for your customers, you have to use the currency in a region. Then, your customers will be able to choose the region with the currency that fits them.
:::tip
Before you can use a currency in a region, make sure to [add it to your store](#add-a-currency).
:::
---
## Add a Currency
To make a currency available in your store:
1. Go to Settings → Currencies.
2. Click on the “Edit currencies” button in the Store Currencies section.
3. In the new window that opens:
1. Click on the Add Currencies button.
2. Select all the currencies you want to add.
4. Click on the “Save and close” button.
---
## Set Default Currency
:::tip
Before you can make a currency the default currency, make sure to [add it to your store](#add-a-currency).
:::
To set the default currency of your store:
1. Go to Settings → Currencies.
2. In the "Default store currency” section, choose from the dropdown the currency you want to make the default.
---
## Remove Currencies
To remove a currency from your store:
1. Go to Settings → Currencies.
2. Click on the “Edit currencies” button in the Store Currencies section.
3. In the new window that opens:
1. Select all the currencies you want to remove.
2. Click on the Remove button.

View File

@@ -0,0 +1,64 @@
---
sidebar_position: 3
---
import UiIcon from '@site/src/components/UiIcon';
# Manage Return Reasons
In this document, youll learn how to add, edit, and remove return reasons.
## Overview
Return reasons are used when issuing returns or exchanges of orders. When you want to request an exchange or return of an item in an order, you must specify the reason for that return.
Return reasons are custom and are created by merchants. For example, you can create the return reason “damaged”, then use it when you want to request a return for an item in an order because it has been damaged.
:::note
Creating at least one return reason is required before you can work with order returns and exchanges.
:::
---
## Add Return Reason
To add a return reason:
1. Go to Settings → Return Reasons.
2. Click on the “Add reason” button in the Return Reasons section.
3. In the new window:
1. You are required to enter a value and a label for the return reason. The value is for internal use and must not include spaces. The label is what the customer will see in their order returns or exchanges.
2. You can optionally enter a description for the return reason.
4. Once done, click on the Create button.
---
## Duplicate a Return Reason
To duplicate a return reason:
1. Go to Settings → Return Reasons.
2. Choose the return reason you want to duplicate from the left section.
3. 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 Details section.
4. Click on “Duplicate reason” from the dropdown.
5. In the new window that opens, make changes as necessary for the new return reason.
6. Once done, click on the Create button.
---
## Edit a Return Reason
:::info
A return reasons value cant be edited.
:::
To edit a return reason:
1. Go to Settings → Return Reasons.
2. Choose the return reason you want to edit from the left section.
3. In the Details section, make changes to the label or description of the return reason.
4. Once done, click on the Save button.

View File

@@ -0,0 +1,20 @@
---
sidebar_position: 1
---
# Manage Store Details
In this document, youll learn how to edit the stores details.
## Edit Store Details
To edit the stores details:
1. Go to Settings → Store Details
2. In the Store Details form:
1. You can change the stores name.
2. You can set the template link for swaps, draft orders, and invites. When making a change to the link template, make sure to use the following placeholders within the link:
1. **Swaps**: Use the `{swap_id}` placeholder to indicate where the ID of the swap should be in the link.
2. **Draft Order**: Use the `{payment_id}` placeholder to indicate where the ID of the payment should be in the link.
3. **Invites:** Use the `{invite_token}` placeholder to indicate where the invite token should be in the link.
3. Once done, click on the Save button.