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

Function: getCartridgePath()

getCartridgePath(instance, siteId): Promise<CartridgePathResult>

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

Gets the cartridge path for a site.

Uses OCAPI GET /sites/{site_id} to read the cartridge path. Works for all sites including Business Manager (Sites-Site).

Parameters

instance

B2CInstance

B2C instance to query

siteId

string

Site ID (e.g. 'RefArch', 'Sites-Site')

Returns

Promise<CartridgePathResult>

Cartridge path result

Example

const result = await getCartridgePath(instance, 'RefArch');
console.log(result.cartridgeList); // ['app_storefront_base', 'plugin_applepay']

// Business Manager
const bmResult = await getCartridgePath(instance, 'Sites-Site');