What components are required for a Salesforce B2C Custom API?

A Custom API requires three specific components: an API Contract (schema.yaml using OAS 3.0), an API Implementation (a JavaScript file using B2C Script API), and an API Mapping (api.json) to bind them.

Are there naming restrictions for custom parameters?

Yes, all custom query or path parameters must be prefixed with 'c_' and the API directory names must be lowercase alphanumeric characters or hyphens.

What is the difference between Shopper and Admin APIs in this context?

Shopper APIs use ShopperToken security, require a siteId, and have a 10-second timeout. Admin APIs use AmOAuth2 security, omit the siteId, and allow up to 60 seconds of runtime.

How do I register a new Custom API endpoint?

Endpoints are registered automatically when you upload your cartridge to a B2C instance and activate the corresponding code version.

Does this skill help with Custom API error handling?

Yes, it enforces the use of RESTResponseMgr for RFC 9457 error formats and provides guidance on avoiding circuit breaker triggers by managing error rates.

Salesforce B2C Custom API Development

Name: Salesforce B2C Custom API Development
Author: SalesforceCommerceCloud

bySalesforceCommerceCloud

•

API Development

Develops and deploys custom REST endpoints for Salesforce B2C Commerce using the SCAPI framework and OAS 3.0 specifications.

About

This skill provides a comprehensive framework for building Custom APIs within the Salesforce B2C Commerce ecosystem. It guides developers through the three essential components of custom API creation: defining the API Contract using OpenAPI 3.0 (OAS), implementing logic using the B2C Commerce Script API, and configuring endpoint mappings. By automating the boilerplate and enforcing best practices for security, caching, and error handling, this skill enables developers to securely expose custom backend logic to headless applications and external integrations.

Key Features

Performance optimization through circuit breaker protection and response caching
Support for Shopper (SLAS) and Admin (AM) authentication schemes
API mapping configuration for binding endpoints to implementations
B2C Script implementation logic with automated public export marking
OAS 3.0 schema generation and validation for API contracts
4 GitHub stars

Use Cases

Developing secure admin-level APIs for third-party system integrations and data synchronization
Building custom REST endpoints to extend Salesforce Commerce Cloud functionality for headless frontends
Implementing specialized shopper-facing services with custom scopes and site-specific logic

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add salesforcecommercecloud/b2c-developer-tooling b2c-custom-api-development

For use in Claude.ai and ChatGPT

Download Skill

GitHub