Installing Kintsugi Sales Tax Plugin for Magento

The Kintsugi Sales Tax plugin turns your Magento store into a tax engine. Once it is installed and switched on, Magento calls Kintsugi at checkout and applies live sales tax rates to each order instead of relying on static tax rules you maintain yourself.

This guide covers the full install. Set aside about 20 minutes, and make sure someone with command line access to your Magento server is available. The plugin is installed as a Magento module, so part of the setup happens outside the admin panel.

Supported Magento and PHP Versions

Start here. The plugin is built and tested against Adobe's supported version matrix, so confirm what you are running before you download anything. Installing on a combination we do not support can cause errors at checkout.

Not sure which versions you are on? Your Magento version appears at the bottom of any admin panel page. From the command line, run bin/magento --version for Magento and php -v for PHP.

Running Magento 2.4.9? You need plugin version 1.1.0 or later. Earlier plugin versions cause a checkout error on 2.4.9. See Keeping the Plugin Up to Date below.

One download covers every supported Magento and PHP pair, so you do not need to pick a version-specific file.

What You'll Need

Before you begin, make sure you have:

1. Command Line Access: The ability to access your Magento server via the command line.

2. Plugin Download: A valid copy of the Kintsugi SalesTax plugin downloaded from our Kintsugi Magento Plugins page.

Step-by-Step Installation

Step 1: Get the Plugin

1. Go to the Kintsugi Magento Plugins download page.

2. Download the latest version of the SalesTax plugin (it will be a ZIP file).

Step 2: Install the Plugin Files

1. Extract: Unzip the downloaded file to reveal its contents.

2. Upload: Transfer the extracted plugin files to your Magento installation:

   src/app/code/Kintsugi/SalesTax

   IMPORTANT:

   • If the Kintsugi/SalesTax folder doesn't exist, simply create it!

   • The path must be exactly src/app/code/Kintsugi/SalesTax. Servers are case-sensitive; any mismatch will prevent Magento from detecting the module.

Step 3: Enable and Configure the Plugin

Open your command line interface and navigate to your Magento root directory (this is where your Magento files are located):

cd /path/to/your/magento-root/

Now, run the following commands one by one, pressing Enter after each:

• Enable the Module:

  cd  /path/to/your/magento-root/  
  bin/magento module:enable Kintsugi_SalesTax

• Update Your Database:

  bin/magento setup:upgrade

• Recompile Dependencies:

  bin/magento setup:di:compile

• Clear Your Cache:

  bin/magento cache:flush

• Deploy Static Content:

  bin/magento setup:static-content:deploy -f

How to Confirm It's Working

To verify that the Kintsugi SalesTax plugin is successfully installed:

1. Log in to your Magento Admin Panel.

2. Go to Stores → Configuration → Sales → Tax.

   

   

3. Look for the "Kintsugi Tax" option in the configuration settings.

   1. Fill the API KEY and Test Connection.

   2. To enable sales tax calculation, toggle plugin option to Yes.

   3. Fill API endpoint from from description given.

   4. Optional: Fill Fallback rate in case API errors

   5. Optional: Fill cache maintenance timer in seconds. Holds cache of tax rates for specified period

   6. Click "Save Config"

      

Need Help?

For further concerns, we're always here to help. If you can't find the answer you're looking for, please reach out to us using the chat bubble in the bottom right corner.