api-ref: custom API reference (#4770)
* 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
This commit is contained in:
Shahed Nasser
@@ -0,0 +1,9 @@
|
||||
{
|
||||
"position": 9,
|
||||
"collapsed": false,
|
||||
"link": null,
|
||||
"label": "Regions",
|
||||
"customProps": {
|
||||
"sidebar_is_group_headline": true
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,36 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
description: 'Medusa admin allows merchants to manage regions. Regions represent different countries within an ecommerce store.'
|
||||
---
|
||||
|
||||
# Regions Overview
|
||||
|
||||
In this document, you’ll get an overview of regions and learn about their importance in your ecommerce store.
|
||||
|
||||
## Overview
|
||||
|
||||
Regions are essential to your ecommerce store. They allow you to specify available currencies, payment providers, fulfillment providers, tax rates, and more for different regions.
|
||||
|
||||
Regions represent different countries that your ecommerce store serves customers in. You can combine more than one country in the same region and give them the same settings, or you can create a different region for each country and add settings specific to each of them.
|
||||
|
||||
---
|
||||
|
||||
## Currencies in Regions
|
||||
|
||||
Each region uses one currency. Having more than one region with each having different currencies allows you to set prices and amounts throughout your ecommerce store for each currency. For example, you can specify prices for a product for each currency you support.
|
||||
|
||||
---
|
||||
|
||||
## How Customers Use Regions
|
||||
|
||||
When a customer browses your storefront, they can choose the region based on their location. Then, different pricing, shipping providers, payment providers, and taxes will be available and applied 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.mdx)
|
||||
- [Manage Payment and Fulfillment Providers](./providers.mdx)
|
||||
- [Manage Shipping Options in a Region](./shipping-options.mdx)
|
||||
@@ -0,0 +1,71 @@
|
||||
---
|
||||
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.
|
||||
@@ -0,0 +1,46 @@
|
||||
---
|
||||
sidebar_position: 3
|
||||
sidebar_label: Manage Providers
|
||||
description: 'This user guide explains how to manage payment and fulfillment providers in a region on the Medusa admin.'
|
||||
addHowToData: true
|
||||
---
|
||||
|
||||
import UiIcon from '@site/src/components/UiIcon';
|
||||
|
||||
# Manage Payment and Fulfillment Providers in a Region
|
||||
|
||||
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://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 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://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 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.
|
||||
@@ -0,0 +1,117 @@
|
||||
---
|
||||
sidebar_position: 4
|
||||
sidebar_label: Manage Shipping Options
|
||||
description: 'This user guide explains how to manage shipping options in a region on the Medusa admin.'
|
||||
addHowToData: true
|
||||
---
|
||||
|
||||
import UiIcon from '@site/src/components/UiIcon';
|
||||
|
||||
# Manage Shipping Options in a Region
|
||||
|
||||
In this document, you’ll learn how to manage a region’s shipping options in your Medusa Admin.
|
||||
|
||||
## Types of Shipping Options
|
||||
|
||||
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.
|
||||
|
||||
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
|
||||
|
||||
To add a shipping option:
|
||||
|
||||
1. Go to Settings → Regions.
|
||||
2. Select a region to edit.
|
||||
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:
|
||||
- **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 Save.
|
||||
|
||||
### Edit a Shipping Option
|
||||
|
||||
To edit a shipping option:
|
||||
|
||||
1. Go to Settings → Regions.
|
||||
2. Select a region to edit.
|
||||
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
|
||||
|
||||
:::warning
|
||||
|
||||
If you delete a shipping option, you can’t restore it or its data, customers can’t use it during checkout, and admins can’t use it for draft orders.
|
||||
|
||||
:::
|
||||
|
||||
To delete a shipping option:
|
||||
|
||||
1. Go to Settings → Regions.
|
||||
2. Select a region to edit.
|
||||
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.
|
||||
|
||||
---
|
||||
|
||||
## Manage Return Shipping Options in a Region
|
||||
|
||||
### Add Return Shipping Option to a Region
|
||||
|
||||
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 on the right side.
|
||||
4. Click on the Add Option button.
|
||||
5. A new window will open with a form with the following fields:
|
||||
- **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
|
||||
|
||||
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 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.
|
||||
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
|
||||
|
||||
:::warning
|
||||
|
||||
If you delete a return shipping option, you can’t restore it or its data, customers can’t use it when they request a return or an exchange, and admins can’t use it when requesting a return for an order or registering an exchange or claim for an order.
|
||||
|
||||
:::
|
||||
|
||||
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 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.
|
||||
Reference in New Issue
Block a user