Adobe Commerce Admin UI SDK extension points

This section describes how to use existing extension points in any Adobe Developer App Builder application that customizes Adobe Commerce Admin.

The Adobe Commerce Samples repository contains samples for different extension points of the Adobe Commerce Admin UI SDK. Use these samples to gain insight on how the Admin SDK injects menus and pages into the Admin.

Shared contexts

The sharedContext constant is available only when a mass action, menu, or order view button performs a redirection to an iFrame page. For mass actions, sharedContext contains a set of selected IDs, the Commerce base URL, the client ID, an IMS token, and the IMS org ID, as shown below.

Copy
const sharedContext = {
  selectedIds: array,
  commerceBaseUrl: string,
  imsToken: string,
  imsOrgId: string,
  clientId: string
}
Copied to your clipboard
const sharedContext = {
  selectedIds: array,
  commerceBaseUrl: string,
  imsToken: string,
  imsOrgId: string,
  clientId: string
}

For menus and order view buttons, sharedContext contains only an IMS token of the logged in user in Commerce and the IMS org ID.

Copy
const sharedContext = {
  imsToken: string,
  imsOrgId: string
}
Copied to your clipboard
const sharedContext = {
  imsToken: string,
  imsOrgId: string
}

In the following code example, the getGuestConnection() call uses a sharedContext to retrieve a list of selected IDs. The extensionId must match the ID used to register the app in the ExtensionRegistration.js file.

Copy
const getGuestConnection = async () => {
    return await attach({
        id: extensionId
   })
}
    
getGuestConnection().then((guestConnection) => {
  guestConnection.sharedContext.get('selectedIds')
})
Copied to your clipboard
const getGuestConnection = async () => {
    return await attach({
        id: extensionId
   })
}
    
getGuestConnection().then((guestConnection) => {
  guestConnection.sharedContext.get('selectedIds')
})

The path parameter for a productMassAction specifies where to redirect the mass action UI.

Migrate your extension point from version 1.x to 2.0

Perform the following steps to update your extension points from Admin UI SDK 1.x to 2.0.

In your app on App Builder

1. Create a new runtime action under actions/registration/index.js. Use the updated example customization shown in the documentation for your extension point as a guide.Refer to the provided samples to create a new runtime action in your app.

2. Modify the app.config.yaml file to include the registration attached to the admin-ui-sdk package.

3. Remove all content from the methods in the ExtensionRegistration class to prepare for the new version.

4. Deploy and publish your app for testing.

In the Commerce instance

Clear the cache in your Commerce instance to ensure all changes take effect properly by running the following command:

Copy
bin/magento cache:clean
Copied to your clipboard
bin/magento cache:clean

Last updated 7/10/2025

Was this helpful?

Yes

No