Build and deploy

After defining your app configuration, build and deploy your application so it is ready for association and installation with Adobe Commerce through App Management.

Generated files

The initialization process creates files organized by extension point:

commerce/extensibility/1 for App Management.

Import your app configuration through the #app.commerce.config alias. The generate command registers this alias in your project's package.json imports for every app (since @adobe/aio-commerce-lib-app 1.8.0), so your own runtime actions can import your config the same way the generated actions do, without referencing generated file paths. The alias resolves to the generated app.commerce.config.js module, which is built differently depending on whether your config is static or dynamic:

• Static (serializable) config: the validated app.commerce.manifest.json snapshot is generated, and the module re-exports it.
• Dynamic config (contains logic that can't be expressed as JSON, such as a dynamicList field with a function-based options): no manifest is generated, and the module is built directly from your app.commerce.config source file.

commerce/configuration/1 for Business configuration (when a businessConfig is defined).

commerce/backend-ui/2 for Admin UI SDK registration (when adminUi is defined in app.commerce.config).

Generated runtime actions

The libraries generate runtime actions organized by extension point. These are auto-generated directories and any manual changes can be lost during regeneration. Generated runtime actions default to the nodejs:24 App Builder runtime, and the CLI requires Node.js 22–24.

App Management actions from commerce/extensibility/1

generate only creates the installation action when your config includes custom installation steps, Commerce or external events, webhooks, or adminUi.

Business configuration actions from commerce/configuration/1

These actions handle configuration and scope operations (generated when a businessConfig is defined).

The scope tree action supports syncing scopes from Adobe Commerce, setting custom scope hierarchies for external systems, and unsyncing Commerce scopes. Structural changes in Commerce (websites, stores, store views) are not reflected in App Management until an Admin runs Sync commerce scopes for each associated application that uses scopes; see Scope tree synchronization.

Admin UI SDK registration on commerce/backend-ui/2

When adminUi is defined, Admin UI SDK V2 handles registration automatically. Adobe Commerce reads the registration directly from the app-config action described above. The generate command derives workerProcess operations from the runtimeAction values in your adminUi configuration and updates them in src/commerce-backend-ui-2/ext.config.yaml at build time.

Build and deploy

After you change app.commerce.config, build and deploy your application. The pre-app-build hook runs the generators for you, so the manifest, schema, and runtime actions under .generated stay in sync without a separate step.

aio app build --force-build
aio app deploy --force-deploy --no-build

When debugging, you can run npx aio-commerce-lib-app generate … without a full App Builder build to refresh generated files quickly.

After deployment, your application is ready to be associated with Adobe Commerce using App Management. See manage your app for association, installation, and other lifecycle steps.

Find an application in the Admin

Under Apps > App Management, each application appears as a card. The list can include every app associated with the Adobe Commerce instance for the selected Adobe IMS organization. Use the controls above the cards to narrow results:

Search text and both dropdowns apply together (logical AND). To display the full list again, set Status and Extensibility patterns back to their All … options, and clear the search field.

Review application details

Open an application's details to review its name, description, and version. The dialog provides two tabs: Details and App config.

The Details tab lists the application's business use cases, including events and custom installation steps. Labels and descriptions help administrators understand what the application adds to Commerce.

Provide meaningful labels and descriptions in app.commerce.config so administrators can understand the application before installing it.

The App config tab displays the application configuration as JSON for inspection.

Acquire App

Acquire App opens a new browser tab (or a separate browser view) to Adobe Exchange, where you can discover Commerce-related marketplace listings and add applications to your Adobe IMS organization. After the app is acquired, approved, and deployed, it appears in App Management for association and installation.

Review unassociation

Before confirming Unassociate, review the application's listed business use cases. The confirmation dialog identifies components affected by uninstallation, including events and custom installation steps.

Cleanup of resources created by custom installation steps depends on the application's uninstall handlers. Review those handlers to determine which resources are removed and which require manual cleanup. See Customize for installation script guidance.

data-variant=info

data-slots=text