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

Function: executeJob()

executeJob(instance, jobId, options): Promise<{ }>

Defined in: packages/b2c-tooling-sdk/src/operations/jobs/run.ts:105

Executes a job on a B2C Commerce instance.

Starts a job execution and returns immediately with the execution details. Use waitForJob to wait for completion.

Parameters

instance

B2CInstance

B2C instance to execute on

jobId

string

Job ID to execute

options

ExecuteJobOptions = {}

Execution options

Returns

Promise<{ }>

Job execution details

Throws

Error if job is already running (when waitForRunning is false)

Throws

Error if job not found or cannot be executed

Example

// Execute a simple job
const execution = await executeJob(instance, 'my-job-id');

// Execute with parameters
const execution = await executeJob(instance, 'CustomerImportJob', {
  parameters: [
    { name: 'SiteScope', value: '{"all_storefront_sites":true}' }
  ]
});