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

• You need a shipping provider Commerce doesn't ship (regional carriers, custom 3PL). • Real-time shipping quotes require a live third-party call.

How do I create a Commerce Shipping Engine client extension?

1. Ship a paired `oAuthApplicationUserAgent`. 2. Return shipping options at your endpoint.

Commerce Shipping Engine

Custom shipping-rate provider for Liferay Commerce.

type: commerceShippingEngine·Commerce

❯

How Commerce Shipping Engine runs at request time

Every microservice CX type walks the same auth + Headless flowchart — validate token, run logic, decide whether to call Headless as the user or escalate to a server token. See it animated.

open diagram →

# description

Registers a shipping-rate calculator. Commerce calls out to your service to get shipping options at checkout.

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

# when to use

→You need a shipping provider Commerce doesn't ship (regional carriers, custom 3PL).
→Real-time shipping quotes require a live third-party call.

# how to use

01Ship a paired oAuthApplicationUserAgent.
02Return shipping options 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.
`shippingEngineTypeSettings`	`map`	Provider-specific settings.

# example

client-extension.yaml

dhl-shipping:
    type: commerceShippingEngine
    name: DHL
    key: dhl-shipping
    oAuth2ApplicationExternalReferenceCode: shipping-oauth
    shippingEngineTypeSettings:
        apiKey: ...
        accountNumber: ...

# related types

Usually shipped alongside Commerce Shipping Engine:

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

# more in commerce

cd ..scaffold this type in VS Code →