b2c-scapi-custom_skill

Overview

This skill checks the registration status of custom SCAPI (B2C/SFCC/Demandware) endpoints using the B2C CLI. It helps verify whether custom API deployment and code activation registered endpoints correctly and surfaces registration errors for troubleshooting. Use this when you need a quick status report or to filter endpoints by status, site, or type.

How this skill works

The skill runs the b2c CLI scapi custom status commands against a specified tenant ID to list registered custom API endpoints and their metadata. It supports JSON output, filtering by status (active, not_registered, etc.), grouping, and selective column output to focus on error reasons, sites, or implementation details. It also accepts environment variables for tenant configuration to simplify repeated checks.

When to use it

• Verify custom API registration after deploying or activating code
• Debug "endpoint not found" or registration failure errors
• Audit which sites or API types have registered endpoints
• Filter and export registration data for incident reports
• Confirm that a recent activation created the expected endpoints

Best practices

• Always provide the required --tenant-id (tenant ID differs from organization ID)
• Use npx @salesforce/b2c-cli if b2c is not installed globally
• Use --json for machine-readable output when scripting or integrating with CI
• Filter by --status not_registered and include errorReason to speed troubleshooting
• Set SFCC_TENANT_ID and SFCC_SHORTCODE environment variables for repeated checks

Example use cases

• List all custom SCAPI endpoints for a tenant: b2c scapi custom status --tenant-id zzxy_prd
• Find failed registrations and see error reasons: b2c scapi custom status --tenant-id zzxy_prd --status not_registered --columns apiName,endpointPath,errorReason
• Group endpoints by API type to confirm Admin vs Shopper registrations: b2c scapi custom status --tenant-id zzxy_prd --group-by type
• Export JSON for automated checks in CI: b2c scapi custom status --tenant-id zzxy_prd --json > scapi-status.json
• Quickly derive sandbox tenant IDs from hostnames by replacing hyphens with underscores (e.g., zzpq-013 -> zzpq_013)