Job Commands

Commands for executing and monitoring jobs on B2C Commerce instances.

API Backend

Job commands run over SCAPI (the operation/jobs API). Configure shortCode, tenantId, and the sfcc.jobs / sfcc.jobs.rw scopes on your API client and job run, job search, job wait, and job log work out of the box.

# Default — uses SCAPI
b2c job run my-job

Legacy OCAPI backend (deprecated)

OCAPI is deprecated and disabled on newer instances. The CLI defaults to --api-backend auto, which falls back to the OCAPI Data API on safe SCAPI capability/auth/request rejections. Force a backend if needed:

b2c job run my-job --api-backend scapi   # force SCAPI
b2c job run my-job --api-backend ocapi   # force the legacy OCAPI backend

Or set "api-backend": "scapi" in dw.json, or SFCC_API_BACKEND=scapi.

TIP

The job import and job export commands trigger the sfcc-site-archive-import/-export system jobs and transfer archive files over WebDAV. The job-execution trigger honors --api-backend: in auto mode it starts the system job over SCAPI (requires the sfcc.jobs.rw scope) and falls back to OCAPI only if the SCAPI start is rejected. WebDAV is always used for the archive transfer itself regardless of backend.

Authentication

SCAPI (recommended)

When using SCAPI, your API client needs the appropriate scopes in Account Manager:

Scope	Operations
sfcc.jobs.rw	Execute, delete, search, and get job executions (recommended)
sfcc.jobs	Search and get job executions (read-only)

You also need shortCode and tenantId configured (in dw.json or via flags).

OCAPI

Configure these resources in Business Manager under Administration > Site Development > Open Commerce API Settings:

Resource	Methods	Commands
/jobs/*/executions	POST	job run
/jobs/*/executions/*	GET	job run --wait, job wait, job log
/job_execution_search	POST	job search, job log

WebDAV Access

The job import, job import-set, job export, and job log commands also require WebDAV access for file transfer and import-set state.

Configuration

# OAuth credentials
export SFCC_CLIENT_ID=your-client-id
export SFCC_CLIENT_SECRET=your-client-secret

# WebDAV (for import/export)
export SFCC_USERNAME=your-bm-username
export SFCC_PASSWORD=your-webdav-access-key

For complete setup instructions, see the Authentication Guide.

---

b2c job run

Execute a job on a B2C Commerce instance.

Usage

b2c job run JOBID

Arguments

Argument	Description	Required
JOBID	Job ID to execute	Yes

Flags

In addition to global flags:

Flag	Description	Default
--wait, -w	Wait for job to complete	false
--timeout, -t	Timeout in seconds when waiting	No timeout
--poll-interval	Polling interval in seconds when using --wait	3
--param, -P	Job parameter in format "name=value" (repeatable)
--body, -B	Raw JSON request body (for system jobs with non-standard schemas)
--no-wait-running	Do not wait for running job to finish before starting	false
--show-log	Show job log on failure	true

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

Examples

# Execute a job
b2c job run my-custom-job

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

# Execute with timeout
b2c job run my-custom-job --wait --timeout 600

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

# Output as JSON
b2c job run my-custom-job --wait --json

System Jobs with Custom Request Bodies

Some system jobs (like search indexing) use non-standard request schemas that don't follow the parameters array format. 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"]}'

---

Standard (system) job steps

B2C Commerce ships a catalog of standard job steps — built-in step type IDs (for example ImportCatalog, ExportCatalog, ImportInventoryLists) that you add to a job flow in Business Manager → Administration → Operations → Jobs, or reference by type ID in a jobs.xml flow inside a site-import archive. These are distinct from custom job steps, which you author yourself (see the b2c:b2c-custom-job-steps skill).

The full catalog — each step's purpose and its configuration parameters — is bundled with the CLI and searchable through the docs commands:

# Browse the standard step catalog
b2c docs read job-steps

# Look up a specific step's parameters
b2c docs read ImportCatalog
b2c docs search ExportInventoryLists

In-flow system step vs. the CLI equivalent

Some standard steps overlap with CLI commands. Use whichever fits the workflow:

• In-flow system step (for example the standard ImportCatalog step, or the sfcc-site-archive-import job behind b2c job import): runs entirely on the instance, against a file already staged in IMPEX. Choose this when the file is produced by an earlier step in the same job flow (no round-trip to your machine), when operations should run on a Business Manager schedule, or when you want catalog/inventory imports to follow your custom processing without leaving the server.
• CLI command (b2c job import, b2c job export): drives the operation from your machine — uploading a local archive, downloading an export, or scripting a one-off from CI. Choose this for local-to-instance transfer, ad-hoc runs, and pipelines that originate outside the instance.

In short: keep it an in-flow standard step when the data already lives on (or is generated on) the instance and should stay there; reach for the CLI when you are moving data between your machine and the instance. For chaining custom and standard steps in one flow — and handing a custom-generated IMPEX file to a standard import step — see the b2c:b2c-custom-job-steps skill.

---

b2c job wait

Wait for a job execution to complete.

Usage

b2c job wait JOBID EXECUTIONID

Arguments

Argument	Description	Required
JOBID	Job ID	Yes
EXECUTIONID	Execution ID to wait for	Yes

Flags

In addition to global flags:

Flag	Description	Default
--timeout, -t	Timeout in seconds	No timeout
--poll-interval	Polling interval in seconds	3
--show-log	Show job log on failure	true

Examples

# Wait for a job execution
b2c job wait my-job abc123-def456

# Wait with timeout
b2c job wait my-job abc123-def456 --timeout 600

# Wait with custom polling interval
b2c job wait my-job abc123-def456 --poll-interval 5

---

b2c job search

Search for job executions on a B2C Commerce instance.

Usage

b2c job search

Flags

In addition to global flags:

Flag	Description	Default
--job-id, -j	Filter by job ID
--status	Filter by status (comma-separated: RUNNING,PENDING,OK,ERROR)
--count, -n	Maximum number of results	25
--start	Starting index for pagination	0
--sort-by	Sort by field (start_time, end_time, job_id, status)	start_time
--sort-order	Sort order (asc, desc)	desc
--columns, -c	Columns to display (comma-separated): id, jobId, status, startTime
--extended, -x	Show all columns including extended fields	false

Examples

# Search all recent job executions
b2c job search

# Search for a specific job
b2c job search --job-id my-custom-job

# Search for running or pending jobs
b2c job search --status RUNNING,PENDING

# Get more results
b2c job search --count 50

# Output as JSON
b2c job search --json

Output

The command displays a table of job executions with:

• Execution ID
• Job ID
• Status
• Start Time

---

b2c job log

Retrieve the log for a job execution. When no execution ID is provided, the command finds the most recent execution that has a log file.

Usage

b2c job log JOBID [EXECUTIONID]

Arguments

Argument	Description	Required
JOBID	Job ID	Yes
EXECUTIONID	Execution ID (if omitted, finds the most recent execution with a log)	No

Flags

In addition to global flags:

Flag	Description	Default
--failed	Find the most recent failed execution with a log	false

Examples

# Get the most recent log for a job
b2c job log my-custom-job

# Get the most recent failed log
b2c job log my-custom-job --failed

# Get the log for a specific execution
b2c job log my-custom-job abc123-def456

# Output as JSON (includes execution metadata and log content)
b2c job log my-custom-job --json

# Pipe log to a file
b2c job log my-custom-job > job.log

Notes

• Not all job executions produce log files. The command will skip executions without logs when searching.
• Log content is written to stdout, making it easy to pipe to a file or other tools.
• Status messages are written to stderr so they don't interfere with piped output.
• The job log command requires WebDAV access to retrieve log files.

---

b2c job execution delete

Delete a job execution record. This command requires the SCAPI backend (sfcc.jobs.rw scope).

Usage

b2c job execution delete JOBID EXECUTIONID

Arguments

Argument	Description	Required
JOBID	Job ID	Yes
EXECUTIONID	Execution ID to delete	Yes

Examples

# Delete a specific execution
b2c job execution delete my-job abc123-def456

Notes

• Requires SCAPI backend — not available via OCAPI.
• Requires the sfcc.jobs.rw scope on your API client.

---

b2c job import

Import a site archive to a B2C Commerce instance using the sfcc-site-archive-import system job.

Usage

b2c job import TARGET [PATHS...]

Arguments

Argument	Description	Required
TARGET	Directory, zip file, or remote filename to import	Yes
PATHS...	Optional subset of files, directories, or glob patterns under TARGET to include in the archive. When omitted, the entire directory is archived. Only valid when TARGET is a directory.	No

Flags

In addition to global flags:

Flag	Description	Default
--keep-archive, -k	Keep archive on instance after import	false
--remote, -r	Target is a filename already on the instance (in Impex/src/instance/)	false
--split, -s	Split a large directory import into multiple archive parts to stay under the instance size limit	false
--max-size	Per-archive size limit for --split (e.g. 190, 190mb, 512kb; a bare number is MiB)	190mb
--timeout, -t	Timeout in seconds	No timeout
--wait, -w	Wait for import job to complete	true
--show-log	Show job log on failure	true

Examples

# Import from a local directory (will be zipped automatically)
b2c job import ./my-site-data

# Import from a zip file
b2c job import ./export.zip

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

# Import from existing file on instance
b2c job import existing-archive.zip --remote

# With timeout
b2c job import ./my-site-data --timeout 300

# Import only specific parts of a site export
b2c job import ./my-site-data sites/RefArch libraries/mylib

# Import all libraries using a glob pattern
b2c job import ./my-site-data 'libraries/**'

# Mix sites and libraries
b2c job import ./my-site-data sites/RefArch 'libraries/*'

# Split a large import that exceeds the instance archive size limit
b2c job import ./big-site-data --split

# Split with a custom per-archive size limit
b2c job import ./big-site-data --split --max-size 150mb

Notes

• When importing a directory, it will be automatically zipped before upload
• The archive is uploaded to Impex/src/instance/ on the instance
• By default, the archive is deleted after successful import (use --keep-archive to retain)
• When PATHS are given, only those files/directories are included in the archive — their location under TARGET is preserved (e.g. sites/RefArch/... stays at sites/RefArch/...).

Importing archives larger than the instance limit

A B2C Commerce instance rejects a single import archive above its size limit (typically 200 MB). The --split flag works around this for directory imports by importing the data in multiple smaller archive parts:

1. Metadata/XML first. All order-sensitive XML (catalogs, libraries, sites, meta, etc.) is imported first, kept together in a single archive when it fits. Keeping it together means the import job resolves all internal references and dependency ordering within one archive. If the XML alone exceeds the limit, it is split at top-level data-unit boundaries (e.g. catalogs, libraries, sites) in dependency order — never splitting an individual unit, so a catalog and its internal references always stay together.
2. Static assets after. Static resources (anything under a static/ folder — images, fonts, binaries) are deferred into subsequent archive parts, packed by compressed size. They are order-independent and attach to the catalogs/libraries created by the metadata import.

Parts are imported sequentially and the command stops on the first failure.

Packing is by estimated compressed size (already-compressed file types such as JPG/PNG/ZIP are measured as stored). The default per-part ceiling is 190mb to leave headroom under the instance limit; tune it with --max-size.

If a single file or a single data unit's XML is larger than --max-size on its own, it cannot be placed in any part (a file is never split across archives) and the command errors — reduce the export scope for that unit or raise --max-size if the instance allows a larger archive.

When you run a normal (non---split) directory import and the assembled archive exceeds the limit, the command warns and recommends re-running with --split. --split cannot be combined with --remote, subset PATHS, or --no-wait.

---

b2c job import-set

Apply an ordered directory of site archives idempotently. Each immediate child directory or .zip file is one import item; other files and hidden entries are ignored.

Usage

b2c job import-set [DIRECTORY]

Arguments

Argument	Description	Required	Default
DIRECTORY	Directory whose immediate child directories and zip files form the ordered import set	No	./migrations

For example:

migrations/
├── 20260801T140000-add-preferences/
│   ├── meta/
│   └── sites/
├── 20260802T091500-seed-content.zip
└── README.md                       # ignored

The CLI imports 20260801T140000-add-preferences/ and then 20260802T091500-seed-content.zip in lexical filename order. Name every item YYYYMMDDTHHmmss-description so the filename is both its ordering key and its stable, practically unique receipt identity across projects. Use UTC when teams work across time zones.

Flags

In addition to global flags:

Flag	Description	Default
--set-id	Advanced: remote receipt and lock namespace for an independent migration history	migrations
--dry-run	Show pending and applied items without locking, importing, or writing state	false
--keep-archive, -k	Keep each uploaded archive on the instance after import	false
--break-lock	Remove an existing import-set lock before acquiring it	false
--stale-lock-seconds	Take over a lock whose heartbeat is older than this many seconds	1800
--lock-poll-interval	Seconds between checks while another runner holds the set lock	3
--timeout, -t	Timeout in seconds for each import job	No timeout
--poll-interval	Job polling interval in seconds	3
--show-log	Show the job log when an import fails	true

Examples

# Preview what would be imported
b2c job import-set --dry-run

# Apply ./migrations; repeat this command safely in local setup or CI
b2c job import-set

# Explicitly replace a lock after confirming its owner is no longer running
b2c job import-set --break-lock

# Advanced: isolate a legacy migration history that cannot use unique timestamped names
b2c job import-set ./legacy-migrations --set-id legacy-storefront-data

Receipts and retry behavior

The CLI creates and verifies a directory receipt on the target instance after each successful import. Receipt identity is based only on the item's directory or zip filename. An item whose name already has a receipt is skipped; its contents are not compared.

This deliberately provides at-least-once retry behavior until the receipt is durable. If an import succeeds but the process crashes or WebDAV fails before the receipt is verified, the next invocation imports that item again. Site archive contents should therefore be safe to apply more than once.

Never edit an applied item: instances that already have its name receipt continue to skip it, while a new instance would import the edited contents. Add a new, later-sorting directory or zip file for every change. Two projects using the same receipt namespace must also use distinct item names; the timestamp-and-description convention makes accidental collisions unlikely.

Receipts and the concurrency lock use the fixed instance-wide migrations namespace by default, regardless of the local directory path. Most projects should not set --set-id; it exists only for intentionally independent histories or legacy item names that cannot follow the timestamp convention.

Concurrent runners and stale locks

Only one runner applies a set at a time. The CLI atomically creates a WebDAV collection as the set lock, writes owner metadata, and refreshes a heartbeat while imports run. Other runners wait and re-check receipts after acquiring the lock.

A lock is automatically treated as stale after 30 minutes by default; tune this with --stale-lock-seconds. Use --break-lock only after confirming the recorded runner is gone. B2C Commerce WebDAV does not enforce conditional deletes, so stale or forced takeover is best-effort and is always reported in command output.

---

b2c job export

Export a site archive from a B2C Commerce instance using the sfcc-site-archive-export system job.

Usage

b2c job export

Flags

In addition to global flags:

Flag	Description	Default
--output, -o	Output path for the export	./export
--data-units	Data units JSON configuration
--site	Site ID(s) to export (comma-separated, repeatable)
--site-data	Site data types to export (comma-separated)
--global-data	Global data types to export (comma-separated)
--catalog	Catalog ID(s) to export (comma-separated)
--price-book	Pricebook ID(s) to export (comma-separated)
--library	Library ID(s) to export (comma-separated)
--inventory-list	Inventory list ID(s) to export (comma-separated)
--keep-archive, -k	Keep archive on instance after download	false
--no-download	Do not download archive (implies --keep-archive)	false
--zip-only	Save as zip file without extracting	false
--timeout, -t	Timeout in seconds	No timeout
--show-log	Show job log on failure	true

Examples

# Export global metadata
b2c job export --global-data meta_data

# Export a site's content and preferences
b2c job export --site RefArch --site-data content,site_preferences

# Export catalogs
b2c job export --catalog storefront-catalog

# Export with custom data units JSON
b2c job export --data-units '{"global_data":{"meta_data":true}}'

# Export to a specific directory
b2c job export --output ./exports

# Keep archive on instance
b2c job export --global-data meta_data --keep-archive

# Output as JSON
b2c job export --global-data meta_data --json

Data Units

The export is configured using "data units" which specify what data to export. You can use convenience flags (--site, --global-data, etc.) or provide a full JSON configuration with --data-units.

Site Data Types

When using --site-data, available types include:

• all - Export all site data
• content - Content assets and slots
• site_preferences - Site preferences
• campaigns_and_promotions - Marketing campaigns
• customer_groups - Customer groups
• payment_methods - Payment configurations
• And more (see OCAPI documentation)

Global Data Types

When using --global-data, available types include:

• all - Export all global data
• meta_data - System and custom object metadata
• custom_types - Custom object type definitions
• preferences - Global preferences
• locales - Locale configurations
• services - Service configurations
• And more (see OCAPI documentation)