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

Function: setCartridgePath()

setCartridgePath(instance, siteId, cartridges, updateOptions?): Promise<CartridgePathResult>

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

Replaces the entire cartridge path for a site.

For regular sites, tries OCAPI PUT /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

cartridges

string

New cartridge path (colon-separated string)

updateOptions?

CartridgeUpdateOptions

Returns

Promise<CartridgePathResult>

Updated cartridge path

Example

await setCartridgePath(instance, 'RefArch', 'app_storefront_base:plugin_applepay');