sfcc-hooks-registration

To register SFCC hooks, create a top-level cartridge package.json defining the hooks path, map hook names to script files in hooks.json, export functions as CommonJS exports, and enable the OCAPI/SCAPI hook execution feature in Business Manager.

SFCC hooks may not trigger if the hooks.json mappings are incorrect, the package.json hooks path is misconfigured, the OCAPI/SCAPI hook execution feature switch is disabled in Business Manager, or the cartridge is not in the site cartridge path.

Export SFCC hook functions as CommonJS exports using the unqualified hook name, such as exporting 'dw.order.calculate' as 'exports.calculate' in your script file for hooks.json to map correctly.

Yes, you must enable the Salesforce Commerce Cloud API hook execution feature switch in Business Manager for OCAPI/SCAPI hooks to execute properly after cartridge deployment.

For Shopper API hooks, returning a value skips the system implementation entirely. Return nothing from the hook function when you want the default SFCC system implementation to run.

In SFCC hooks.json, the script path is resolved relative to the location of the hooks.json file itself, while the hooks path defined in package.json is resolved relative to the package.json location.