b2c-scapi-schemas_skill

This skill helps you explore and retrieve SCAPI OpenAPI schemas using the b2c CLI, clarifying available endpoints and data models for B2C commerce.

TypeScript

20

GitHub Stars

1

Bundled Files

2 months ago

Catalog Refreshed

4 months ago

First Indexed

Readme & install

Copy the install command, review bundled files from the catalogue, and read any extended description pulled from the listing source.

Installation

Preview and clipboard use veilstrat where the catalogue uses aiagentskills.

npx veilstrat add skill salesforcecommercecloud/b2c-developer-tooling --skill b2c-scapi-schemas

SKILL.md4.2 KB

Overview

This skill lets you browse and retrieve Salesforce B2C Commerce (SCAPI) OpenAPI schema specifications using the b2c CLI. It exposes commands to list available schemas, fetch collapsed or fully-expanded schema documents, and output results as JSON or YAML. Use it to inspect API endpoints, request/response shapes, and data models for a given tenant.

How this skill works

The skill calls the b2c CLI plugin to query SCAPI schema metadata for a specified tenant ID and API family/name/version. Commands support listing schemas, listing paths/schemas/examples, and retrieving schemas with options to expand paths, expand specific schema objects, or expand everything. Outputs can be collapsed (default), fully expanded, or formatted as JSON/YAML and streamed to files or pipelines.

When to use it

Exploring available SCAPI endpoints for a specific B2C tenant.
Checking request and response formats before implementing integrations or tests.
Understanding SCAPI data models and schema object relationships.
Finding the correct SCAPI API family/name/version for a task.
Exporting schema files for documentation, code generation, or LLM consumption.

Best practices

Always provide the required --tenant-id (tenant ID differs from organization ID).
Use collapsed output for quick, context-efficient overviews and expand only needed parts for detail.
Filter results by --api-family, --api-name, or --status to reduce noise.
Use --json or --yaml flags when feeding schema output into other tools or CI pipelines.
Set SFCC_TENANT_ID and SFCC_SHORTCODE environment variables in CI to avoid passing flags repeatedly.

Example use cases

List all SCAPI schemas for production tenant: b2c scapi schemas list --tenant-id zzxy_prd.
Fetch a collapsed shopper-products schema and save to file: b2c scapi schemas get product shopper-products v1 --tenant-id zzxy_prd > schema.json.
Expand only product paths for targeted inspection: b2c scapi schemas get product shopper-products v1 --tenant-id zzxy_prd --expand-paths /products
Get full schema for code generation: b2c scapi schemas get product shopper-products v1 --tenant-id zzxy_prd --expand-all --json
List available paths or examples before expanding to decide what to fetch: b2c scapi schemas get product shopper-products v1 --tenant-id zzxy_prd --list-paths

FAQ

The tenant ID identifies your B2C Commerce instance (e.g., zzxy_prd). It is not the organization ID, which has an f_ecom_ prefix. For sandboxes replace hyphens with underscores from the hostname.

Can I use the CLI without installing globally?

Yes. Use npx @salesforce/b2c-cli ... to run commands if the b2c CLI is not installed globally.