B2C Developer Toolkit

Appearance

View as Markdown
View as Markdown

SCAPI Custom APIs ​

MCP tools for working with custom SCAPI endpoints — scaffold a new endpoint locally, then check its registration status once deployed. Available in the SCAPI, PWAV3, and STOREFRONTNEXT toolsets (SCAPI is always enabled).

For schema definitions of custom APIs, use scapi_schemas_list with apiFamily: "custom".

scapi_custom_api_generate_scaffold ​

Scaffold a new custom SCAPI endpoint in an existing cartridge. Creates schema.yaml (OAS 3.0 contract), api.json (endpoint mapping), and script.js (implementation stub) under rest-apis/<apiName>/.

Authentication ​

No authentication or instance required. This tool writes files locally into your project.

Parameters ​

ParameterTypeRequiredDescription
apiNamestringYesAPI name in kebab-case (e.g. my-products). Must start with a lowercase letter; only letters, numbers, and hyphens.
cartridgeNamestringNoCartridge that will contain the API. Omit to use the first cartridge found under the project (working directory or projectRoot).
apiType"admin" | "shopper"Noshopper (siteId, customer-facing) or admin (no siteId). Default: shopper.
apiDescriptionstringNoShort description of the API.
projectRootstringNoProject root for cartridge discovery. Default: MCP working directory (--project-directory / SFCC_PROJECT_DIRECTORY).
outputDirstringNoOutput directory override. Default: project root (scaffold writes under cartridge path).

Returns: {scaffold, outputDir, files: [{path, action}], postInstructions}. Errors if no cartridge is found.

Usage ​

Create a shopper API (default cartridge):

Scaffold a custom API named product-recommendations, type shopper, with description "Product recommendations by segment".

Create an admin API in a specific cartridge:

Create a custom admin API named inventory-sync in cartridge app_custom.

Next steps after scaffolding ​

  1. Edit schema.yaml to define paths, request/response schemas, and operation IDs.
  2. Implement script.js endpoint logic.
  3. Deploy the cartridge and activate the code version to register the API.
  4. Verify with scapi_custom_apis_get_status that endpoints show as active.

Shopper APIs are available at https://{shortCode}.api.commercecloud.salesforce.com/custom/{apiName}/v1/organizations/{organizationId}/... and require the siteId query parameter and ShopperToken authentication.

scapi_custom_apis_get_status ​

Check the registration status of custom SCAPI endpoints deployed on your B2C Commerce instance. Queries the live instance and returns endpoint status (active or not_registered) with per-site details.

Authentication ​

Requires OAuth credentials with the sfcc.custom-apis scope. See Configuring Scopes and B2C Credentials for setup details.

Configuration priority: Flags (--server, --client-id, --client-secret) → Environment variables (SFCC_SERVER, SFCC_CLIENT_ID, SFCC_CLIENT_SECRET) → dw.json config file

Parameters ​

ParameterTypeRequiredDescription
status"active" | "not_registered"NoFilter by endpoint status. Omit to return all endpoints.
groupBy"site" | "type"NoGroup output by siteId or type (Admin/Shopper). Omit for flat list.
columnsstringNoComma-separated field names to include. Omit for defaults (7 fields). Use all field names for complete data.

Default columns: type, apiName, cartridgeName, endpointPath, httpMethod, status, siteId.

Returns: One row per endpoint per site with status (active or not_registered) and metadata (type, apiName, cartridgeName, endpointPath, httpMethod, siteId).

Usage ​

List all endpoints:

List custom SCAPI endpoints on my instance.

Show only active endpoints, grouped by site:

List active custom API endpoints grouped by site.

See Also ​

Released under the Apache-2.0 License.

Copyright © 2026 Salesforce, Inc.