docs: tax provider updates for next release (#12431)
* docs: tax provider updates for next release * change images * fix vale error * fix vale errors * generate
This commit is contained in:
+18393
-18224
File diff suppressed because it is too large
Load Diff
@@ -1,16 +1,16 @@
|
||||
import { CardList } from "docs-ui"
|
||||
|
||||
export const metadata = {
|
||||
title: `Auth Providers`,
|
||||
title: `Auth Module Provider`,
|
||||
}
|
||||
|
||||
# {metadata.title}
|
||||
|
||||
In this document, you’ll learn how the Auth Module handles authentication using providers.
|
||||
In this guide, you’ll learn about the Auth Module Provider and how it's used.
|
||||
|
||||
## What's an Auth Module Provider?
|
||||
## What is an Auth Module Provider?
|
||||
|
||||
An auth module provider handles authenticating customers and users, either using custom logic or by integrating a third-party service.
|
||||
An Auth Module Provider handles authenticating customers and users, either using custom logic or by integrating a third-party service.
|
||||
|
||||
For example, the EmailPass Auth Module Provider authenticates a user using their email and password, whereas the Google Auth Module Provider authenticates users using their Google account.
|
||||
|
||||
@@ -35,9 +35,19 @@ For example, the EmailPass Auth Module Provider authenticates a user using their
|
||||
|
||||
---
|
||||
|
||||
## How to Create an Auth Module Provider?
|
||||
|
||||
An Auth Module Provider is a module whose service extends the `AbstractAuthModuleProvider` imported from `@medusajs/framework/utils`.
|
||||
|
||||
The module can have multiple auth provider services, where each is registered as a separate auth provider.
|
||||
|
||||
Refer to the [Create Auth Module Provider](/references/auth/provider) guide to learn how to create an Auth Module Provider.
|
||||
|
||||
---
|
||||
|
||||
## Configure Allowed Auth Providers of Actor Types
|
||||
|
||||
By default, users of all actor types can authenticate with all installed auth module providers.
|
||||
By default, users of all actor types can authenticate with all installed Auth Module Providers.
|
||||
|
||||
To restrict the auth providers used for actor types, use the [authMethodsPerActor option](!docs!/learn/configurations/medusa-config#httpauthMethodsPerActor) in Medusa's configurations:
|
||||
|
||||
@@ -61,9 +71,3 @@ module.exports = defineConfig({
|
||||
When you specify the `authMethodsPerActor` configuration, it overrides the default. So, if you don't specify any providers for an actor type, users of that actor type can't authenticate with any provider.
|
||||
|
||||
</Note>
|
||||
|
||||
---
|
||||
|
||||
## How to Create an Auth Module Provider
|
||||
|
||||
Refer to [this guide](/references/auth/provider) to learn how to create an auth module provider.
|
||||
|
||||
@@ -4,7 +4,7 @@ export const metadata = {
|
||||
|
||||
# {metadata.title}
|
||||
|
||||
In this document, you’ll learn what a fulfillment module provider is.
|
||||
In this guide, you’ll learn about the Fulfillment Module Provider and how it's used.
|
||||
|
||||
<Note title="Looking for no-code docs?">
|
||||
|
||||
@@ -12,22 +12,75 @@ Refer to this [Medusa Admin User Guide](!user-guide!/settings/locations-and-ship
|
||||
|
||||
</Note>
|
||||
|
||||
## What’s a Fulfillment Module Provider?
|
||||
## What is a Fulfillment Module Provider?
|
||||
|
||||
A fulfillment module provider handles fulfilling items, typically using a third-party integration.
|
||||
A Fulfillment Module Provider handles fulfilling items, typically using a third-party integration.
|
||||
|
||||
Fulfillment module providers registered in the Fulfillment Module's [options](../module-options/page.mdx) are stored and represented by the [FulfillmentProvider data model](/references/fulfillment/models/FulfillmentProvider).
|
||||
Fulfillment Module Providers registered in the Fulfillment Module's [options](../module-options/page.mdx) are stored and represented by the [FulfillmentProvider data model](/references/fulfillment/models/FulfillmentProvider).
|
||||
|
||||

|
||||
|
||||
---
|
||||
|
||||
## Configure Fulfillment Providers
|
||||
## Default Fulfillment Provider
|
||||
|
||||
The Fulfillment Module accepts a `providers` option that allows you to register providers in your application.
|
||||
Medusa provides a Manual Fulfillment Provider that acts as a placeholder fulfillment provider. It doesn't process fulfillment and delegates that to the merchant.
|
||||
|
||||
Learn more about the `providers` option in [this documentation](../module-options/page.mdx).
|
||||
This provider is installed by default in your application and you can use it to fulfill items manually.
|
||||
|
||||
<Note title="Tip">
|
||||
|
||||
The identifier of the manual fulfillment provider is `fp_manual_manual`.
|
||||
|
||||
</Note>
|
||||
|
||||
---
|
||||
|
||||
## How to Create a Fulfillment Provider?
|
||||
## How to Create a Custom Fulfillment Provider?
|
||||
|
||||
Refer to [this guide](/references/fulfillment/provider) to learn how to create a fulfillment module provider.
|
||||
A Fulfillment Module Provider is a module whose service implements the `IFulfillmentProvider` imported from `@medusajs/framework/types`.
|
||||
|
||||
The module can have multiple fulfillment provider services, where each are registered as separate fulfillment providers.
|
||||
|
||||
Refer to the [Create Fulfillment Module Provider](/references/fulfillment/provider) guide to learn how to create a Fulfillment Module Provider.
|
||||
|
||||
{/* TODO add link to user guide */}
|
||||
|
||||
After you create a fulfillment provider, you can choose it as the default Fulfillment Module Provider for a stock location in the Medusa Admin dashboard.
|
||||
|
||||
---
|
||||
|
||||
## How are Fulfillment Providers Registered?
|
||||
|
||||
### Configure Fulfillment Module's Providers
|
||||
|
||||
The Fulfillment Module accepts a `providers` option that allows you to configure the providers registered in your application.
|
||||
|
||||
Learn more about this option in the [Module Options](../module-options/page.mdx) guide.
|
||||
|
||||
### Registration on Application Start
|
||||
|
||||
When the Medusa application starts, it registers the Fulfillment Module Providers defined in the `providers` option of the Fulfillment Module.
|
||||
|
||||
For each Fulfillment Module Provider, the Medusa application finds all fulfillment provider services defined in them to register.
|
||||
|
||||
### FulfillmentProvider Data Model
|
||||
|
||||
A registered fulfillment provider is represented by the [FulfillmentProvider data model](/references/fulfillment/models/FulfillmentProvider) in the Medusa application.
|
||||
|
||||
This data model is used to reference a service in the Fulfillment Module Provider and determine whether it's installed in the application.
|
||||
|
||||

|
||||
|
||||
The `FulfillmentProvider` data model has the following properties:
|
||||
|
||||
- `id`: The unique identifier of the fulfillment provider. The ID's format is `fp_{identifier}_{id}`, where:
|
||||
- `identifier` is the value of the `identifier` property in the Fulfillment Module Provider's service.
|
||||
- `id` is the value of the `id` property of the Fulfillment Module Provider in `medusa-config.ts`.
|
||||
- `is_enabled`: A boolean indicating whether the fulfillment provider is enabled.
|
||||
|
||||
### How to Remove a Fulfillment Provider?
|
||||
|
||||
You can remove a registered fulfillment provider from the Medusa application by removing it from the `providers` option in the Fulfillment Module's configuration.
|
||||
|
||||
Then, the next time the Medusa application starts, it will set the `is_enabled` property of the `FulfillmentProvider`'s record to `false`. This allows you to re-enable the fulfillment provider later if needed by adding it back to the `providers` option.
|
||||
|
||||
@@ -6,7 +6,7 @@ export const metadata = {
|
||||
|
||||
# {metadata.title}
|
||||
|
||||
In this document, you’ll learn what a payment module provider is.
|
||||
In this guide, you’ll learn about the Payment Module Provider and how it's used.
|
||||
|
||||
<Note title="Looking for no-code docs?">
|
||||
|
||||
@@ -14,14 +14,18 @@ Refer to this [Medusa Admin User Guide](!user-guide!/settings/regions) to learn
|
||||
|
||||
</Note>
|
||||
|
||||
## What's a Payment Module Provider?
|
||||
---
|
||||
|
||||
A payment module provider registers a payment provider that handles payment processing in the Medusa application. It integrates third-party payment providers, such as Stripe.
|
||||
## What is a Payment Module Provider?
|
||||
|
||||
The Payment Module Provider handles payment processing in the Medusa application. It integrates third-party payment services, such as [Stripe](./stripe/page.mdx).
|
||||
|
||||
To authorize a payment amount with a payment provider, a payment session is created and associated with that payment provider. The payment provider is then used to handle the authorization.
|
||||
|
||||
After the payment session is authorized, the payment provider is associated with the resulting payment and handles its payment processing, such as to capture or refund payment.
|
||||
|
||||

|
||||
|
||||
### List of Payment Module Providers
|
||||
|
||||
<CardList
|
||||
@@ -33,35 +37,63 @@ After the payment session is authorized, the payment provider is associated with
|
||||
]}
|
||||
/>
|
||||
|
||||
|
||||
---
|
||||
|
||||
## System Payment Provider
|
||||
### Default Payment Provider
|
||||
|
||||
The Payment Module provides a `system` payment provider that acts as a placeholder payment provider.
|
||||
|
||||
It doesn’t handle payment processing and delegates that to the merchant. It acts similarly to a cash-on-delivery (COD) payment method.
|
||||
|
||||
<Note title="Tip">
|
||||
|
||||
The identifier of the system payment provider is `pp_system`.
|
||||
|
||||
</Note>
|
||||
|
||||
---
|
||||
|
||||
## How are Payment Providers Created?
|
||||
## How to Create a Custom Payment Provider?
|
||||
|
||||
A payment provider is a module whose main service extends the `AbstractPaymentProvider` imported from `@medusajs/framework/utils`.
|
||||
|
||||
The module can have multiple payment provider services, where each is registered as a separate payment provider.
|
||||
|
||||
Refer to [this guide](/references/payment/provider) on how to create a payment provider for the Payment Module.
|
||||
|
||||
---
|
||||
|
||||
## Configure Payment Providers
|
||||
|
||||
The Payment Module accepts a `providers` option that allows you to register providers in your application.
|
||||
|
||||
Learn more about this option in [this documentation](../module-options/page.mdx#providers).
|
||||
After you create a payment provider, you can enable it as a payment provider in a region using the [Medusa Admin dashboard](!user-guide!/settings/regions).
|
||||
|
||||
---
|
||||
|
||||
## PaymentProvider Data Model
|
||||
## How are Payment Providers Registered?
|
||||
|
||||
When the Medusa application starts and registers the payment providers, it also creates a record of the `PaymentProvider` data model if none exists.
|
||||
### Configure Payment Module's Providers
|
||||
|
||||
This data model is used to reference a payment provider and determine whether it’s installed in the application.
|
||||
The Payment Module accepts a `providers` option that allows you to configure the providers registered in your application.
|
||||
|
||||
Learn more about this option in the [Module Options](../module-options/page.mdx) guide.
|
||||
|
||||
### Registration on Application Start
|
||||
|
||||
When the Medusa application starts, it registers the Payment Module Providers defined in the `providers` option of the Payment Module.
|
||||
|
||||
For each Payment Module Provider, the Medusa application finds all payment provider services defined in them to register.
|
||||
|
||||
### PaymentProvider Data Model
|
||||
|
||||
A registered payment provider is represented by the [PaymentProvider data model](/references/payment/models/PaymentProvider) in the Medusa application.
|
||||
|
||||

|
||||
|
||||
This data model is used to reference a service in the Payment Module Provider and determine whether it's installed in the application.
|
||||
|
||||
The `PaymentProvider` data model has the following properties:
|
||||
|
||||
- `id`: The unique identifier of the Payment Module Provider. The ID's format is `pp_{identifier}_{id}`, where:
|
||||
- `identifier` is the value of the `identifier` property in the Payment Module Provider's service.
|
||||
- `id` is the value of the `id` property of the Payment Module Provider in `medusa-config.ts`.
|
||||
- `is_enabled`: A boolean indicating whether the payment provider is enabled.
|
||||
|
||||
### How to Remove a Payment Provider?
|
||||
|
||||
If you remove a payment provider from the `providers` option, the Medusa application will not remove the associated `PaymentProvider` data model record.
|
||||
|
||||
Instead, the Medusa application will set the `is_enabled` property of the `PaymentProvider`'s record to `false`. This allows you to re-enable the payment provider later if needed by adding it back to the `providers` option.
|
||||
|
||||
@@ -10,11 +10,11 @@ export const metadata = {
|
||||
|
||||
# {metadata.title}
|
||||
|
||||
In this document, you'll learn about the options of the Tax Module.
|
||||
In this guide, you'll learn about the options of the Tax Module.
|
||||
|
||||
## providers
|
||||
|
||||
The `providers` option is an array of either tax module providers or path to a file that defines a tax provider.
|
||||
The `providers` option is an array of either [tax module providers](../tax-provider/page.mdx) or path to a file that defines a tax provider.
|
||||
|
||||
When the Medusa application starts, these providers are registered and can be used to retrieve tax lines.
|
||||
|
||||
|
||||
@@ -27,6 +27,7 @@ Learn more about why modules are isolated in [this documentation](!docs!/learn/f
|
||||
- [Tax Settings Per Region](./tax-region/page.mdx): Set different tax settings for each tax region.
|
||||
- [Tax Rates and Rules](./tax-rates-and-rules/page.mdx): Manage each region's default tax rates and override them with conditioned tax rates.
|
||||
- [Retrieve Tax Lines for carts and orders](./tax-calculation-with-provider/page.mdx): Calculate and retrieve the tax lines of a cart or order's line items and shipping methods with tax providers.
|
||||
- [Custom Tax Providers](./tax-provider/page.mdx): Create custom tax providers to calculate tax lines differently for each tax region.
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -4,7 +4,7 @@ export const metadata = {
|
||||
|
||||
# {metadata.title}
|
||||
|
||||
In this document, you’ll learn how tax lines are calculated and what a tax provider is.
|
||||
In this guide, you’ll learn how tax lines are calculated using the tax provider.
|
||||
|
||||
## Tax Lines Calculation
|
||||
|
||||
@@ -64,16 +64,8 @@ The method returns tax lines for the line item and shipping methods. For example
|
||||
|
||||
## Using the Tax Provider in the Calculation
|
||||
|
||||
The tax lines retrieved by the `getTaxLines` method are actually retrieved from the tax region’s provider.
|
||||
The tax lines retrieved by the `getTaxLines` method are actually retrieved from the tax region’s [Tax Module Provider](../tax-provider/page.mdx).
|
||||
|
||||
A tax module provider whose main service implements the logic to shape tax lines. Each tax region has a tax provider.
|
||||
A tax module implements the logic to shape tax lines. Each tax region uses a tax provider.
|
||||
|
||||
The Tax Module provides a `system` tax provider that only transforms calculated item and shipping tax rates into the required return type.
|
||||
|
||||
{/* ---
|
||||
|
||||
TODO add once tax provider guide is updated + add module providers match other modules.
|
||||
|
||||
## Create Tax Provider
|
||||
|
||||
Refer to [this guide](/modules/tax/provider) to learn more about creating a tax provider. */}
|
||||
Learn more about tax providers, configuring, and creating them in the [Tax Module Provider](../tax-provider/page.mdx) guide.
|
||||
|
||||
@@ -0,0 +1,84 @@
|
||||
export const metadata = {
|
||||
title: `Tax Module Provider`,
|
||||
}
|
||||
|
||||
# {metadata.title}
|
||||
|
||||
In this guide, you’ll learn about the Tax Module Provider and how it's used.
|
||||
|
||||
<Note title="Looking for no-code docs?">
|
||||
|
||||
Refer to this [Medusa Admin User Guide](!user-guide!/settings/tax-regions) to learn how to manage tax provider of a tax region using the dashboard.
|
||||
|
||||
</Note>
|
||||
|
||||
## What is a Tax Module Provider?
|
||||
|
||||
The Tax Module Provider handles tax line calculations in the Medusa application. It integrates third-party tax services, such as TaxJar, or implements custom tax calculation logic.
|
||||
|
||||
The Medusa application uses the Tax Module Provider whenever it needs to calculate tax lines for a cart or order, or when you [calculate the tax lines using the Tax Module's service](../tax-calculation-with-provider/page.mdx).
|
||||
|
||||

|
||||
|
||||
---
|
||||
|
||||
## Default Tax Provider
|
||||
|
||||
The Tax Module provides a `system` tax provider that acts as a placeholder tax provider. It performs basic tax calculation, as you can see in the [Create Tax Module Provider](/references/tax/provider#gettaxlines) guide.
|
||||
|
||||
This provider is installed by default in your application and you can use it with tax regions.
|
||||
|
||||
<Note title="Tip">
|
||||
|
||||
The identifier of the system tax provider is `tp_system`.
|
||||
|
||||
</Note>
|
||||
|
||||
---
|
||||
|
||||
## How to Create a Custom Tax Provider?
|
||||
|
||||
A Tax Module Provider is a module whose service implements the `ITaxProvider` imported from `@medusajs/framework/types`.
|
||||
|
||||
The module can have multiple tax provider services, where each are registered as separate tax providers.
|
||||
|
||||
Refer to the [Create Tax Module Provider](/references/tax/provider) guide to learn how to create a Tax Module Provider.
|
||||
|
||||
After you create a tax provider, you can choose it as the default Tax Module Provider for a region in the [Medusa Admin dashboard](!user-guide!/settings/tax-regions).
|
||||
|
||||
---
|
||||
|
||||
## How are Tax Providers Registered?
|
||||
|
||||
### Configure Tax Module's Providers
|
||||
|
||||
The Tax Module accepts a `providers` option that allows you to configure the providers registered in your application.
|
||||
|
||||
Learn more about this option in the [Module Options](../module-options/page.mdx) guide.
|
||||
|
||||
### Registration on Application Start
|
||||
|
||||
When the Medusa application starts, it registers the Tax Module Providers defined in the `providers` option of the Tax Module.
|
||||
|
||||
For each Tax Module Provider, the Medusa application finds all tax provider services defined in them to register.
|
||||
|
||||
### TaxProvider Data Model
|
||||
|
||||
A registered tax provider is represented by the [TaxProvider data model](/references/tax/models/TaxProvider) in the Medusa application.
|
||||
|
||||
This data model is used to reference a service in the Tax Module Provider and determine whether it's installed in the application.
|
||||
|
||||

|
||||
|
||||
The `TaxProvider` data model has the following properties:
|
||||
|
||||
- `id`: The unique identifier of the tax provider. The ID's format is `tp_{identifier}_{id}`, where:
|
||||
- `identifier` is the value of the `identifier` property in the Tax Module Provider's service.
|
||||
- `id` is the value of the `id` property of the Tax Module Provider in `medusa-config.ts`.
|
||||
- `is_enabled`: A boolean indicating whether the tax provider is enabled.
|
||||
|
||||
### How to Remove a Tax Provider?
|
||||
|
||||
You can remove a registered tax provider from the Medusa application by removing it from the `providers` option in the Tax Module's configuration.
|
||||
|
||||
Then, the next time the Medusa application starts, it will set the `is_enabled` property of the `TaxProvider`'s record to `false`. This allows you to re-enable the tax provider later if needed by adding it back to the `providers` option.
|
||||
@@ -18,4 +18,24 @@ A tax region, represented by the [TaxRegion data model](/references/tax/models/T
|
||||
|
||||
Tax regions can inherit settings and rules from a parent tax region.
|
||||
|
||||
Each tax region has tax rules and a tax provider.
|
||||
---
|
||||
|
||||
## Tax Rules in a Tax Region
|
||||
|
||||
Tax rules define the tax rates and behavior within a tax region. They specify:
|
||||
|
||||
- The tax rate percentage.
|
||||
- Which products the tax applies to.
|
||||
- Other custom rules to determine tax applicability.
|
||||
|
||||
Learn more about tax rules in the [Tax Rates and Rules](../tax-rates-and-rules/page.mdx) guide.
|
||||
|
||||
---
|
||||
|
||||
## Tax Provider
|
||||
|
||||
Each tax region can have a default tax provider. The tax provider is responsible for calculating the tax lines for carts and orders in that region.
|
||||
|
||||
You can use Medusa's default tax provider or create a custom one, allowing you to integrate with third-party tax services or implement your own tax calculation logic.
|
||||
|
||||
Learn more about tax providers in the [Tax Provider](../tax-provider/page.mdx) guide.
|
||||
@@ -49,7 +49,7 @@ export const generatedEditDates = {
|
||||
"app/commerce-modules/payment/payment-collection/page.mdx": "2024-10-09T10:56:49.510Z",
|
||||
"app/commerce-modules/payment/payment-flow/page.mdx": "2025-01-16T10:43:25.958Z",
|
||||
"app/commerce-modules/payment/payment-provider/stripe/page.mdx": "2025-04-25T12:43:03.674Z",
|
||||
"app/commerce-modules/payment/payment-provider/page.mdx": "2025-02-26T11:25:50.645Z",
|
||||
"app/commerce-modules/payment/payment-provider/page.mdx": "2025-05-09T11:29:10.212Z",
|
||||
"app/commerce-modules/payment/payment-session/page.mdx": "2024-10-09T10:58:00.960Z",
|
||||
"app/commerce-modules/payment/webhook-events/page.mdx": "2024-11-19T11:45:02.167Z",
|
||||
"app/commerce-modules/payment/page.mdx": "2025-04-17T08:48:11.702Z",
|
||||
@@ -88,11 +88,11 @@ export const generatedEditDates = {
|
||||
"app/commerce-modules/store/page.mdx": "2025-04-17T08:48:34.141Z",
|
||||
"app/commerce-modules/tax/_events/_events-table/page.mdx": "2024-07-03T19:27:13+03:00",
|
||||
"app/commerce-modules/tax/_events/page.mdx": "2024-07-03T19:27:13+03:00",
|
||||
"app/commerce-modules/tax/module-options/page.mdx": "2024-10-15T14:35:46.117Z",
|
||||
"app/commerce-modules/tax/tax-calculation-with-provider/page.mdx": "2024-10-15T14:43:00.700Z",
|
||||
"app/commerce-modules/tax/module-options/page.mdx": "2025-05-09T11:31:32.715Z",
|
||||
"app/commerce-modules/tax/tax-calculation-with-provider/page.mdx": "2025-05-09T11:31:02.958Z",
|
||||
"app/commerce-modules/tax/tax-rates-and-rules/page.mdx": "2025-02-26T11:35:15.214Z",
|
||||
"app/commerce-modules/tax/tax-region/page.mdx": "2025-02-26T11:34:21.259Z",
|
||||
"app/commerce-modules/tax/page.mdx": "2025-04-17T08:48:12.479Z",
|
||||
"app/commerce-modules/tax/page.mdx": "2025-05-09T11:29:31.846Z",
|
||||
"app/commerce-modules/user/_events/_events-table/page.mdx": "2024-07-03T19:27:13+03:00",
|
||||
"app/commerce-modules/user/_events/page.mdx": "2024-07-03T19:27:13+03:00",
|
||||
"app/commerce-modules/user/module-options/page.mdx": "2024-09-30T08:43:53.171Z",
|
||||
@@ -6246,5 +6246,6 @@ export const generatedEditDates = {
|
||||
"references/events/events.Region/page.mdx": "2025-05-07T15:35:18.145Z",
|
||||
"references/events/events.Sales_Channel/page.mdx": "2025-05-07T15:35:18.138Z",
|
||||
"references/events/events.User/page.mdx": "2025-05-07T15:35:18.135Z",
|
||||
"app/commerce-modules/tax/tax-provider/page.mdx": "2025-05-09T11:25:27.906Z",
|
||||
"app/how-to-tutorials/tutorials/saved-payment-methods/page.mdx": "2025-05-13T07:40:15.969Z"
|
||||
}
|
||||
@@ -615,6 +615,10 @@ export const filesMap = [
|
||||
"filePath": "/www/apps/resources/app/commerce-modules/tax/tax-calculation-with-provider/page.mdx",
|
||||
"pathname": "/commerce-modules/tax/tax-calculation-with-provider"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/app/commerce-modules/tax/tax-provider/page.mdx",
|
||||
"pathname": "/commerce-modules/tax/tax-provider"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/app/commerce-modules/tax/tax-rates-and-rules/page.mdx",
|
||||
"pathname": "/commerce-modules/tax/tax-rates-and-rules"
|
||||
|
||||
@@ -445,7 +445,7 @@ const generatedgeneratedCommerceModulesSidebarSidebar = {
|
||||
"isPathHref": true,
|
||||
"type": "link",
|
||||
"path": "/commerce-modules/auth/auth-providers",
|
||||
"title": "Auth Providers",
|
||||
"title": "Auth Module Provider",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -489,7 +489,7 @@ const generatedgeneratedCommerceModulesSidebarSidebar = {
|
||||
"isPathHref": true,
|
||||
"type": "link",
|
||||
"path": "/references/auth/provider",
|
||||
"title": "Create Auth Provider Module",
|
||||
"title": "Create Auth Provider",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -3323,7 +3323,7 @@ const generatedgeneratedCommerceModulesSidebarSidebar = {
|
||||
"isPathHref": true,
|
||||
"type": "link",
|
||||
"path": "/commerce-modules/fulfillment/fulfillment-provider",
|
||||
"title": "Fulfillment Provider",
|
||||
"title": "Fulfillment Module Provider",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -3383,7 +3383,7 @@ const generatedgeneratedCommerceModulesSidebarSidebar = {
|
||||
"isPathHref": true,
|
||||
"type": "link",
|
||||
"path": "/references/fulfillment/provider",
|
||||
"title": "Create Fulfillment Provider Module",
|
||||
"title": "Create Fulfillment Provider",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -9046,7 +9046,7 @@ const generatedgeneratedCommerceModulesSidebarSidebar = {
|
||||
"isPathHref": true,
|
||||
"type": "link",
|
||||
"path": "/commerce-modules/payment/payment-provider",
|
||||
"title": "Payment Provider Module",
|
||||
"title": "Payment Module Provider",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -15850,12 +15850,20 @@ const generatedgeneratedCommerceModulesSidebarSidebar = {
|
||||
"title": "Tax Rates and Rules",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"loaded": true,
|
||||
"isPathHref": true,
|
||||
"type": "link",
|
||||
"path": "/commerce-modules/tax/tax-provider",
|
||||
"title": "Tax Module Providers",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"loaded": true,
|
||||
"isPathHref": true,
|
||||
"type": "link",
|
||||
"path": "/commerce-modules/tax/tax-calculation-with-provider",
|
||||
"title": "Tax Calculation and Providers",
|
||||
"title": "Tax Calculation",
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
|
||||
@@ -30,7 +30,7 @@ export const authSidebar = [
|
||||
{
|
||||
type: "link",
|
||||
path: "/commerce-modules/auth/auth-providers",
|
||||
title: "Auth Providers",
|
||||
title: "Auth Module Provider",
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
@@ -66,7 +66,7 @@ export const authSidebar = [
|
||||
{
|
||||
type: "link",
|
||||
path: "/references/auth/provider",
|
||||
title: "Create Auth Provider Module",
|
||||
title: "Create Auth Provider",
|
||||
},
|
||||
],
|
||||
},
|
||||
|
||||
@@ -32,7 +32,7 @@ export const fulfillmentSidebar = [
|
||||
{
|
||||
type: "link",
|
||||
path: "/commerce-modules/fulfillment/fulfillment-provider",
|
||||
title: "Fulfillment Provider",
|
||||
title: "Fulfillment Module Provider",
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
@@ -63,7 +63,7 @@ export const fulfillmentSidebar = [
|
||||
{
|
||||
type: "link",
|
||||
path: "/references/fulfillment/provider",
|
||||
title: "Create Fulfillment Provider Module",
|
||||
title: "Create Fulfillment Provider",
|
||||
},
|
||||
{
|
||||
type: "ref",
|
||||
|
||||
@@ -40,7 +40,7 @@ export const paymentSidebar = [
|
||||
{
|
||||
type: "link",
|
||||
path: "/commerce-modules/payment/payment-provider",
|
||||
title: "Payment Provider Module",
|
||||
title: "Payment Module Provider",
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
|
||||
@@ -32,10 +32,15 @@ export const taxSidebar = [
|
||||
path: "/commerce-modules/tax/tax-rates-and-rules",
|
||||
title: "Tax Rates and Rules",
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
path: "/commerce-modules/tax/tax-provider",
|
||||
title: "Tax Module Providers",
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
path: "/commerce-modules/tax/tax-calculation-with-provider",
|
||||
title: "Tax Calculation and Providers",
|
||||
title: "Tax Calculation",
|
||||
},
|
||||
],
|
||||
},
|
||||
|
||||
@@ -45,7 +45,7 @@ To create a tax region:
|
||||
- Under the "Default tax rate" section, you can optionally enter a name, tax rate, and tax code in their respective fields.
|
||||
4. Once you're done, click the Save button.
|
||||
|
||||

|
||||

|
||||
|
||||
---
|
||||
|
||||
@@ -58,7 +58,21 @@ To view the details of a tax region:
|
||||
|
||||
This opens the tax region's details page where you can also manage the tax region.
|
||||
|
||||

|
||||

|
||||
|
||||
---
|
||||
|
||||
## Edit Tax Region
|
||||
|
||||
To edit a tax region:
|
||||
|
||||
1. Go to the tax region's details page.
|
||||
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the right of the tax region's name.
|
||||
3. Choose Edit from the dropdown.
|
||||
4. In the side window that opens, you can edit the tax region's default tax provider.
|
||||
5. Once you're done, click the Save button.
|
||||
|
||||

|
||||
|
||||
---
|
||||
|
||||
@@ -66,7 +80,7 @@ This opens the tax region's details page where you can also manage the tax regio
|
||||
|
||||
To edit the default tax rate of the region:
|
||||
|
||||
1. Go to the region's details page.
|
||||
1. Go to the tax region's details page.
|
||||
2. In the first section, you'll find details of the default tax rate, including its tax rate and code. Click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at its right.
|
||||
|
||||

|
||||
@@ -171,3 +185,35 @@ This opens the sublevel tax region's details page where you can also manage the
|
||||
### Manage Sublevel Tax Region's Rates
|
||||
|
||||
You can manage the sublevel tax region's [default](#edit-default-tax-rate) and [override](#manage-tax-rate-overrides) rates the same way you manage the parent tax region's rates.
|
||||
|
||||
### Delete Sublevel Tax Region
|
||||
|
||||
<Note type="warning">
|
||||
|
||||
Deleting a sublevel tax region is irreversible.
|
||||
|
||||
</Note>
|
||||
|
||||
To delete a sublevel tax region:
|
||||
|
||||
1. Go to the sublevel tax region's details page.
|
||||
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the right of the sublevel tax region's name.
|
||||
3. Choose Delete from the dropdown.
|
||||
4. Confirm deleting the sublevel tax region by clicking the Delete button in the pop-up.
|
||||
|
||||
---
|
||||
|
||||
## Delete Tax Region
|
||||
|
||||
<Note type="warning">
|
||||
|
||||
Deleting a tax region is irreversible.
|
||||
|
||||
</Note>
|
||||
|
||||
To delete a tax region:
|
||||
|
||||
1. Go to the tax region's details page.
|
||||
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the right of the tax region's name.
|
||||
3. Choose Delete from the dropdown.
|
||||
4. Confirm deleting the tax region by clicking the Delete button in the pop-up.
|
||||
|
||||
@@ -46,7 +46,7 @@ export const generatedEditDates = {
|
||||
"app/price-lists/create/page.mdx": "2025-02-19T10:11:33.113Z",
|
||||
"app/price-lists/manage/page.mdx": "2025-02-19T10:35:49.881Z",
|
||||
"app/price-lists/page.mdx": "2025-02-19T09:51:32.546Z",
|
||||
"app/settings/tax-regions/page.mdx": "2025-02-19T17:33:43.806Z",
|
||||
"app/settings/tax-regions/page.mdx": "2025-05-09T13:58:40.440Z",
|
||||
"app/settings/locations-and-shipping/locations/page.mdx": "2025-04-17T13:47:40.883Z",
|
||||
"app/settings/locations-and-shipping/page.mdx": "2025-02-19T17:23:45.824Z",
|
||||
"app/settings/locations-and-shipping/shipping-profiles/page.mdx": "2025-02-19T17:36:46.339Z",
|
||||
|
||||
Reference in New Issue
Block a user