@salesforce/b2c-tooling-sdk / operations/cap / commerceAppUninstall

Function: commerceAppUninstall()

commerceAppUninstall(instance, appName, appDomain, options): Promise<CommerceAppUninstallResult>

Defined in: packages/b2c-tooling-sdk/src/operations/cap/uninstall.ts:58

Uninstalls a Commerce App from a B2C Commerce instance.

Executes the sfcc-uninstall-commerce-app system job which removes cartridges, IMPEX data, and configuration associated with the app from the target site.

Parameters

instance

B2CInstance

B2C instance to uninstall from

appName

string

App ID (from commerce-app.json "id" field, e.g. "avalara-tax")

appDomain

string

App domain (e.g. "tax", "shipping")

options

CommerceAppUninstallOptions

Uninstall options including required siteId

Returns

Promise<CommerceAppUninstallResult>

Uninstall result with job execution details

Throws

JobExecutionError if the uninstall job fails

Example

const result = await commerceAppUninstall(instance, 'avalara-tax', 'tax', {
  siteId: 'RefArch',
});