Files
medusa-store/www/docs/content/modules/taxes/overview.mdx
Shahed Nasser 914d773d3a 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
2023-08-15 18:07:54 +03:00

193 lines
5.1 KiB
Plaintext

---
description: "Taxes are additional costs or fees imposed by a government for goods or services. Learn about the available features and guides."
---
import DocCardList from '@theme/DocCardList';
import Icons from '@theme/Icon';
# Taxes
Taxes are additional costs or fees imposed by a government for goods or services. This overview introduces the available features related to taxes.
:::note
Not a developer? Check out the [Taxes user guide](../../user-guide/taxes/index.md).
:::
## Features
### Tax Providers
Developers can integrate third-party tax providers or implement custom tax-provider logic.
Admins can specify the tax provider for a specific region.
Customers can view calculated taxes during their checkout process.
<DocCardList colSize={4} items={[
{
type: 'link',
href: '/modules/taxes/backend/create-tax-provider',
label: 'Backend: Create Tax Provider',
customProps: {
icon: Icons['academic-cap-solid'],
description: 'Learn how to create a tax provider.',
}
},
{
type: 'link',
href: '/modules/taxes/backend/tax-calculation-strategy',
label: 'Backend: Tax Calculation Strategy',
customProps: {
icon: Icons['academic-cap-solid'],
description: 'Learn how to override the tax calculation strategy.'
}
},
{
type: 'link',
href: '/modules/taxes/admin/manage-tax-settings',
label: 'Admin: Manage Tax Settings',
customProps: {
icon: Icons['academic-cap-solid'],
description: 'Learn how to manage tax settings using Admin APIs.',
}
},
]} />
<DocCardList colSize={6} items={[
{
type: 'link',
href: '/user-guide/taxes/manage',
label: 'User Guide: Manage Taxes',
customProps: {
icon: Icons['users-solid'],
description: 'Learn how to manage taxes in Medusa Admin.'
}
},
{
type: 'link',
href: '/modules/taxes/storefront/manual-calculation',
label: 'Storefront: Manually Calculate Taxes',
customProps: {
icon: Icons['users-solid'],
description: 'Learn how to manually calculate taxes during checkout.'
}
},
]} />
### Tax Rates and Overrides
Admins can create additional tax rates aside from the default tax rate. They can also specify overrides of tax rates for specific products, product types, or shipping options.
Customers can review order edit requests and authorize additional payments if necessary.
<DocCardList colSize={4} items={[
{
type: 'link',
href: '/modules/taxes/admin/manage-tax-rates',
label: 'Admin: Manage Tax Rates',
customProps: {
icon: Icons['academic-cap-solid'],
description: 'Learn how to manage tax rates using Admin APIs.',
}
},
{
type: 'link',
href: '/user-guide/taxes/tax-rates',
label: 'User Guide: Tax Rates',
customProps: {
icon: Icons['users-solid'],
description: 'Learn how to manage tax rates using Medusa Admin.'
}
},
{
type: 'link',
href: '/user-guide/taxes/tax-overrides',
label: 'User Guide: Tax Overrides',
customProps: {
icon: Icons['users-solid'],
description: 'Learn how to manage tax rates using Medusa Admin.'
}
},
]} />
### Tax-Inclusive Pricing
Admins can enable tax-inclusive pricing for a region or currency. This would automatically calculate the taxes applied on a product for that region or currency.
<DocCardList colSize={6} items={[
{
type: 'link',
href: '/modules/taxes/inclusive-pricing',
label: 'Architecture: Tax-Inclusive Pricing',
customProps: {
icon: Icons['circle-stack-solid'],
description: 'Learn how tax-inclusive pricing works and its relation to other modules.'
}
},
{
type: 'link',
href: '/user-guide/taxes/tax-inclusive',
label: 'User Guide: Tax-Inclusive Pricing',
customProps: {
icon: Icons['users-solid'],
description: 'Learn how to manage tax-inclusive pricing using Medusa Admin.'
}
},
]} />
---
## Understand the Architecture
Learn how tax-related entities and concepts are built, their relation to other modules, and more.
<DocCardList colSize={6} items={[
{
type: 'link',
href: '/modules/taxes',
label: 'Architecture: Tax',
customProps: {
icon: Icons['circle-stack-solid'],
description: 'Learn about the Tax Architecture.',
}
},
{
type: 'link',
href: '/modules/taxes/inclusive-pricing',
label: 'Architecture: Tax-Inclusive Pricing',
customProps: {
icon: Icons['circle-stack-solid'],
description: 'Learn how tax-inclusive pricing works.'
}
},
]} />
---
## Related Modules
Discover Taxes' relation to other modules in Medusa.
<DocCardList colSize={6} items={[
{
type: 'link',
href: '/modules/regions-and-currencies/overview',
label: 'Regions',
customProps: {
icon: Icons['globe-europe-solid'],
description: 'Taxes, tax rates, and tax overrides are associated with a region.'
}
},
{
type: 'link',
href: '/modules/carts-and-checkout/overview',
label: 'Carts and Checkout',
customProps: {
icon: Icons['shopping-cart-solid'],
description: 'Taxes can be automatically or manually calculated during checkout.'
}
},
]} />