Hooks, Custom API & Steptypes

The sidebar exposes indexed project views for hooks, custom APIs, and job step types. These panels make SFCC extension points searchable and navigable from the IDE, and the matching Code Lens links each implementation back to the file that registers it

storefront

Intellij SFCC

Explorer

B2C MCP

Log Center

Hooks (3)

app_customhooks.json (3)

loyalty.js./cartridge/scripts/hooks (1)

calculate.js./cartridge/scripts/hooks/cart (1)

basket.js./cartridge/scripts/hooks (1)

int_paymenthooks.json (1)

app_storefront_basehooks.json (12)

Custom API (1)

int_loyaltyAPI: 1 | Paths: 2 | Impl: 2

loyalty(2)

v1/pointsGET

GET

v1/rewardsGET

Steptypes (1)

app_customsteptypes.json (3)

Script Modules(2)

custom.ExportOrders

custom.CleanupBaskets

Chunk Script Modules(1)

Credentials

Intellij SFCC Account

hooks.jsonschema.yamlsteptypes.json

cartridgesapp_customsteptypes.json

2 "step-types": {

3 "script-module-step": [

4 {

5 "@type-id": "custom.ExportOrders",

6 "module": "app_custom/cartridge/scripts/jobs/exportOrders.js",

7 "function": "execute",

8 "transactional": "false"

9 },

10 {

11 "@type-id": "custom.CleanupBaskets",

12 "module": "app_custom/cartridge/scripts/jobs/cleanupBaskets.js",

13 "function": "execute"

14 }

15 ],

16 "chunk-script-module-step": [

17 {

18 "@type-id": "custom.SyncLoyaltyPoints",

19 "module": "app_custom/cartridge/scripts/jobs/syncLoyaltyPoints.js",

20 "read-function": "read",

21 "process-function": "process",

22 "write-function": "write",

23 "chunk-size": 100

24 }

25 ]

26 }

27}

mainJSON

Hooks, Custom API and Steptypes list what the indexes found per cartridge. Row actions open the hooks file, a method's OpenAPI schema or a step definition in steptypes.json

Hooks

The Hooks panel lists the hooks registered in every cartridge's hooks.json. A cartridge's hooks file is found through the hooks entry of its package.json, so a cartridge without that entry shows no hooks

storefront

Explorer

storefront

cartridges

app_custom

cartridge

scripts

hooks

calculate.js

loyalty.js

hooks.json

package.json

app_storefront_base

calculate.jshooks.jsonloyalty.js

app_customcartridgescriptshooksloyalty.js

1'use strict';

3var Status = require('dw/system/Status');

4var helpers = require('*/cartridge/scripts/helpers/basketCalculationHelpers');

dw.order.calculate

6exports.calculate = function (basket) {

7 helpers.calculateTotals(basket);

8 return new Status(Status.OK);

9};

1'use strict';

3var Transaction = require('dw/system/Transaction');

app.loyalty.points → earn

5exports.earn = function (order) {

6 return Math.floor(order.totalGrossPrice.value);

7};

app.loyalty.points → redeem

9exports.redeem = function (customer, points) {

10 Transaction.wrap(function () {

11 customer.profile.custom.loyaltyPoints -= points;

12 });

13};

2 "hooks": [

3 {

4 "name": "dw.order.calculate",

5 "script": "./cartridge/scripts/hooks/calculate.js"

6 },

7 {

8 "name": "app.loyalty.points",

9 "script": "./cartridge/scripts/hooks/loyalty.js"

10 }

11 ]

12}

mainLn 10, Col 1UTF-8SFCC JavaScript

A system hook's function shows the hook it implements, and every function of a custom hook shows hook → function. Click a lens to open its registration in hooks.json

The title-bar toggle switches between Show raw hooks, one row per registration, and Group hooks by script, the hooks of each script file together
Open Hook Declaration opens the registration in hooks.json, Open hooks file opens the whole file, and Open script file opens the script of a grouped row
Search in Hooks opens the find field of the tree, to jump to a hook by name
While the index builds, the panel reads Indexing hooks.... A cartridge whose package.json has no hooks entry adds nothing, and an empty panel reminds you to define the hooks file location in package.json

Every script registered in hooks.json gets a Code Lens naming the hook it implements. A system hook shows the hook name, a custom hook adds the exported function, and a click opens the registration

The exported function itself is marked too: a hook icon in the gutter of its line, and a hover that shows the registration as JSON (name and script) with an Open in hooks.json link

Custom API

storefront

Explorer

storefront

cartridges

app_custom

cartridge

controllers

rest-apis

loyalty

api.json

loyalty.js

schema.yaml

scripts

api.json

app_customcartridgerest-apisloyaltyapi.json

2 "endpoints": [

3 {

GET

4 "endpoint": "getPoints",

/points

5 "schema": "schema.yaml",

6 "implementation": "loyalty"

7 }

8 ]

1'use strict';

3var RESTResponseMgr = require('dw/system/RESTResponseMgr');

schema.yaml | api.json

5exports.getPoints = function () {

6 var points = customer.profile.custom.loyaltyPoints || 0;

7 RESTResponseMgr.createSuccess({ points: points }).render();

8};

10exports.getPoints.public = true;

1openapi: 3.0.0

2info:

3 title: Loyalty Points

4 version: 1.0.0

5paths:

6 /points:

loyalty.js | api.json

7 get:

8 operationId: getPoints

9 summary: Points balance of the current shopper

10 responses:

11 '200':

12 description: OK

mainLn 4, Col 13UTF-8JSON

api.json shows the method and the path of each endpoint, while the script and the schema link to the other two files. Each lens opens its target at the matching operation

The Custom API panel lists the custom SCAPI endpoints of each cartridge: the API folder, its endpoints and paths, and each HTTP method. Each level has its own action:

Row	Actions
Cartridge or API	Open Custom SCAPI Endpoints Folder
Endpoint	Open Custom SCAPI Path Definition
Method	Go to OpenAPI Schema Definition, Go to API JSON Definition, Go to Script Implementation

Use Search in Custom APIs to open the find field of the tree. The three files of an operation, api.json, the OpenAPI schema, and the script, are also linked by Code Lens, so each one opens the other two at the matching operation

Export to Postman

Export to Postman Collection in the panel's title bar turns every indexed custom API into a Postman collection. The Export Custom APIs to Postman Collection (Beta) picker asks for four values, and keeps them for the next export:

Value	What to enter
Collection Name	The name of the collection, also used in the file name
Shop API Client	An API client from Credentials. Its client ID fills the collection's client variable
Tenant	The tenant ID of the instance, such as `aanh_003`
Short Code	The short code of your realm

Click Save and Export Collection, then Select Folder. The extension writes <name>_CustomAPIs.postman_collection.json there and reveals it in your file manager. The collection has a folder per cartridge and one request per method, with the SCAPI token requests it needs, so import it into Postman and fill the remaining collection variables

Steptypes

The Steptypes panel lists the custom job steps declared in each cartridge's steptypes.json, both task-oriented and chunk-oriented steps

storefront

Explorer

storefront

cartridges

app_custom

cartridge

scripts

jobs

exportOrders.js

importProducts.js

package.json

steptypes.json

app_storefront_base

exportOrders.jssteptypes.jsonimportProducts.js

app_customcartridgescriptsjobsimportProducts.js

1'use strict';

3var Status = require('dw/system/Status');

custom.ExportOrders → function

5exports.execute = function (parameters, stepExecution) {

6 exportOrders(parameters.FolderPath);

7 return new Status(Status.OK);

8};

1'use strict';

custom.ImportProducts → readFunction

3exports.read = function () {

4 return products.hasNext() ? products.next() : null;

5};

custom.ImportProducts → processFunction

7exports.process = function (product) {

8 return mapProduct(product);

9};

custom.ImportProducts → writeFunction

11exports.write = function (chunk) {

12 chunk.toArray().forEach(saveProduct);

13};

2 "step-types": {

3 "script-module-step": [

4 {

5 "@type-id": "custom.ExportOrders",

6 "module": "app_custom/cartridge/scripts/jobs/exportOrders.js",

7 "function": "execute"

8 }

9 ],

10 "chunk-script-module-step": [

11 {

12 "@type-id": "custom.ImportProducts",

13 "module": "app_custom/cartridge/scripts/jobs/importProducts.js",

14 "read-function": "read",

15 "process-function": "process",

16 "write-function": "write",

17 "chunk-size": 100

18 }

19 ]

20 }

21}

mainLn 9, Col 1UTF-8SFCC JavaScript

Each job step function shows the step type and the steptypes.json property that calls it. Click the lens to open that property

Open steptypes.json on a cartridge opens its steptypes.json
Open definition in steptypes.json on a step opens that step's declaration
Search in Steptypes opens the find field of the tree, to jump to a step type by ID
While steptypes.json files are read, the panel shows Indexing steptypes.json files...

Each function that a step calls gets a Code Lens that reads step type → property, for example custom.ImportProducts → readFunction. A click opens that property in steptypes.json

Search every index

The same indexes power Smart Search, a picker that finds routes, hooks, step types, custom APIs, and properties by name. See Smart Search

storefront

CheckoutServices.js

cartridgesapp_customcartridgecontrollersCheckoutServices.js

1'use strict';

3var server = require('server');

4server.extend(module.superModule);

6server.append('PlaceOrder', function (req, res, next) {

7 var viewData = res.getViewData();

8 viewData.loyaltyPoints = 120;

9 res.setViewData(viewData);

10 return next();

11});

13module.exports = server.exports();

>export

Intellij SFCC: Search Hooks

Step types (3)

export

custom.ExportOrdersScript :: exportOrders.js

main

Search Hooks, Search Custom APIs and Search Steptypes open a filterable list grouped by cartridge. The title buttons jump between the indexes and the item buttons open the declaration, schema or script

Hooks

Custom API

Export to Postman

Steptypes

Search every index

On this page