When should I use the Commerce Tax Engine client extension type?

• You have complex or regional tax rules Commerce doesn't handle out of the box. • You're integrating with a specialised tax service.

How do I create a Commerce Tax Engine client extension?

1. Ship a paired `oAuthApplicationUserAgent`. 2. Return tax breakdowns at your endpoint.

Commerce Tax Engine

Custom tax-calculation provider for Liferay Commerce.

type: commerceTaxEngine·Commerce

# description

Registers a tax-calculation service — Avalara, TaxJar, a custom rate matrix. Commerce calls out to your service for tax during checkout.

Payment, shipping, tax, and checkout integrations for Liferay Commerce.

# when to use

→You have complex or regional tax rules Commerce doesn't handle out of the box.
→You're integrating with a specialised tax service.

# how to use

01Ship a paired oAuthApplicationUserAgent.
02Return tax breakdowns at your endpoint.

# optional fields

field	type	description
`name`	`string`	Display name.
`key`	`string`	Internal Commerce reference code.
`oAuth2ApplicationExternalReferenceCode`	`string`	Ref code of the paired oAuthApplicationUserAgent.
`taxEngineTypeSettings`	`map`	Provider-specific settings.

# example

client-extension.yaml

avalara-tax:
    type: commerceTaxEngine
    name: Avalara
    key: avalara-tax
    oAuth2ApplicationExternalReferenceCode: tax-oauth
    taxEngineTypeSettings:
        apiKey: ...

# related types

Usually shipped alongside Commerce Tax Engine:

❯OAuth Application (User Agent)— Register a browser / SPA OAuth application.

# more in commerce

cd ..scaffold this type in VS Code →