sfcc-scapi-custom-endpoints

What problem does it solve?

This skill provides a structured guide to design, implement, and validate SCAPI Custom APIs in Salesforce B2C Commerce Cloud, covering contracts, mappings, and server-side scripts to streamline endpoint development.

Core Features & Use Cases

• Structured cartridge layout guidance: sets up the rest-apis/{api-name} folder with schema.yaml, script.js, and api.json.
• OpenAPI-compliant contracts: enforce schema.yaml correctness and endpoint definitions with proper security scopes.
• Mapping & implementation workflow: align endpoints to exported functions and ensure proper activation steps for code versions.
• Use Case: Create a new custom endpoint for a loyalty service following the provided structure and mapping.

Quick Start

Create a new SCAPI endpoint by adding cartridge/rest-apis/{api-name}/ with a schema.yaml, a script.js, and an api.json, then activate the code version to register the endpoint.