Files
medusa-store/www/docs/content/modules/taxes/storefront/manual-calculation.md
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

3.4 KiB
Raw Blame History

description, addHowToData
description addHowToData
Learn how to manually calculate taxes during checkout in the Medusa backend. There are different methods including using endpoints or services. true

Calculate Taxes Manually in Checkout

In this document, youll learn how to manually calculate taxes during checkout if you have automatic tax calculation disabled in a region.

Overview

By default, taxes are automatically calculated by Medusa during checkout. This behavior can be disabled for a region using the Admin APIs or the Medusa admin to limit the requests being sent to a tax provider.

If you disable this behavior, you must manually trigger taxes calculation. When taxes are calculated, this means that requests will be sent to the tax provider to retrieve the tax rates.


How to Manually Calculate Taxes in Checkout

This section explores different ways you can calculate taxes based on your purpose.

Use Calculate Cart Taxes Endpoint

The Calculate Cart Taxes endpoint forces the calculation of taxes for a cart during checkout. This bypasses the option set in admin to not calculate taxes automatically, which results in sending requests to the tax provider.

This calculates and retrieves the taxes on the cart and each of the line items in that cart.

Use CartService's retrieve Method

The CartService class has a method retrieve that gets a cart by ID. In that method, taxes are calculated only if automatic taxes calculation is enabled for the region the cart belongs to.

You can, however, force calculating the taxes of the cart by passing in the third parameter an option containing the key force_taxes with its value set to true.

For example:

cartService.retrieve(
  "cart_01G8Z...",
  { },
  {
    force_taxes: true,
  }
)

:::tip

You can learn how to retrieve and use services in this documentation.

:::

Use CartService's decorateTotals Method

Another way you can use the CartService to calculate taxes is using the method decorateTotals:


export default () => {
  // ...

  router.get("/store/line-taxes", async (req, res) => {
    // example of retrieving cart
    const cartService = req.scope.resolve("cartService")
    const cart = await cartService.retrieve(cart_id)
    
    // ...
    // retrieve taxes of line items
    const data = await decorateTotals(cart, {
      force_taxes: true,
    })
    
    return res.status(200).json({ cart: data })
  })
}

The decorateTotals method accepts the cart as a first parameter and an options object as a second parameter. If you set force_taxes to true in that object, the totals of the line items can be retrieved regardless of whether the automatic calculation is enabled in the line items region.

Use TotalsService

You can calculate and retrieve taxes of line items using the getLineItemTotals method available in the TotalService class. All you need to do is pass in the third argument to that method an options object with the key include_tax set to true:

const itemTotals = await totalsService
  .getLineItemTotals(item, cart, {
    include_tax: true,
  })

:::tip

You can learn how to retrieve and use services in this documentation.

:::