* initialized next.js project * finished markdown sections * added operation schema component * change page metadata * eslint fixes * fixes related to deployment * added response schema * resolve max stack issue * support for different property types * added support for property types * added loading for components * added more loading * type fixes * added oneOf type * removed console * fix replace with push * refactored everything * use static content for description * fixes and improvements * added code examples section * fix path name * optimizations * fixed tag navigation * add support for admin and store references * general enhancements * optimizations and fixes * fixes and enhancements * added search bar * loading enhancements * added loading * added code blocks * added margin top * add empty response text * fixed oneOf parameters * added path and query parameters * general fixes * added base path env variable * small fix for arrays * enhancements * design enhancements * general enhancements * fix isRequired * added enum values * enhancements * general fixes * general fixes * changed oas generation script * additions to the introduction section * added copy button for code + other enhancements * fix response code block * fix metadata * formatted store introduction * move sidebar logic to Tags component * added test env variables * fix code block bug * added loading animation * added expand param + loading * enhance operation loading * made responsive + improvements * added loading provider * fixed loading * adjustments for small devices * added sidebar label for endpoints * added feedback component * fixed analytics * general fixes * listen to scroll for other headings * added sample env file * update api ref files + support new fields * fix for external docs link * added new sections * fix last item in sidebar not showing * move docs content to www/docs * change redirect url * revert change * resolve build errors * configure rewrites * changed to environment variable url * revert changing environment variable name * add environment variable for API path * fix links * fix tailwind settings * remove vercel file * reconfigured api route * move api page under api * fix page metadata * fix external link in navigation bar * update api spec * updated api specs * fixed google lint error * add max-height on request samples * add padding before loading * fix for one of name * fix undefined types * general fixes * remove response schema example * redesigned navigation bar * redesigned sidebar * fixed up paddings * added feedback component + report issue * fixed up typography, padding, and general styling * redesigned code blocks * optimization * added error timeout * fixes * added indexing with algolia + fixes * fix errors with algolia script * redesign operation sections * fix heading scroll * design fixes * fix padding * fix padding + scroll issues * fix scroll issues * improve scroll performance * fixes for safari * optimization and fixes * fixes to docs + details animation * padding fixes for code block * added tab animation * fixed incorrect link * added selection styling * fix lint errors * redesigned details component * added detailed feedback form * api reference fixes * fix tabs * upgrade + fixes * updated documentation links * optimizations to sidebar items * fix spacing in sidebar item * optimizations and fixes * fix endpoint path styling * remove margin * final fixes * change margin on small devices * generated OAS * fixes for mobile * added feedback modal * optimize dark mode button * fixed color mode useeffect * minimize dom size * use new style system * radius and spacing design system * design fixes * fix eslint errors * added meta files * change cron schedule * fix docusaurus configurations * added operating system to feedback data * change content directory name * fixes to contribution guidelines * revert renaming content * added api-reference to documentation workflow * fixes for search * added dark mode + fixes * oas fixes * handle bugs * added code examples for clients * changed tooltip text * change authentication to card * change page title based on selected section * redesigned mobile navbar * fix icon colors * fix key colors * fix medusa-js installation command * change external regex in algolia * change changeset * fix padding on mobile * fix hydration error * update depedencies
71 lines
3.1 KiB
Plaintext
71 lines
3.1 KiB
Plaintext
---
|
||
sidebar_position: 2
|
||
description: 'This user guide explains how to manage regions on the Medusa admin. Learn how to create and edit regions.'
|
||
addHowToData: true
|
||
---
|
||
|
||
import UiIcon from '@site/src/components/UiIcon';
|
||
|
||
# Manage Regions
|
||
|
||
In this document, you’ll learn how to view and manage regions in your Medusa Admin.
|
||
|
||
## View Regions
|
||
|
||
To view your regions:
|
||
|
||
1. Click on Settings in the sidebar.
|
||
2. Choose Regions from the list of settings.
|
||
|
||
This opens the Regions page where you can find a list of regions.
|
||
|
||
---
|
||
|
||
## Create a Region
|
||
|
||
To create a region:
|
||
|
||
1. Go to Settings → Regions.
|
||
2. Click on the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999131/Medusa%20Docs/UI%20Icons/1hL8NiW_lqmjcq.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999150/Medusa%20Docs/UI%20Icons/8LtkPqW_jyqz5i.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
|
||
|
||
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.
|
||
|
||
:::
|
||
|
||
After you click save, the region will be created and you can see it in the list on the left.
|
||
|
||
---
|
||
|
||
## 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. 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.
|
||
|
||
---
|
||
|
||
## Delete a Region
|
||
|
||
:::warning
|
||
|
||
If you delete a region, you will not be able to restore it or its data. Data related to the region such as tax settings will also be deleted. Prices using the currencies of this region will remain available.
|
||
|
||
:::
|
||
|
||
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 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. |