When should I use the Commerce Checkout Step client extension type?

• You need a checkout step Liferay Commerce doesn't ship. • Compliance or business rules require a custom collection point.

How do I create a Commerce Checkout Step client extension?

1. Ship a paired `oAuthApplicationUserAgent`. 2. Give the step a name, label, and order position.

Commerce Checkout Step

Insert a custom step into the Commerce checkout flow.

type: commerceCheckoutStep·Commerce

# description

Adds a new page to the Commerce checkout flow. Useful for consent screens, upsells, custom shipping instructions, or third-party integrations mid-checkout.

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

# when to use

→You need a checkout step Liferay Commerce doesn't ship.
→Compliance or business rules require a custom collection point.

# how to use

01Ship a paired oAuthApplicationUserAgent.
02Give the step a name, label, and order position.

# optional fields

field	type	description
`name`	`string`	Display name.
`active`	`boolean`	Whether the step is enabled.
`checkoutStepLabel`	`string`	Label shown to shoppers.
`checkoutStepName`	`string`	Internal step name.
`checkoutStepOrder`	`integer`	Order in the checkout flow.
`oAuth2ApplicationExternalReferenceCode`	`string`	Ref code of the paired oAuthApplicationUserAgent.
`order`	`boolean`	Whether the step relates to order processing.
`sennaDisabled`	`boolean`	Disable Senna SPA navigation on this step.
`showControls`	`boolean`	Render back/next controls.
`visible`	`boolean`	Show the step in the flow UI.

# example

client-extension.yaml

age-verify:
    type: commerceCheckoutStep
    name: Age verification
    active: true
    checkoutStepLabel: Verify age
    checkoutStepName: age-verify
    checkoutStepOrder: 25
    oAuth2ApplicationExternalReferenceCode: my-oauth-ua

# related types

Usually shipped alongside Commerce Checkout Step:

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

# more in commerce

cd ..scaffold this type in VS Code →