How do I see the full details of a specific API endpoint?

You can use the --expand-paths flag followed by the specific endpoint path to see the full request and response details for that resource.

Why are schemas 'collapsed' by default?

Collapsed schemas are optimized for LLM context windows, providing a structural outline that allows the AI to understand the API surface without consuming excessive tokens.

Do I need the B2C CLI installed to use this skill?

Yes, this skill interfaces with the @salesforce/b2c-cli. If it is not installed globally, the skill can utilize npx to run commands.

Can I use this skill with Salesforce sandboxes?

Yes, you can derive the Tenant ID from your sandbox hostname by replacing hyphens with underscores (e.g., zzxy-001 becomes zzxy_001).

What is the difference between Tenant ID and Organization ID?

The Tenant ID (e.g., zzxy_prd) is used for CLI commands and schema retrieval, while the Organization ID (e.g., f_ecom_zzxy_prd) is typically used in actual SCAPI URLs and has a prefix.

B2C SCAPI Schema Explorer

Name: B2C SCAPI Schema Explorer
Author: SalesforceCommerceCloud

bySalesforceCommerceCloud

•

电子商务解决方案

Explores and retrieves Salesforce Commerce Cloud (SFCC) SCAPI OpenAPI schemas with LLM-optimized output formats.

The B2C SCAPI Schemas skill streamlines the process of discovering and inspecting Salesforce B2C Commerce API specifications. It allows developers to browse available Shopper and Data APIs, filter by family or version, and retrieve OpenAPI schemas in a variety of formats. A standout feature is its ability to produce 'collapsed' schema outlines, which provide a high-level view of endpoints and data models to save context window space for AI agents, while still allowing for the granular expansion of specific paths or objects when needed. This is an essential tool for developers building integrations, debugging API requests, or generating type definitions for Salesforce Commerce Cloud.

主要功能

01Retrieve LLM-optimized collapsed schemas to maximize context efficiency.

0222 GitHub stars

03Selectively expand specific paths, schemas, or examples for detailed inspection.

04List and filter SCAPI schemas by API family, name, or status.

05Support for multiple output formats including JSON and YAML with metadata.

06Automated tenant ID derivation from hostnames for seamless instance switching.

使用场景

01Exploring Salesforce Shopper API endpoints to understand request and response formats.

02Auditing B2C Commerce data models for custom integration development.

03Generating context-aware documentation for specific API versions in an AI-driven workflow.

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add salesforcecommercecloud/b2c-developer-tooling b2c-scapi-schemas

For use in Claude.ai and ChatGPT

Download Skill