Agent-Skills.md

Agent Skills: B2C SCAPI Custom APIs Skill

Check Custom SCAPI (B2C/SFCC/Demandware) endpoint registration status with the b2c cli. Always reference when using the CLI to check custom API endpoint status, verify custom API deployment, or debug "endpoint not found" errors. For creating new custom APIs, use b2c-custom-api-development skill instead.

UncategorizedID: SalesforceCommerceCloud/b2c-developer-tooling/b2c-scapi-custom

Repository

SalesforceCommerceCloud/b2c-developer-tooling
SalesforceCommerceCloudLicense: Apache-2.0
203

Install this agent skill to your local

pnpm dlx add-skill https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/tree/HEAD/skills/b2c-cli/skills/b2c-scapi-custom

Skill Files

Browse the full folder contents for b2c-scapi-custom.

Download Skill

Loading file tree…

skills/b2c-cli/skills/b2c-scapi-custom/SKILL.md

Skill Metadata

Name
b2c-scapi-custom
Description
Check custom SCAPI endpoint registration status using the b2c CLI. Use this skill whenever the user needs to verify that their custom API endpoints are registered and working, debug 404 or "endpoint not found" errors on custom APIs, or list custom API endpoints and their deployment status — even if they just say "my custom API returns 404" or "is my endpoint deployed".

B2C SCAPI Custom APIs Skill

Use the b2c CLI plugin to manage SCAPI Custom API endpoints and check their registration status.

Tip: If b2c is not installed globally, use npx @salesforce/b2c-cli instead (e.g., npx @salesforce/b2c-cli scapi custom status).

Configuration

Values like tenantId and shortCode resolve from dw.json / SFCC_* env vars / the active instance. Examples below show minimal usage; add flags only to override configured values. If a required value is missing, the CLI emits an actionable error pointing at the flag, env var, and config key. See the b2c-config skill for precedence details.

Tenant ID vs. Organization ID

The tenant ID identifies your B2C Commerce instance. It is not the same as the organization ID:

  • Tenant ID: zzxy_prd (the tenantId value in dw.json, or --tenant-id override)
  • Organization ID: f_ecom_zzxy_prd (used in SCAPI URLs, has f_ecom_ prefix)

Deriving Tenant ID from Hostname

For sandbox instances, derive the tenant ID from the hostname by replacing hyphens with underscores:

| Hostname | Tenant ID | |----------|-----------| | zzpq-013.dx.commercecloud.salesforce.com | zzpq_013 | | zzxy-001.dx.commercecloud.salesforce.com | zzxy_001 | | abcd-dev.dx.commercecloud.salesforce.com | abcd_dev |

For production instances, use your realm and instance identifier (e.g., zzxy_prd).

Examples

Get Custom API Endpoint Status

# list all Custom API endpoints for the configured tenant
b2c scapi custom status

# list with JSON output
b2c scapi custom status --json

# target a different tenant than the active config
b2c scapi custom status --tenant-id zzxy_prd

Filter by Status

# list only active endpoints
b2c scapi custom status --status active

# list only endpoints that failed to register
b2c scapi custom status --status not_registered

Group by Type or Site

# group endpoints by API type (Admin vs Shopper)
b2c scapi custom status --group-by type

# group endpoints by site
b2c scapi custom status --group-by site

Customize Output Columns

# show extended columns (includes error reasons, sites, etc.)
b2c scapi custom status --extended

# select specific columns to display
b2c scapi custom status --columns type,apiName,status,sites

# available columns: type, apiName, apiVersion, cartridgeName, endpointPath, httpMethod, status, sites, securityScheme, operationId, schemaFile, implementationScript, errorReason, id

Debug Failed Registrations

# quickly find and diagnose failed Custom API registrations
b2c scapi custom status --status not_registered --columns type,apiName,endpointPath,errorReason

Configuration Overrides

The tenant ID and short code can be overridden via flags or environment variables:

  • --tenant-id / SFCC_TENANT_ID / tenantId in dw.json
  • --short-code / SFCC_SHORTCODE / shortCode in dw.json

More Commands

See b2c scapi custom --help for a full list of available commands and options.

Related Skills

  • b2c:b2c-custom-api-development - Creating Custom API endpoints (schema, script, mapping)
  • b2c-cli:b2c-code - Deploying and activating code versions (triggers registration)