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

Function: commerceAppInstall()

commerceAppInstall(instance, target, options): Promise<CommerceAppInstallResult>

Defined in: packages/b2c-tooling-sdk/src/operations/cap/install.ts:70

Installs a Commerce App Package (CAP) on a B2C Commerce instance.

Accepts a local directory or zip file. Reads the commerce-app.json manifest to determine app name, version, and domain. Uploads the zip to WebDAV and executes the sfcc-install-commerce-app system job.

Parameters

instance

B2CInstance

B2C instance to install to

target

string

Path to a CAP directory or .zip file

options

CommerceAppInstallOptions

Install options including required siteId

Returns

Promise<CommerceAppInstallResult>

Install result with job execution details

Throws

JobExecutionError if the install job fails

Example

const result = await commerceAppInstall(instance, './commerce-avalara-tax-app-v0.2.5', {
  siteId: 'RefArch',
});