chore: reorganize docs apps (#7228)
* reorganize docs apps * add README * fix directory * add condition for old docs
This commit is contained in:
1 parent
224ebb2154
commit
4fe28f5a95
6187 files changed
+601447
-598226
No files matched your search
@@ -0,0 +1,89 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
import { SquareTwoStack, EllipsisHorizontal } from "@medusajs/icons"
|
||||
|
||||
export const metadata = {
|
||||
title: `API Key Management`,
|
||||
}
|
||||
|
||||
# {metadata.title}
|
||||
|
||||
In this document, you’ll learn how to manage publishable API keys in the Medusa Admin.
|
||||
|
||||
## What is a Publishable API Key
|
||||
|
||||
Publishable API key define resources associated with a public API key. This API key is used by developers when developing a storefront.
|
||||
|
||||
Currently, publishable API keys are only associated with sales channels.
|
||||
|
||||
---
|
||||
|
||||
## Create a Publishable API Key
|
||||
|
||||
To create a publishable API key:
|
||||
|
||||
1. Go to Settings → API key management.
|
||||
2. Click on the Create button at the top right.
|
||||
3. In the new form that opens, enter the title of the API key.
|
||||
4. Click the Save button.
|
||||
|
||||
---
|
||||
|
||||
## Copy Token of Publishable API Key
|
||||
|
||||
To copy the token of an API key:
|
||||
|
||||
1. Go to Settings → API key management.
|
||||
2. Find the API key you want to copy.
|
||||
3. Click the <InlineIcon Icon={SquareTwoStack} alt="copy" /> icon in the Key column of the API key.
|
||||
|
||||
---
|
||||
|
||||
## Edit Publishable API Key Details
|
||||
|
||||
To edit the details of an API key:
|
||||
|
||||
1. Go to Settings → API key management.
|
||||
2. Find the publishable API key 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 publishable API key's details.
|
||||
6. Once you're done, click the Save button.
|
||||
|
||||
---
|
||||
|
||||
## Revoke Publishable API Key
|
||||
|
||||
<Note type="warning">
|
||||
|
||||
Revoking a publishable API key is irreversible.
|
||||
|
||||
</Note>
|
||||
|
||||
To revoke a publishable API key:
|
||||
|
||||
1. Go to Settings → API key management.
|
||||
2. Find the publishable API key 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 Revoke from the dropdown.
|
||||
5. Confirm revoking the publishable API key by clicking the Revoke button in the pop-up.
|
||||
|
||||
---
|
||||
|
||||
## Delete Publishable API Key
|
||||
|
||||
<Note type="warning">
|
||||
|
||||
Deleting a publishable API key is irreversible.
|
||||
|
||||
</Note>
|
||||
|
||||
To delete a publishable API key:
|
||||
|
||||
1. Go to Settings → API key management.
|
||||
2. Find the publishable API key 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 publishable API key by clicking the Delete button in the pop-up.
|
||||
@@ -0,0 +1,34 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
sidebar_label: "Manage Sales Channels"
|
||||
---
|
||||
|
||||
export const metadata = {
|
||||
title: `Manage Sales Channels of a Publishable API Key`,
|
||||
}
|
||||
|
||||
# {metadata.title}
|
||||
|
||||
In this document, you'll learn how to manage the sales channels of a publishable API key.
|
||||
|
||||
## Add Sales Channels
|
||||
|
||||
To add sales channels to a publishable API key:
|
||||
|
||||
1. Go to Settings → API key management.
|
||||
2. Find the publishable API key in the list and click on it.
|
||||
3. Under the Sales Channels section, click the Add button.
|
||||
4. In the list that opens, check the checkbox next the sales channels to add.
|
||||
5. Once you're done, click the Save button.
|
||||
|
||||
---
|
||||
|
||||
## Remove Sales Channels
|
||||
|
||||
To remove sales channels from a publishable API key:
|
||||
|
||||
1. Go to Settings → API key management.
|
||||
2. Find the publishable API key in the list and click on it.
|
||||
3. Under the Sales Channels section, check the checkbox next to the sales channels you want to remove.
|
||||
4. Once you're done, press <Kbd>R</Kbd>
|
||||
5. Confirm deleting the sales channel by clicking the Delete button in the pop-up.
|
||||
@@ -0,0 +1,57 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
sidebar_label: "Executions"
|
||||
---
|
||||
|
||||
import { ArrowsPointingOut } from "@medusajs/icons"
|
||||
|
||||
export const metadata = {
|
||||
title: `View Executions`,
|
||||
}
|
||||
|
||||
# {metadata.title}
|
||||
|
||||
In this documentation, you'll learn how to view executions in your store and their details.
|
||||
|
||||
## What is an Execution?
|
||||
|
||||
An execution refers to a workflow that's been executed. You can view a workflow execution's progress, details, and raw JSON data all from the Medusa Admin.
|
||||
|
||||
---
|
||||
|
||||
## View Executions
|
||||
|
||||
To view all workflow executions, go to Settings → Executions. You'll find a list of executions with general details.
|
||||
|
||||
---
|
||||
|
||||
## View Execution Details
|
||||
|
||||
To view an execution's details:
|
||||
|
||||
1. Go to Settings → Executions.
|
||||
2. Click on the execution to view it.
|
||||
|
||||
On the execution's page, you'll find multiple sections with the execution's details.
|
||||
|
||||
### Summary Section
|
||||
|
||||
In the first section, you'll find a summary of the execution, including its status, workflow ID, transaction ID, and progress.
|
||||
|
||||
### Timeline
|
||||
|
||||
The timeline diagram shows you the execution step by step. You can zoom in and pan to view the entire diagram.
|
||||
|
||||
If you click on a step, you'll be shown the details in the History section.
|
||||
|
||||
### History
|
||||
|
||||
The History section shows you the execution of the steps in a linear path.
|
||||
|
||||
If you click on a step, you'll see its definition, output, and compensation input.
|
||||
|
||||
For a failed step, you'll see the error that occurred.
|
||||
|
||||
### JSON
|
||||
|
||||
The JSON section allows you to see view the execution's details as a raw JSON by clicking the <InlineIcon Icon={ArrowsPointingOut} alt="expand" /> icon.
|
||||
@@ -0,0 +1,19 @@
|
||||
---
|
||||
sidebar_position: 9
|
||||
sidebar_label: "Developer"
|
||||
---
|
||||
|
||||
export const metadata = {
|
||||
title: `Developer Settings`,
|
||||
}
|
||||
|
||||
# {metadata.title}
|
||||
|
||||
The Developer section in the settings allows you to manage developer-related settings, such as API key managements or executions.
|
||||
|
||||
---
|
||||
|
||||
## Learn More about Developer Settings
|
||||
|
||||
- [API Key Management](./api-key-management/page.mdx)
|
||||
- [Executions](./executions/page.mdx)
|
||||
@@ -0,0 +1,79 @@
|
||||
---
|
||||
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.
|
||||
@@ -0,0 +1,15 @@
|
||||
---
|
||||
sidebar_autogenerate_exclude: true
|
||||
---
|
||||
|
||||
import { CogSixTooth } from "@medusajs/icons"
|
||||
|
||||
export const metadata = {
|
||||
title: `Settings`,
|
||||
}
|
||||
|
||||
# {metadata.title}
|
||||
|
||||
You can access your store's settings by clicking the <InlineIcon Icon={CogSixTooth} alt="settings" /> icon at the top right of the page.
|
||||
|
||||
This shows a settings panel with a different sidebar to manage your profile, store details, regions, and more.
|
||||
@@ -0,0 +1,32 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
sidebar_label: "Profile"
|
||||
---
|
||||
|
||||
export const metadata = {
|
||||
title: `Manage Profile`,
|
||||
}
|
||||
|
||||
# {metadata.title}
|
||||
|
||||
In this document, you’ll learn how to manage your account including editing your account details and changing the Medusa Admin's language.
|
||||
|
||||
## Edit Profile
|
||||
|
||||
To edit your profile details:
|
||||
|
||||
1. Go to Settings → Profile.
|
||||
2. Click the Edit button.
|
||||
3. In the drawer that opens:
|
||||
- You can change language of the Medusa Admin. This doesn't change the language in the whole store or for other admin users, only for your admin dashboard.
|
||||
- Medusa collects insights to understand how you use it better and improve the product. To enable/disable collecting insights, toggle the "Usage insights" field.
|
||||
- You can edit other profile information such as your first name.
|
||||
4. Once done, click on the Save button.
|
||||
|
||||
<Note title="Tip">
|
||||
|
||||
{/* TODO add link [here](../../contribution/admin-translations.md). */}
|
||||
|
||||
Can't find your language? Learn how you can contribute by translating the admin to other languages here.
|
||||
|
||||
</Note>
|
||||
@@ -0,0 +1,37 @@
|
||||
---
|
||||
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.
|
||||
@@ -0,0 +1,83 @@
|
||||
---
|
||||
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.
|
||||
@@ -0,0 +1,41 @@
|
||||
---
|
||||
sidebar_position: 4
|
||||
---
|
||||
|
||||
export const metadata = {
|
||||
title: `Regions`,
|
||||
}
|
||||
|
||||
# {metadata.title}
|
||||
|
||||
In this document, you’ll get an overview of regions and learn about their importance in your commerce store.
|
||||
|
||||
## Overview
|
||||
|
||||
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.
|
||||
|
||||
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.
|
||||
|
||||
---
|
||||
|
||||
## Currencies in Regions
|
||||
|
||||
Each region uses one currency, and you can set prices across your store for each region.
|
||||
|
||||
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
|
||||
|
||||
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.
|
||||
|
||||
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.
|
||||
|
||||
---
|
||||
|
||||
## Learn More About Regions
|
||||
|
||||
- [Manage Regions](./manage/page.mdx)
|
||||
- [Manage Payment and Fulfillment Providers](./providers/page.mdx)
|
||||
- [Manage Shipping Options in a Region](./shipping-options/page.mdx)
|
||||
@@ -0,0 +1,29 @@
|
||||
---
|
||||
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.
|
||||
@@ -0,0 +1,74 @@
|
||||
---
|
||||
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.
|
||||
@@ -0,0 +1,63 @@
|
||||
---
|
||||
sidebar_position: 5
|
||||
sidebar_label: "Return Reasons"
|
||||
---
|
||||
|
||||
import { EllipsisHorizontal } from "@medusajs/icons"
|
||||
|
||||
export const metadata = {
|
||||
title: `Manage Return Reasons`,
|
||||
}
|
||||
|
||||
# {metadata.title}
|
||||
|
||||
In this document, you’ll learn how to add, edit, and remove return reasons.
|
||||
|
||||
## 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.
|
||||
|
||||
So, before you can handle returns, exchanges, and claims, you must create at least one return reason.
|
||||
|
||||
---
|
||||
|
||||
## Create Return Reason
|
||||
|
||||
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.
|
||||
- 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
|
||||
|
||||
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.
|
||||
5. Once you're done, click the Save button.
|
||||
|
||||
---
|
||||
|
||||
## Delete a Return Reason
|
||||
|
||||
<Note>
|
||||
|
||||
Deleting a return reason is irreversible.
|
||||
|
||||
</Note>
|
||||
|
||||
To delete a return reason:
|
||||
|
||||
1. Go to Settings → Return Reasons.
|
||||
2. Find the return reason to delete and click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at its right.
|
||||
3. Choose Delete from the dropdown.
|
||||
4. Confirm deleting the return reason by clicking the Delete button in the pop-up.
|
||||
@@ -0,0 +1,53 @@
|
||||
---
|
||||
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.
|
||||
@@ -0,0 +1,42 @@
|
||||
---
|
||||
sidebar_position: 8
|
||||
---
|
||||
|
||||
export const metadata = {
|
||||
title: `Sales Channels`,
|
||||
}
|
||||
|
||||
# {metadata.title}
|
||||
|
||||
In this document, you’ll get an overview of sales channels in Medusa.
|
||||
|
||||
## 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.
|
||||
|
||||
---
|
||||
|
||||
## How Sales Channels Work
|
||||
|
||||
Sales channels are associated with data and settings in your commerce store:
|
||||
|
||||
- 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
|
||||
|
||||
To view the available sales channels and settings, go to Settings → Sales channels.
|
||||
|
||||
The sales channels settings page shows available sales channels and allows you to manage sales channels.
|
||||
|
||||
---
|
||||
|
||||
## Learn More About Sales Channels
|
||||
|
||||
- [Manage Sales Channels](./manage/page.mdx)
|
||||
- [Manage Products in Sales Channels](./products/page.mdx)
|
||||
@@ -0,0 +1,41 @@
|
||||
---
|
||||
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.
|
||||
@@ -0,0 +1,51 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
sidebar_label: "Store"
|
||||
---
|
||||
|
||||
import { EllipsisHorizontal } from "@medusajs/icons"
|
||||
|
||||
export const metadata = {
|
||||
title: `Manage Store`,
|
||||
}
|
||||
|
||||
# {metadata.title}
|
||||
|
||||
In this document, you’ll learn how to edit the store’s details and available currencies.
|
||||
|
||||
## Edit Store Details
|
||||
|
||||
To edit the store’s details:
|
||||
|
||||
1. Go to Settings → Store.
|
||||
2. Click the Edit button in the Store Selection.
|
||||
3. In the drawer that opens, edit any of the store's details.
|
||||
4. Once you're done, click the Save button.
|
||||
|
||||
---
|
||||
|
||||
## Add Currencies
|
||||
|
||||
To add currencies to your store:
|
||||
|
||||
1. Go to Settings → Store.
|
||||
2. Click on the Add button in the Currencies section.
|
||||
3. In the form that opens, check the checkbox next to the currencies to add.
|
||||
4. Once you're done, click the Save button.
|
||||
|
||||
---
|
||||
|
||||
## Remove Currencies
|
||||
|
||||
<Note>
|
||||
|
||||
If you remove a currency, you can still add it again in the future.
|
||||
|
||||
</Note>
|
||||
|
||||
To remove a currency:
|
||||
|
||||
1. Go to Settings → Store.
|
||||
2. Under the Currencies section, check the checkbox next to the currencies you want to remove.
|
||||
3. Once you're done, press <Kbd>R</Kbd> to remove the currencies.
|
||||
4. Confirm removing the currencies by clicking the Remove button in the pop-up.
|
||||
@@ -0,0 +1,38 @@
|
||||
---
|
||||
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.
|
||||
@@ -0,0 +1,38 @@
|
||||
---
|
||||
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)
|
||||
@@ -0,0 +1,105 @@
|
||||
---
|
||||
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.
|
||||
@@ -0,0 +1,84 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
import { EllipsisHorizontal } from "@medusajs/icons"
|
||||
|
||||
export const metadata = {
|
||||
title: `Manage Invites`,
|
||||
}
|
||||
|
||||
# {metadata.title}
|
||||
|
||||
In this document, you'll learn how to manage invites in your store.
|
||||
|
||||
## Overview
|
||||
|
||||
To add a new user to your team, you must invite them. The user gets a notification of the invite to sign up, but you can also send them the invite link to sign up.
|
||||
|
||||
<Note>
|
||||
|
||||
The form of notification sent (for example, an email) depends on what's configured in your store. If you're unsure about this, contact your technical team to configure it for you.
|
||||
|
||||
</Note>
|
||||
|
||||
## Invite a User
|
||||
|
||||
To send an invite to a user:
|
||||
|
||||
1. Go to Settings → Users.
|
||||
2. Click the Invite button.
|
||||
3. Enter the user’s email and choose their role.
|
||||
4. Once done, click on the "Send invite" button.
|
||||
|
||||
<Note title="Info">
|
||||
|
||||
A user's role doesn't actually change the user's privileges. All users have the same admin privileges.
|
||||
|
||||
</Note>
|
||||
|
||||
---
|
||||
|
||||
## View Pending Invites
|
||||
|
||||
To view pending invites:
|
||||
|
||||
1. Go to Settings → Users.
|
||||
2. Click the Invite button.
|
||||
3. Below the form, you'll find a Pending Invites table with all the invites that haven't been accepted yet.
|
||||
|
||||
---
|
||||
|
||||
## Resend an Invite
|
||||
|
||||
To resend an invite to a user:
|
||||
|
||||
1. Go to Settings → Users.
|
||||
2. Click the Invite button.
|
||||
3. In the Pending Invites table, find the user to resend their invite and click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon.
|
||||
4. Choose "Resend invite" from the dropdown.
|
||||
|
||||
---
|
||||
|
||||
## Get Invite Link
|
||||
|
||||
In addition to sending the user an invite, you can copy the invite link and send it manually to the user.
|
||||
|
||||
To copy the invite link:
|
||||
|
||||
1. Go to Settings → Users.
|
||||
2. Click the Invite button.
|
||||
3. In the Pending Invites table, find the user to resend their invite and click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon.
|
||||
3. Choose “Copy invite link” from the dropdown.
|
||||
|
||||
---
|
||||
|
||||
## Revoke Invite
|
||||
|
||||
To revoke an invite:
|
||||
|
||||
1. Go to Settings → Users.
|
||||
2. Click the Invite button.
|
||||
3. In the Pending Invites table, find the user to resend their invite and click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon.
|
||||
4. Choose Revoke from the dropdown.
|
||||
5. Confirm revoking the invite by clicking the Revoke button in the pop-up.
|
||||
@@ -0,0 +1,48 @@
|
||||
---
|
||||
sidebar_position: 3
|
||||
sidebar_label: Users
|
||||
---
|
||||
|
||||
import { EllipsisHorizontal } from "@medusajs/icons"
|
||||
|
||||
export const metadata = {
|
||||
title: `Manage Users`,
|
||||
}
|
||||
|
||||
# {metadata.title}
|
||||
|
||||
In this document, you’ll learn how to invite new users, edit other users’ information, and remove users from your store.
|
||||
|
||||
## View Users
|
||||
|
||||
View admin users by going to Settings → Users.
|
||||
|
||||
---
|
||||
|
||||
## Edit a User’s Details
|
||||
|
||||
To edit a user’s details in your team:
|
||||
|
||||
1. Go to Settings → Users.
|
||||
2. Find the user in the list 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 user’s information.
|
||||
5. Once done, click the Save button.
|
||||
|
||||
---
|
||||
|
||||
## Delete a User
|
||||
|
||||
<Note type="warning">
|
||||
|
||||
Deleting a user is irreversible.
|
||||
|
||||
</Note>
|
||||
|
||||
To delete a user from your store:
|
||||
|
||||
1. Go to Settings → Users.
|
||||
2. Find the user 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.
|
||||
4. Confirm deleting the user by clicking the Delete button in the pop-up.
|
||||
Reference in new issue
Block a user