---
editLink: false
lastUpdated: false
---

[@salesforce/b2c-tooling-sdk](../../modules.md) / operations/jobs

# operations/jobs

Job execution operations for B2C Commerce.

This module provides functions for running and monitoring jobs
on B2C Commerce instances via OCAPI.

## Core Job Functions

- [executeJob](functions/executeJob.md) - Start a job execution
- [getJobExecution](functions/getJobExecution.md) - Get the status of a job execution
- [waitForJob](functions/waitForJob.md) - Wait for a job to complete
- [searchJobExecutions](functions/searchJobExecutions.md) - Search for job executions
- [findRunningJobExecution](functions/findRunningJobExecution.md) - Find a running execution
- [getJobLog](functions/getJobLog.md) - Retrieve job log file content

## System Jobs

- [siteArchiveImport](functions/siteArchiveImport.md) - Import a site archive
- [siteArchiveExport](functions/siteArchiveExport.md) - Export a site archive
- [siteArchiveExportToPath](functions/siteArchiveExportToPath.md) - Export and save to local path

## Usage

```typescript
import {
  executeJob,
  waitForJob,
  searchJobExecutions,
  siteArchiveImport,
  siteArchiveExport,
} from '@salesforce/b2c-tooling-sdk/operations/jobs';
import { resolveConfig } from '@salesforce/b2c-tooling-sdk/config';

const config = resolveConfig();
const instance = config.createB2CInstance();

// Run a custom job and wait for completion
const execution = await executeJob(instance, 'my-job-id');
const result = await waitForJob(instance, 'my-job-id', execution.id);

// Search for recent job executions
const results = await searchJobExecutions(instance, {
  jobId: 'my-job-id',
  count: 10
});

// Import a site archive
await siteArchiveImport(instance, './my-import-data');

// Export site data
const exportResult = await siteArchiveExport(instance, {
  global_data: { meta_data: true }
});
```

## Authentication

Job operations require OAuth authentication with appropriate OCAPI permissions
for the /jobs and /job_execution_search resources.

## Interfaces

- [ExecuteJobOptions](interfaces/ExecuteJobOptions.md)
- [ExportDataUnitsConfiguration](interfaces/ExportDataUnitsConfiguration.md)
- [ExportGlobalDataConfiguration](interfaces/ExportGlobalDataConfiguration.md)
- [ExportSitesConfiguration](interfaces/ExportSitesConfiguration.md)
- [JobExecutionSearchResult](interfaces/JobExecutionSearchResult.md)
- [SearchJobExecutionsOptions](interfaces/SearchJobExecutionsOptions.md)
- [SiteArchiveExportOptions](interfaces/SiteArchiveExportOptions.md)
- [SiteArchiveExportResult](interfaces/SiteArchiveExportResult.md)
- [SiteArchiveImportOptions](interfaces/SiteArchiveImportOptions.md)
- [SiteArchiveImportResult](interfaces/SiteArchiveImportResult.md)
- [WaitForJobOptions](interfaces/WaitForJobOptions.md)
- [WaitForJobPollInfo](interfaces/WaitForJobPollInfo.md)

## Type Aliases

- [JobExecution](type-aliases/JobExecution.md)
- [JobExecutionParameter](type-aliases/JobExecutionParameter.md)
- [JobExecutionStatus](type-aliases/JobExecutionStatus.md)
- [JobStepExecution](type-aliases/JobStepExecution.md)

## Functions

- [executeJob](functions/executeJob.md)
- [findRunningJobExecution](functions/findRunningJobExecution.md)
- [getJobErrorMessage](functions/getJobErrorMessage.md)
- [getJobExecution](functions/getJobExecution.md)
- [getJobLog](functions/getJobLog.md)
- [searchJobExecutions](functions/searchJobExecutions.md)
- [siteArchiveExport](functions/siteArchiveExport.md)
- [siteArchiveExportToBuffer](functions/siteArchiveExportToBuffer.md)
- [siteArchiveExportToPath](functions/siteArchiveExportToPath.md)
- [siteArchiveImport](functions/siteArchiveImport.md)
- [waitForJob](functions/waitForJob.md)

## References

### JobExecutionError

Re-exports [JobExecutionError](../../errors/classes/JobExecutionError.md)