home / skills / salesforcecommercecloud / b2c-developer-tooling / b2c-docs

b2c-docs skill

safe

This skill helps you quickly search and read Salesforce B2C Script API docs and XSD schemas using the b2c CLI to write and validate scripts.

npx playbooks add skill salesforcecommercecloud/b2c-developer-tooling --skill b2c-docs

Review the files below or copy the command above to add this skill to your agents.

Files (1)

SKILL.md

2.8 KB

---
name: b2c-docs
description: Search and read B2C Commerce (SFCC/Demandware) Script API documentation and XSD schemas with the b2c cli. Use when writing B2C scripts, looking up classes for the SFCC/Demandware/B2C Commerce script API, answering "how do I" questions about URLs, products, orders. Also use for import/export XML format (XSD) reference. Use to verify class methods, properties, and usage in the dw.* API namespace
---

# B2C Docs Skill

Use the `b2c` CLI to search and read bundled Script API documentation 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

```bash
# 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

# List all available documentation
b2c docs search --list
```

### Read Documentation

```bash
# 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
```

### Download Documentation

Download the latest Script API documentation from a B2C Commerce instance:

```bash
# Download to a directory
b2c docs download ./my-docs

# Download with specific server
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:

```bash
# 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

# Output as JSON
b2c docs schema catalog --json
```

## 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.

Overview

This skill lets you search and read bundled Salesforce B2C Commerce (SFCC / Demandware) Script API documentation and XSD schemas using the b2c CLI. It helps verify dw.* API classes, methods, properties, and import/export XML formats while you develop or debug B2C scripts. Use it to quickly answer "how do I" questions about products, orders, URLs, and other platform objects.

How this skill works

The skill wraps the b2c CLI commands to search and read local or downloaded Script API docs and XSD schemas. You can search by class or keyword, read full documentation in the terminal, output raw markdown or JSON, and fetch XSD schemas for import/export formats. It also supports downloading the latest docs from a B2C Commerce instance and listing available schemas or docs.

When to use it

When writing or reviewing B2C Commerce server-side scripts and controllers
To verify class methods, properties, signatures, and return types in the dw.* namespace
When you need XSD reference for import/export XML formats (catalog, order, customer, etc.)
To quickly answer platform-specific "how do I" questions about products, orders, promotions, URLs
When preparing or updating integrations and need accurate schema details

Best practices

Install b2c CLI globally or use npx @salesforce/b2c-cli for one-off use
Prefer reading docs with --raw or --json when piping into tools or editor workflows
Download documentation from a representative instance (sandbox/staging) to match platform version
Use --limit and --list to narrow searches when terms are ambiguous
Cross-check XSD schema names with schema --list before reading specific files

Example use cases

Search for ProductMgr methods and example usage when implementing product lookups
Read dw.web.URLUtils docs to construct canonical URLs in controllers
Open the catalog XSD to validate import XML and map fields for an ETL job
Download and inspect the latest Script API from a sandbox to match deployed code
List available schemas to confirm which export formats are supported for a migration

FAQ

Do I need the b2c CLI installed globally?

No. You can run the commands with npx @salesforce/b2c-cli if you do not have a global installation.

Can I get output suitable for programmatic use?

Yes. Use --json or --raw to produce JSON or raw markdown for piping into other tools or scripts.