Install the tax module
To begin using the checkout starter kit, ensure that you have completed the getting started and configuration steps.
For more ideas on how you can use the tax module, refer to tax use cases.
Prerequisites
- Adobe Commerce on cloud infrastructure or on-premises: 2.4.5+
- PHP 8.1+
- Magento Open Source is not supported.
Installation
Adobe Commerce as a Cloud Service is preconfigured with all the required modules for the checkout starter kit. Cloud Service users can proceed by configuring an App Builder project or configuring Commerce.
Before installing Commerce modules, ensure that you have the required credentials in auth.json with access to the Adobe Commerce repository.
To enable out-of-process tax management in Adobe Commerce, install the magento/module-out-of-process-tax-management module using the following command:
Copied to your clipboardcomposer require magento/module-out-of-process-tax-management --with-dependencies
For Adobe Commerce version 2.4.5, run the following command if you encounter any issues during magento setup:install process:
Copied to your clipboardmagento setup:di:compile
Configuration
This step requires the Adobe Commerce HTTP Client to authenticate the Commerce instance.
The checkout starter kit provides the create-tax-integrations script to help configure Adobe Commerce. It reads the tax integrations configuration from the tax-integrations.yaml file and creates tax integrations in Adobe Commerce.
To run this script, use the following command:
Copied to your clipboardnpm run create-tax-integrations
Limitations
This extension overrides the class Magento\Tax\Model\Sales\Total\Quote\Tax in the di.xml file
Copied to your clipboard<preference for="Magento\Tax\Model\Sales\Total\Quote\Tax"type="Magento\OutOfProcessTaxManagement\Model\Tax\Sales\Total\Quote\Tax"/>
As a result, this extension is not compatible with other tax extensions that also override this class, such as TaxJar or Avalara.
If you need to use another tax extension, Adobe recommends disabling this extension to prevent conflicts.
