b2c-custom-api-development

npx skills add majiayu000/claude-skill-registry --skill b2c-custom-api-development --agent claude-code

Same command for any agent — swap --agent for codex, cursor, copilot.

# Custom API Development Skill This skill guides you through developing Custom APIs for Salesforce B2C Commerce. Custom APIs let you expose custom script code as REST endpoints under the SCAPI framework. ## Overview A Custom API URL has this structure: ``` https://{shortCode}.api.commercecloud.salesforce.com/custom/{apiName}/{apiVersion}/organizations/{organizationId}/{endpointPath} ``` Three components are required to create a Custom API: 1. **API Contract** - An OAS 3.0 schema file (YAML) 2. **API Implementation** - A script using the B2C Commerce Script API 3. **API Mapping** - An `api.json` file binding endpoints to implementations ## Cartridge Structure Custom APIs are defined within cartridges. Create a `rest-apis` folder in the cartridge directory with subdirectories for each API: ``` /my-cartridge /cartridge package.json /rest-apis /my-api-name # API name (lowercase alphanumeric and hyphens only) api.json # Mapping file schema.yaml # OAS 3.0 contract script.js # Implementation /scripts /controllers ``` **Important:** API directory names can only contain alphanumeric lowercase characters and hyphens. ## Component 1: API Contract (schema.yaml) The API contract defines endpoin

Deploy cartridge and reload (re-activate) to register endpoints
b2c code deploy ./my-cartridge --reload
Or deploy then activate separately
b2c code deploy ./my-cartridge
b2c code activate my-code-version
Check Custom API registration status
Tenant ID: derive from hostname (e.g., zzpq-013 → zzpq_013)
b2c scapi custom status --tenant-id zzpq_013
Filter to see only failed registrations
b2c scapi custom status --tenant-id zzpq_013 --status not_registered