Back to Details

b2c-docs

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

B2C Docs Skill

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
).
使用
b2c
CLI搜索和阅读Salesforce B2C Commerce的内置Script API文档及XSD模式。
提示： 如果未全局安装
b2c
，请改用
npx @salesforce/b2c-cli
（例如：
npx @salesforce/b2c-cli docs search ProductMgr
）。

Examples

示例

Search Documentation

搜索文档

bash
undefined
bash
undefined

Search for a class by name

按名称搜索类

b2c docs search ProductMgr
b2c docs search ProductMgr

Search with partial match

模糊匹配搜索

b2c docs search "catalog product"
b2c docs search "catalog product"

Limit results

限制结果数量

b2c docs search status --limit 5
b2c docs search status --limit 5

List all available documentation

列出所有可用文档

b2c docs search --list
undefined
b2c docs search --list
undefined

Read Documentation

查阅文档

bash
undefined
bash
undefined

Read documentation for a class (renders in terminal)

查阅类文档（在终端中渲染）

b2c docs read ProductMgr
b2c docs read ProductMgr

Read by fully qualified name

按完全限定名称查阅

b2c docs read dw.catalog.ProductMgr
b2c docs read dw.catalog.ProductMgr

Output raw markdown (for piping)

输出原始Markdown格式（用于管道操作）

b2c docs read ProductMgr --raw
b2c docs read ProductMgr --raw

Output as JSON

以JSON格式输出

b2c docs read ProductMgr --json
undefined
b2c docs read ProductMgr --json
undefined

Download Documentation

下载文档

Download the latest Script API documentation from a B2C Commerce instance:
bash
undefined
从B2C Commerce实例下载最新的Script API文档：
bash
undefined

Download to a directory

下载到指定目录

b2c docs download ./my-docs
b2c docs download ./my-docs

Download with specific server

指定服务器下载

b2c docs download ./docs --server sandbox.demandware.net
b2c docs download ./docs --server sandbox.demandware.net

Keep the original archive

保留原始压缩包

b2c docs download ./docs --keep-archive
undefined
b2c docs download ./docs --keep-archive
undefined

Read XSD Schemas

查阅XSD模式

Read bundled XSD schema files for import/export data formats:
bash
undefined
查阅用于数据导入/导出格式的内置XSD模式文件：
bash
undefined

Read a schema by name

按名称查阅模式

b2c docs schema catalog
b2c docs schema catalog

Fuzzy match schema name

模糊匹配模式名称

b2c docs schema order
b2c docs schema order

List all available schemas

列出所有可用模式

b2c docs schema --list
b2c docs schema --list

Output as JSON

以JSON格式输出

b2c docs schema catalog --json
undefined
b2c docs schema catalog --json
undefined

Common Classes

常用类

ClassDescription
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
类描述
dw.catalog.ProductMgr
商品管理与查询
dw.catalog.Product
商品数据与属性
dw.order.Basket
购物车操作
dw.order.Order
订单处理
dw.customer.CustomerMgr
客户管理
dw.system.Site
站点配置
dw.web.URLUtils
URL生成工具

Common Schemas

常用模式

SchemaDescription
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
模式描述
catalog
商品目录导入/导出
order
订单数据导入/导出
customer
客户数据导入/导出
inventory
库存数据导入/导出
pricebook
价格手册导入/导出
promotion
促销规则定义
coupon
优惠券代码导入/导出
jobs
作业步骤定义

More Commands

更多命令

See 
b2c docs --help
for a full list of available commands and options.
查看
b2c docs --help
获取所有可用命令及选项的完整列表。