App metadata
The metadata object in your app.commerce.config file identifies your application to App Management. This information appears in the Admin and helps merchants identify and manage installed apps.
Example
The following example shows a metadata configuration:
import { defineConfig } from "@adobe/aio-commerce-lib-app/config"
export default defineConfig({
metadata: {
id: "my-commerce-application",
displayName: "My Commerce Application",
description: "This is a description for my application",
version: "1.0.0",
upgradeMode: "manual"
},
});
Metadata properties
The metadata contains the following properties:
Property
Type
Required
Description
idstring
Yes
Unique identifier for your app. Must contain only alphanumeric characters and hyphens. Maximum 100 characters.
displayNamestring
Yes
Name shown in the Admin UI. Maximum 50 characters.
descriptionstring
Yes
Brief description of your app's functionality. Maximum 255 characters.
versionstring
Yes
Semantic version number (for example,
1.0.0, 2.1.3).upgradeModestring
No
Controls whether an upgrade plan created after deployment waits for review (
manual, the default) or starts automatically (auto, experimental). Automatic execution can run custom installation scripts. See Choose an upgrade mode for configuration details.App icon
data-variant=info
data-slots=text
The listing icon comes from the Adobe app registry (Adobe Exchange or enterprise registration), not from the
metadata object in app.commerce.config. Update the listing or registry record to change what merchants see.