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

Function: siteArchiveExport()

siteArchiveExport(instance, dataUnits, options): Promise<SiteArchiveExportResult>

Defined in: packages/b2c-tooling-sdk/src/operations/jobs/site-archive.ts:432

Exports a site archive from a B2C Commerce instance.

Parameters

instance

B2CInstance

B2C instance to export from

dataUnits

Partial<ExportDataUnitsConfiguration>

Data units configuration specifying what to export

options

SiteArchiveExportOptions = {}

Export options

Returns

Promise<SiteArchiveExportResult>

Export result with archive data

Throws

JobExecutionError if export job fails

Example

// Export global meta data
const result = await siteArchiveExport(instance, {
  global_data: { meta_data: true }
});

// Export a site's content
const result = await siteArchiveExport(instance, {
  sites: {
    'RefArch': { content: true, site_preferences: true }
  }
});

// Export catalogs
const result = await siteArchiveExport(instance, {
  catalogs: { 'storefront-catalog': true }
});