B2c Docs

B2C Docs Skill

Use the b2c CLI to search and read bundled Script API documentation, the standard (system) job step catalog, and XSD schemas for Salesforce B2C Commerce.

> Tip: If b2c is not installed globally, use npx @salesforce/b2c-cli instead (e.g., npx @salesforce/b2c-cli docs search ProductMgr).

Examples

Search Documentation

# Search for a class by name
b2c docs search ProductMgr

# Search with partial match
b2c docs search "catalog product"

# Limit results
b2c docs search status --limit 5

# Find a standard job step by type ID
b2c docs search ImportCatalog

# List all available documentation
b2c docs search --list

Read Documentation

# Read documentation for a class (renders in terminal)
b2c docs read ProductMgr

# Read by fully qualified name
b2c docs read dw.catalog.ProductMgr

# Output raw markdown (for piping)
b2c docs read ProductMgr --raw

# Output as JSON
b2c docs read ProductMgr --json

Standard Job Step Catalog

The same bundled corpus includes the catalog of standard (system) job step type IDs — the built-in steps (for example ImportCatalog, ExportCatalog, ImportInventoryLists) added to Business Manager job flows. Each step's page lists its purpose and configuration parameters (required, defaults, allowed values).

# Read the catalog overview (all standard step type IDs)
b2c docs read job-steps

# Read a specific step's purpose + configuration parameters
b2c docs read ImportCatalog

# Search for a step
b2c docs search "import price"

For how standard steps fit into job flows — chaining with custom steps, IMPEX file hand-off, and when to use an in-flow step vs. the CLI equivalent — see the b2c:b2c-custom-job-steps and b2c-cli:b2c-job skills.

Download Documentation

Download the latest Script API documentation from a B2C Commerce instance. The CLI auto-discovers the target server and credentials from dw.json, SFCC_* env vars, and configuration plugins — --server is only needed to override. Run b2c setup inspect to confirm what the CLI sees; see the b2c-cli:b2c-config skill for troubleshooting.

# Download to a directory (uses configured instance)
b2c docs download ./my-docs

# Override server explicitly
b2c docs download ./docs --server sandbox.demandware.net

# Keep the original archive
b2c docs download ./docs --keep-archive

Read XSD Schemas

Read bundled XSD schema files for import/export data formats:

# Read a schema by name
b2c docs schema catalog

# Fuzzy match schema name
b2c docs schema order

# List all available schemas
b2c docs schema --list

# Print the filesystem path to the schema file
b2c docs schema catalog --path

# Validate an XML file against a schema using xmllint
xmllint --schema "$(b2c docs schema catalog --path)" my-catalog.xml --noout

Common Classes

| Class | Description | |-------|-------------| | dw.catalog.ProductMgr | Product management and queries | | dw.catalog.Product | Product data and attributes | | dw.order.Basket | Shopping basket operations | | dw.order.Order | Order processing | | dw.customer.CustomerMgr | Customer management | | dw.system.Site | Site configuration | | dw.web.URLUtils | URL generation utilities |

Common Schemas

| Schema | Description | |--------|-------------| | catalog | Product catalog import/export | | order | Order data import/export | | customer | Customer data import/export | | inventory | Inventory data import/export | | pricebook | Price book import/export | | promotion | Promotion definitions | | coupon | Coupon codes import/export | | jobs | Job step definitions |

More Commands

See b2c docs --help for a full list of available commands and options.

Source & license

This open-source skill is cataloged on AgentStack and links to its original source — we do not rehost the code.

• Author: SalesforceCommerceCloud
• Source: SalesforceCommerceCloud/b2c-developer-tooling
• License: Apache-2.0
• Homepage: https://salesforcecommercecloud.github.io/b2c-developer-tooling/

Install and usage instructions live in the source repository linked above.