sfcc-localserviceregistry

SFCC B2C Commerce: LocalServiceRegistry Best Practices

This guide provides a concise overview of best practices for creating server-to-server integrations in Salesforce B2C Commerce Cloud using the dw.svc.LocalServiceRegistry.

1. Core Architecture: Configuration and Code

Integrations use a two-part architecture:

Declarative Configuration (Business Manager): Defines the what, who, and how of the service call. This includes the endpoint, credentials, and operational policies like timeouts and circuit breakers.

Programmatic Definition (Script Module): Defines the dynamic behavior using callbacks. This includes creating the request payload, parsing the response, and defining mock behavior for testing.

Business Manager Configuration Summary

Best Practice: Use a period-delimited naming convention for the Service ID (e.g., int_myapi.http.customer.get) to organize logs effectively.

2. Script Implementation with LocalServiceRegistry

The modern approach uses dw.svc.LocalServiceRegistry to define service behavior locally, eliminating the need for global initialization scripts.

Key Callbacks

The createService method takes a configuration object with the following core callback functions:

• createRequest(svc,...params): Configures the outgoing request (URL, method, headers) and returns the request body (e.g., a JSON string).

• parseResponse(svc, client): Processes the raw HTTP response (dw.net.HTTPClient). It should parse the response body (e.g., JSON.parse(client.text)) and throw an Error if the status code indicates a failure (e.g., client.statusCode >= 400). This ensures the result.ok flag is set correctly.