B2C Job Skill

Use the b2c CLI plugin to run jobs and import/export site archives on Salesforce B2C Commerce instances.

Examples

Run a Job

# run a job and return immediately
b2c job run my-custom-job

# run a job and wait for completion
b2c job run my-custom-job --wait

# run a job with a timeout (in seconds)
b2c job run my-custom-job --wait --timeout 600

# run a job with parameters (standard jobs)
b2c job run my-custom-job -P "SiteScope={\"all_storefront_sites\":true}" -P OtherParam=value

# show job log if the job fails
b2c job run my-custom-job --wait --show-log

Run System Jobs with Custom Request Bodies

Some system jobs (like search indexing) use non-standard request schemas. Use --body to provide a raw JSON request body:

# run search index job for specific sites
b2c job run sfcc-search-index-product-full-update --wait --body '{"site_scope":["RefArch","SiteGenesis"]}'

# run search index job for a single site
b2c job run sfcc-search-index-product-full-update --wait --body '{"site_scope":["RefArch"]}'

Note: --body and -P are mutually exclusive.

Import Site Archives

# import a local directory as a site archive
b2c job import ./my-site-data

# import a local zip file
b2c job import ./export.zip

# keep the archive on the instance after import
b2c job import ./my-site-data --keep-archive

# import an archive that already exists on the instance (in Impex/src/instance/)
b2c job import existing-archive.zip --remote

# show job log on failure
b2c job import ./my-site-data --show-log

Export Site Archives

# export site data using the job export command
b2c job export

Search Job Executions

# search for job executions
b2c job search

# search with JSON output
b2c job search --json

Wait for Job Completion

# wait for a specific job execution to complete
b2c job wait <execution-id>

More Commands

See b2c job --help for a full list of available commands and options in the job topic.