@salesforce/b2c-tooling-sdk / operations/sites / addCartridge

Function: addCartridge()

addCartridge(instance, siteId, options, updateOptions?): Promise<CartridgePathResult>

Defined in: packages/b2c-tooling-sdk/src/operations/sites/cartridges.ts:129

Adds a cartridge to a site's cartridge path.

For regular sites, tries OCAPI POST /sites/{site_id}/cartridges first, falling back to site archive import if OCAPI permissions are unavailable. For Business Manager (Sites-Site), always uses site archive import.

Parameters

instance

B2CInstance

B2C instance

siteId

string

Site ID

options

AddCartridgeOptions

Cartridge name, position, and optional target

updateOptions?

CartridgeUpdateOptions

Returns

Promise<CartridgePathResult>

Updated cartridge path

Example

// Add to beginning (default)
await addCartridge(instance, 'RefArch', { name: 'my_cartridge', position: 'first' });

// Add before a specific cartridge
await addCartridge(instance, 'RefArch', {
  name: 'my_cartridge', position: 'before', target: 'app_storefront_base'
});

// Business Manager
await addCartridge(instance, 'Sites-Site', { name: 'bm_ext', position: 'first' });