Skip to content
View as Markdown
View as Markdown

@salesforce/b2c-tooling-sdk / operations/jobs / discoverExportableUnits

Function: discoverExportableUnits()

discoverExportableUnits(instance): Promise<ExportableUnits>

Defined in: packages/b2c-tooling-sdk/src/operations/jobs/discover.ts:98

Discovers the data units that can be exported from an instance.

Each category is read independently: a failure in one (e.g. the OCAPI client lacks read permission for catalogs) records a warning and leaves that list empty rather than failing the whole discovery, so the caller can still offer the categories that succeeded.

Parameters

instance

B2CInstance

B2C instance to query

Returns

Promise<ExportableUnits>

Discovered IDs grouped by category, with per-category warnings

Example

typescript
const units = await discoverExportableUnits(instance);
console.log(units.catalogs); // ['storefront-catalog', 'master-catalog']

Released under the Apache-2.0 License.