This PR includes documentation that preps for v2 docs (but doesn't introduce new docs). _Note: The number of file changes in the PR is due to find-and-replace within the `references` which is unavoidable. Let me know if I should move it to another PR._ ## Changes - Change Medusa version in base OAS used for v2. - Fix to docblock generator related to not catching all path parameters. - Added typedoc plugin that generates ER Diagrams, which will be used specifically for data model references in commerce modules. - Changed OAS tool to output references in `www/apps/api-reference/specs-v2` directory when the `--v2` option is used. - Added a version switcher to the API reference to switch between V1 and V2. This switcher is enabled by an environment variable, so it won't be visible/usable at the moment. - Upgraded docusaurus to v3.0.1 - Added new Vale rules to ensure correct spelling of Medusa Admin and module names. - Added new components to the `docs-ui` package that will be used in future documentation changes.
2.5 KiB
sidebar_position, description, addHowToData
| sidebar_position | description | addHowToData |
|---|---|---|
| 2 | This user guide explains how to manage taxes on the Medusa Admin. Learn how to edit their configurations. | true |
Manage Taxes
In this document, you’ll learn how to view and manage taxes in your Medusa Admin.
View Taxes
To view taxes:
- Click on Settings in the sidebar.
- Choose Taxes from the list of settings.
This opens the Taxes page where you can find a list of regions. This is because every time you create a region, a default tax rate is associated with that region.
Edit a Region’s Taxes
To edit a region’s taxes:
- Go to Settings → Taxes.
- Click on the region you want to edit the taxes for in the Regions section.
This opens a Details form to the right where you can edit the taxes calculation settings and manage the tax rates.
Change Tax Calculation Settings
:::tip
The save button only appears when you make changes to the settings.
:::
Change Tax Provider
The tax provider that you choose defines how taxes are calculated for products and shipping options on checkout. Medusa provides a default tax provider with the name “System Tax Provider”.
If you have integrated a custom tax provider and want to use it to calculate taxes in a region:
- Go to Settings → Taxes.
- Select a region whose taxes you want to edit.
- Change the selected tax provider in the Tax Provider field.
- Click Save at the bottom right.
Disable Automatic Taxes Calculation
By default, taxes are calculated automatically by Medusa. They’re calculated in different places during checkout, such as when a shipping method is chosen or when a new product is added to the cart.
If you use a third-party tax provider and you want to avoid sending too many requests to the tax provider, you can disable this behavior.
:::warning
If you switch off automatic taxes calculation, the taxes must be calculated manually on checkout. If you’re unsure how that works, please contact your technical team.
:::
To disable automatic taxes calculation:
- Go to Settings → Taxes.
- Select a region whose tax you want to edit.
- Check off the “Calculate taxes automatically” input.
- Click Save at the bottom right.
Disable Taxes for Gift Cards
To disable applying taxes for Gift Cards:
- Go to Settings → Taxes.
- Select a region whose tax you want to edit.
- Check off the “Apply tax to gift cards” input.
- Click Save at the bottom right.
Enabling taxes for Gift Cards follows the same process, except you check the input.