Salesforce Commerce Cloud B2C

https://salesforcecommercecloud.github.io/b2c-dev-doc
Admin
Salesforce Commerce Cloud B2C is an enterprise e-commerce platform providing APIs, scripts, and...
Tokens:336,185
Snippets:2,119
Trust Score:8.3
Update:1 week ago
Show doc for...
Tokens:
Raw
### RedirectURL controller with Start and Hostname endpoints

Source: https://salesforcecommercecloud.github.io/b2c-dev-doc/docs/current/sfrajsdoc/js/server/app_storefront_base_cartridge_controllers_RedirectURL.js.html

Defines the RedirectURL controller with two GET endpoints. Start uses URLRedirectMgr to redirect to a stored location, setting a 404 and rendering error/notFound if no location exists. Hostname validates the Location query parameter against the current host and redirects to the URL or the site home page if invalid. Both endpoints call next() after handling the request.

```javascript
'use strict';

/**
 * @namespace RedirectURL
 */

var server = require('server');

/**
 * RedirectURL-Start : The RedirectURL-Start endpoint handles URL redirects
 * @name Base/RedirectURL-Start
 * @function
 * @memberof RedirectURL
 * @param {category} - non-sensitive
 * @param {serverfunction} - get
 */
server.get('Start', function (req, res, next) {
    var URLRedirectMgr = require('dw/web/URLRedirectMgr');

    var redirect = URLRedirectMgr.redirect;
    var location = redirect ? redirect.location : null;
    var redirectStatus = redirect ? redirect.getStatus() : null;

    if (!location) {
        res.setStatusCode(404);
        res.render('error/notFound');
    } else {
        if (redirectStatus) {
            res.setRedirectStatus(redirectStatus);
        }
        res.redirect(location);
    }

    next();
});

/**
 * RedirectURL-Hostname : The RedirectURL-Hostname endpoint handles Hostname-only URL redirects
 * @name Base/RedirectURL-Hostname
 * @function
 * @memberof RedirectURL
 * @param {querystringparameter} - Location - optional parameter to provide a URL to redirect to
 * @param {category} - non-sensitive
 * @param {serverfunction} - get
 */
server.get('Hostname', function (req, res, next) {
    var URLUtils = require('dw/web/URLUtils');

    var url = req.querystring.Location.stringValue;
    var hostRegExp = new RegExp('^https?://' + req.httpHost + '(?=/|$)');
    var location;

    if (!url || !hostRegExp.test(url)) {
        location = URLUtils.httpHome().toString();
    } else {
        location = url;
    }

    res.redirect(location);
    next();
});

module.exports = server.exports();
```

--------------------------------

### get(name, arguments) → {void}

Source: https://salesforcecommercecloud.github.io/b2c-dev-doc/docs/current/sfrajsdoc/js/server/Server.html

Shortcut to "use" method that adds a check for GET request.

```APIDOC
## get(name, arguments) → {void}

### Description
Shortcut to "use" method that adds a check for get request.

### Method
`get(name, arguments)`

### Parameters
- **name** (string) - Required - Name of the route
- **arguments** (Array.<function()>) - Required - List of functions to be executed

### Returns
- **void**

### Source
- modules/server/server.js, line 114

```

--------------------------------

### SourceCodeRedirect.js - Start endpoint

Source: https://salesforcecommercecloud.github.io/b2c-dev-doc/docs/current/sfrajsdoc/js/server/app_storefront_base_cartridge_controllers_SourceCodeRedirect.js.html

Defines the 'Start' endpoint for the SourceCodeRedirect controller. It reads the redirect source ID from the 'src' query parameter, retrieves the redirect URL from session.sourceCodeInfo.redirect, and redirects to that location or to the home page if not set. Requires the 'src' parameter to be configured in ECOM Business Manager.

```javascript
'use strict';

/**
 * @namespace SourceCodeRedirect
 */

var server = require('server');
var URLUtils = require('dw/web/URLUtils');

/**
 * SourceCodeRedirect-Start : This endpoint allows the shopper to forward calls to other endpoints that is predefined in the business manager and redirect to a different page. An example will be forward to Link-Product or Link-Category endpoint based on the query parameter a shopper has provided
 * @name Base/SourceCodeRedirect-Start
 * @function
 * @memberof SourceCodeRedirect
 * @param {querystringparameter} - src - the redirect source id, for example 'privacy3' (note, this id needs to be configured in ECOM BM)
 * @param {category} - non-sensitive
 * @param {serverfunction} - get
 */
server.get('Start', function (req, res, next) {
    var sourceCodeRedirectURL = session.sourceCodeInfo.redirect; // eslint-disable-line no-undef
    if (sourceCodeRedirectURL) {
        res.redirect(sourceCodeRedirectURL.location);
    } else {
        res.redirect(URLUtils.url('Home-Show'));
    }

    next();
});

module.exports = server.exports();
```

--------------------------------

### GET Product

Source: https://salesforcecommercecloud.github.io/b2c-dev-doc/docs/current/sfrajsdoc/js/server/app_storefront_base_cartridge_controllers_Link.js.html

Redirects to the Product-Show endpoint with the provided query string, used for product id redirects.

```APIDOC
## GET Product

### Description
This endpoint is called when a sourcecode redirect has an input parameter product id. It redirects to the Product-Show endpoint with the same query string.

### Method
GET

### Endpoint
Product

### Parameters
#### Query Parameters
- **pid** (string) - Required - Product id, for example 'ps3bundle5' (note, this id needs to be configured in ECOM BM)

### Response
#### Success Response (302)
Redirects to Product-Show with the query string.

```

--------------------------------

### setupSearch function in searchHelpers.js

Source: https://salesforcecommercecloud.github.io/b2c-dev-doc/docs/current/sfrajsdoc/js/server/app_storefront_base_cartridge_scripts_helpers_searchHelpers.js.html

Configures a product search model with sorting, category, and refinement values. Requires a ProductSearchModel instance, HTTP query parameters, and an httpParameterMap. Returns the configured search model.

```javascript
function setupSearch(apiProductSearch, params, httpParameterMap) {
    var CatalogMgr = require('dw/catalog/CatalogMgr');
    var searchModelHelper = require('*/cartridge/scripts/search/search');

    var sortingRule = params.srule ? CatalogMgr.getSortingRule(params.srule) : null;
    var selectedCategory = CatalogMgr.getCategory(params.cgid);
    selectedCategory = selectedCategory && selectedCategory.online ? selectedCategory : null;

    searchModelHelper.setProductProperties(apiProductSearch, params, selectedCategory, sortingRule, httpParameterMap);

    if (params.preferences) {
        searchModelHelper.addRefinementValues(apiProductSearch, params.preferences);
    }

    return apiProductSearch;
}
```

--------------------------------

### get(name, ...middleware)

Source: https://salesforcecommercecloud.github.io/b2c-dev-doc/docs/current/sfrajsdoc/js/server/modules_server_server.js.html

Shortcut to the use method that adds a check for GET requests. Registers a route that only responds to GET requests.

```APIDOC
## get(name, ...middleware)

### Description
Shortcut to the use method that adds a check for GET requests. Registers a route that only responds to GET requests.

### Method
get

### Parameters
- **name** (string) - Required - Name of the route
- **...middleware** (Function[]) - Required - List of functions to be executed

### Returns
void
```

--------------------------------

### Base/Product-ShowQuickView()

Source: https://salesforcecommercecloud.github.io/b2c-dev-doc/docs/current/sfrajsdoc/js/server/Product.html

This endpoint is called when a product quick view button is clicked. It uses promotion-sensitive caching and returns a view.

```APIDOC
## Base/Product-ShowQuickView()

### Description
This endpoint is called when a product quick view button is clicked.

### Method
GET

### Endpoint
Base/Product-ShowQuickView

### Parameters
#### Query Parameters
- **pid** (string) - Required - Product ID

#### Middleware
- **cache.applyPromotionSensitiveCache** - Applies promotion-sensitive caching

### Response
No explicit response type specified.

### Category
non-sensitive
```

--------------------------------

### get(req, res, next) → {void}

Source: https://salesforcecommercecloud.github.io/b2c-dev-doc/docs/current/sfrajsdoc/js/server/global.html

Middleware filter for GET requests.

```APIDOC
## get(req, res, next) → {void}

### Description
Middleware filter for get requests.

### Parameters
- **req** (Object) - Required - Request object
- **res** (Object) - Required - Response object
- **next** (function) - Required - Next call in the middleware chain

### Returns
- **void** - No return value

### Source
- modules/server/middleware.js, line 10
```

--------------------------------

### GET ShowQuickView

Source: https://salesforcecommercecloud.github.io/b2c-dev-doc/docs/current/sfrajsdoc/js/server/app_storefront_base_cartridge_controllers_Product.js.html

Called when a product quick view button is clicked. Returns a rendered quick view template and the product URL.

```APIDOC
## GET ShowQuickView

### Description
Called when a product quick view button is clicked. Returns a rendered quick view template and the product URL.

### Method
GET

### Endpoint
Product-ShowQuickView

### Parameters
#### Query Parameters
- **pid** (querystringparameter) - Required - Product ID

### Response
#### Success Response
Returns JSON with renderedTemplate and productUrl.

#### Response Example
{
  "renderedTemplate": "",
  "productUrl": ""
}
```

--------------------------------

### new Server()

Source: https://salesforcecommercecloud.github.io/b2c-dev-doc/docs/current/sfrajsdoc/js/server/Server.html

Constructor for the Server class. Initializes a new Server instance.

```APIDOC
## new Server()

### Description
Creates a new instance of the Server class.

### Constructor
`new Server()`

### Source
- modules/server/server.js, line 40

```

--------------------------------

### Base/ReportingEvent-MiniCart()

Source: https://salesforcecommercecloud.github.io/b2c-dev-doc/docs/current/sfrajsdoc/js/server/ReportingEvent.html

The ReportingEvent-MiniCart endpoint gets the reporting event basket open. It is a GET server function that renders an ISML template.

```APIDOC
## Base/ReportingEvent-MiniCart()

### Description
The ReportingEvent-MiniCart endpoint gets the reporting event basket open.

### Method
GET

### Endpoint
Base/ReportingEvent-MiniCart

### Parameters
#### Path Parameters
- None

#### Query Parameters
- None

#### Request Body
- None

### Request Example
None

### Response
#### Success Response (200)
- Renders ISML template

#### Response Example
None
```

--------------------------------

### use(name, arguments) → {void}

Source: https://salesforcecommercecloud.github.io/b2c-dev-doc/docs/current/sfrajsdoc/js/server/Server.html

Creates a new route with a name and a list of middleware.

```APIDOC
## use(name, arguments) → {void}

### Description
Creates a new route with a name and a list of middleware.

### Method
`use(name, arguments)`

### Parameters
- **name** (string) - Required - Name of the route
- **arguments** (Array.<function()>) - Required - List of functions to be executed

### Returns
- **void**

### Source
- modules/server/server.js, line 51

```

--------------------------------

### Tile.js - server.get('Show') route for product tile rendering

Source: https://salesforcecommercecloud.github.io/b2c-dev-doc/docs/current/sfrajsdoc/js/server/app_storefront_base_cartridge_controllers_Tile.js.html

Defines the 'Show' route for the Tile controller. It uses cache.applyPromotionSensitiveCache middleware, reads query string parameters (pid, ratings, swatches, pview, quantity, dwvar_<pid>_color, dwvar_<pid>_size), builds a product tile context, and renders product/gridTile.isml. On product factory errors, it falls back to Home-Show URLs.

```javascript
'use strict';

/**
 * @namespace Tile
 */

var server = require('server');

var cache = require('*/cartridge/scripts/middleware/cache');

/**
 * Tile-Show : Used to return data for rendering a product tile
 * @name Base/Tile-Show
 * @function
 * @memberof Tile
 * @param {middleware} - cache.applyPromotionSensitiveCache
 * @param {querystringparameter} - pid - the Product ID
 * @param {querystringparameter} - ratings - boolean to determine if the reviews should be shown in the tile
 * @param {querystringparameter} - swatches - boolean to determine if the swatches should be shown in the tile
 * @param {querystringparameter} - pview - string to determine if the product factory returns a model for a tile or a pdp/quickview display
 * @param {querystringparameter} - quantity - Quantity
 * @param {querystringparameter} - dwvar_<pid>_color - Color Attribute ID
 * @param {querystringparameter} - dwvar_<pid>_size - Size Attribute ID
 * @param {category} - non-sensitive
 * @param {renders} - isml
 * @param {serverfunction} - get
 */
server.get('Show', cache.applyPromotionSensitiveCache, function (req, res, next) {
    var URLUtils = require('dw/web/URLUtils');
    var ProductFactory = require('*/cartridge/scripts/factories/product');

    // The req parameter has a property called querystring. In this use case the querystring could
    // have the following:
    // pid - the Product ID
    // ratings - boolean to determine if the reviews should be shown in the tile.
    // swatches - boolean to determine if the swatches should be shown in the tile.
    //
    // pview - string to determine if the product factory returns a model for
    //         a tile or a pdp/quickview display
    var productTileParams = { pview: 'tile' };
    Object.keys(req.querystring).forEach(function (key) {
        productTileParams[key] = req.querystring[key];
    });

    var product;
    var productUrl;
    var quickViewUrl;

    // TODO: remove this logic once the Product factory is
    // able to handle the different product types
    try {
        product = ProductFactory.get(productTileParams);
        productUrl = URLUtils.url('Product-Show', 'pid', product.id).relative().toString();
        quickViewUrl = URLUtils.url('Product-ShowQuickView', 'pid', product.id)
            .relative().toString();
    } catch (e) {
        product = false;
        productUrl = URLUtils.url('Home-Show');// TODO: change to coming soon page
        quickViewUrl = URLUtils.url('Home-Show');
    }

    var context = {
        product: product,
        urls: {
            product: productUrl,
            quickView: quickViewUrl
        },
        display: {}
    };

    Object.keys(req.querystring).forEach(function (key) {
        if (req.querystring[key] === 'true') {
            context.display[key] = true;
        } else if (req.querystring[key] === 'false') {
            context.display[key] = false;
        }
    });

    res.render('product/gridTile.isml', context);

    next();
});

module.exports = server.exports();
```

--------------------------------

### GET Base/Cart-MiniCartShow

Source: https://salesforcecommercecloud.github.io/b2c-dev-doc/docs/current/sfrajsdoc/js/server/Cart.html

The Cart-MiniCartShow endpoint is responsible for getting the basket and showing the contents when you hover over the minicart in the header. It renders an ISML template.

```APIDOC
## GET Base/Cart-MiniCartShow

### Description
The Cart-MiniCartShow endpoint is responsible for getting the basket and showing the contents when you hover over the minicart in the header.

### Method
GET

### Endpoint
Base/Cart-MiniCartShow

### Parameters
None

### Response
#### Success Response
Renders ISML.

```

--------------------------------

### new Images(product, imageConfig)

Source: https://salesforcecommercecloud.github.io/b2c-dev-doc/docs/current/sfrajsdoc/js/server/Images.html

Constructor for the Images class. Initializes an instance to return images for a given product using the provided image configuration.

```APIDOC
## new Images(product, imageConfig)

### Description
Creates an Images instance that returns images for a given product.

### Constructor
`new Images(product, imageConfig)`

### Parameters
- **product** (dw.catalog.Product) - Required - The product to return images for.
- **imageConfig** (Object) - Required - Configuration object with image types.

### Source
- app_storefront_base/cartridge/models/product/productImages.js, line 11
```

--------------------------------

### GET Base/PaymentInstruments-Header

Source: https://salesforcecommercecloud.github.io/b2c-dev-doc/docs/current/sfrajsdoc/js/server/PaymentInstruments.html

The PaymentInstruments-Header endpoint is used as a remote include that renders the account header ISML template. It uses GET and requires the server.middleware.include middleware.

```APIDOC
## [GET] Base/PaymentInstruments-Header

### Description
The PaymentInstruments-Header endpoint is used as a remote include that renders the account header ISML template.

### Method
GET

### Endpoint
Base/PaymentInstruments-Header

### Parameters
#### Middleware
- **middleware** (server.middleware.include) - Required - Middleware for remote includes.

### Category
sensitive

### Server Function
get
```

--------------------------------

### GET Base/Order-History

Source: https://salesforcecommercecloud.github.io/b2c-dev-doc/docs/current/sfrajsdoc/js/server/Order.html

This endpoint is invoked to get order history for the logged-in shopper. It uses consent tracking, HTTPS, and user login validation middleware.

```APIDOC
## GET Base/Order-History

### Description
This endpoint is invoked to get Order History for the logged in shopper.

### Method
GET

### Endpoint
Base/Order-History

### Parameters
None

### Middleware
- consentTracking.consent
- server.middleware.https
- userLoggedIn.validateLoggedIn

### Category
sensitive
```

--------------------------------

### Document Ready Initialization

Source: https://salesforcecommercecloud.github.io/b2c-dev-doc/docs/current/sfrajsdoc/js/client/einsteinCarousel.js.html

Initializes the recommendation loading process once the document is fully loaded.

```javascript
$(document).ready(function () {
    loadRecommendations();
});
```

--------------------------------

### Base/Default-Start()

Source: https://salesforcecommercecloud.github.io/b2c-dev-doc/docs/current/sfrajsdoc/js/server/Default.html

This method is the root endpoint of the site, executed when opening from the Business Manager. It uses consent tracking middleware and applies default cache.

```APIDOC
## Base/Default-Start()

### Description
This method is the root endpoint of the site, executed when opening from the Business Manager. It uses consent tracking middleware and applies default cache.

### Method
GET

### Endpoint
/

### Parameters
#### Middleware
- **middleware** (consentTracking.consent) - Required - Consent tracking middleware.
- **middleware** (cache.applyDefaultCache) - Required - Applies default cache.

### Response
#### Success Response (200)
- **renders** (isml) - Renders the ISML template.

### Response Example
(No response example provided in source.)

```

--------------------------------

### GET Base/PaymentInstruments-AddPayment

Source: https://salesforcecommercecloud.github.io/b2c-dev-doc/docs/current/sfrajsdoc/js/server/PaymentInstruments.html

The PaymentInstruments-AddPayment endpoint renders the page that allows a shopper to save a payment instrument to their account. It uses GET and requires CSRF protection, consent tracking, and user login validation.

```APIDOC
## [GET] Base/PaymentInstruments-AddPayment

### Description
The PaymentInstruments-AddPayment endpoint renders the page that allows a shopper to save a payment instrument to their account.

### Method
GET

### Endpoint
Base/PaymentInstruments-AddPayment

### Parameters
#### Middleware
- **middleware** (csrfProtection.generateToken) - Required - CSRF protection middleware to generate a token.
- **middleware** (consentTracking.consent) - Required - Consent tracking middleware.
- **middleware** (userLoggedIn.validateLoggedIn) - Required - Validates that the user is logged in.

### Category
sensitive

### Server Function
get
```

--------------------------------

### GET Base/Order-Details

Source: https://salesforcecommercecloud.github.io/b2c-dev-doc/docs/current/sfrajsdoc/js/server/Order.html

This endpoint is called to get order details. It uses consent tracking, HTTPS, and user login validation middleware, and accepts order ID and order filter as query parameters.

```APIDOC
## GET Base/Order-Details

### Description
This endpoint is called to get Order Details.

### Method
GET

### Endpoint
Base/Order-Details

### Parameters
#### Query Parameters
- **orderID** (string) - Required - Order ID
- **orderFilter** (string) - Optional - Order Filter ID

### Middleware
- consentTracking.consent
- server.middleware.https
- userLoggedIn.validateLoggedIn

### Category
sensitive
```

--------------------------------

### Base/Tile-Show()

Source: https://salesforcecommercecloud.github.io/b2c-dev-doc/docs/current/sfrajsdoc/js/server/Tile.html

Returns data for rendering a product tile. Accepts query string parameters for product ID, ratings, swatches, product view, quantity, and variant attributes.

```APIDOC
## Base/Tile-Show()

### Description
Returns data for rendering a product tile. Accepts query string parameters for product ID, ratings, swatches, product view, quantity, and variant attributes.

### Method
GET

### Endpoint
Base/Tile-Show

### Parameters
#### Query Parameters
- **pid** (string) - Required - The Product ID
- **ratings** (boolean) - Optional - Determines if the reviews should be shown in the tile
- **swatches** (boolean) - Optional - Determines if the swatches should be shown in the tile
- **pview** (string) - Optional - Determines if the product factory returns a model for a tile or a pdp/quickview display
- **quantity** (number) - Optional - Quantity
- **dwvar__color** (string) - Optional - Color Attribute ID
- **dwvar__size** (string) - Optional - Size Attribute ID

### Response
Renders an ISML template with the product tile data.

### Notes
- Uses middleware: cache.applyPromotionSensitiveCache
- Category: non-sensitive
- Server function: get
```

--------------------------------

### ReportingEvent Controller - Start and MiniCart endpoints

Source: https://salesforcecommercecloud.github.io/b2c-dev-doc/docs/current/sfrajsdoc/js/server/app_storefront_base_cartridge_controllers_ReportingEvent.js.html

The ReportingEvent controller defines two server.get endpoints. Start renders the reporting template, while MiniCart retrieves basket open reporting URLs using the reportingUrls helper and renders them. The controller exports its routes via server.exports().

```JavaScript
'use strict';

/**
 * @namespace ReportingEvent
 */

var server = require('server');

/**
 * ReportingEvent-Start : Controller that is the module hook for reporting events. Typically no modifications are needed here. Salesforce Commerce Cloud analytics is based on log file analysis. Log file entries are generated using remote includes in page templates. This endpoint's params change depeneding on what is being reported
 * @name Base/ReportingEvent-Start
 * @function
 * @memberof ReportingEvent
 * @param {category} - non-sensitive
 * @param {renders} - isml
 * @param {serverfunction} - get
 */
server.get('Start', function (req, res, next) {
    res.render('/reporting/reporting');
    next();
});

/**
 * ReportingEvent-MiniCart : The ReportingEvent-MiniCart endpoint get the reporting event basket open
 * @name Base/ReportingEvent-MiniCart
 * @function
 * @memberof ReportingEvent
 * @param {category} - non-sensitive
 * @param {renders} - isml
 * @param {serverfunction} - get
 */
server.get('MiniCart', function (req, res, next) {
    var BasketMgr = require('dw/order/BasketMgr');
    var currentBasket = BasketMgr.getCurrentOrNewBasket();
    var reportingUrlsHelper = require('*/cartridge/scripts/reportingUrls');
    var reportingURLs;
    if (currentBasket && currentBasket.allLineItems.length) {
        reportingURLs = reportingUrlsHelper.getBasketOpenReportingURLs(currentBasket);
    }

    res.render('/reporting/reportingUrls', {
        reportingURLs: reportingURLs
    });
    next();
});

module.exports = server.exports();
```

--------------------------------

### Base/Checkout-Begin()

Source: https://salesforcecommercecloud.github.io/b2c-dev-doc/docs/current/sfrajsdoc/js/server/Checkout.html

Renders the checkout shipping page for both guest and returning shoppers. This endpoint is accessed via a GET request and requires HTTPS, consent tracking, and CSRF token generation middleware.

```APIDOC
## Base/Checkout-Begin()

### Description
Renders the checkout shipping page for both guest and returning shoppers.

### Method
GET

### Endpoint
Base/Checkout-Begin

### Parameters
#### Middleware
- **middleware** (server.middleware.https) - Required - Enforces HTTPS.
- **middleware** (consentTracking.consent) - Required - Ensures consent tracking.
- **middleware** (csrfProtection.generateToken) - Required - Generates CSRF token.

#### Query Parameters
- **stage** (string) - Optional - A flag indicating the checkout stage.

### Category
sensitive

### Renders
isml

### Server Function
get
```

--------------------------------

### Initialize Bonus Product Features

Source: https://salesforcecommercecloud.github.io/b2c-dev-doc/docs/current/sfrajsdoc/js/client/cart_cart.js.html

Initializes various bonus product selection and modal interaction methods.

```javascript
base.selectAttribute();
    base.colorAttribute();
    base.removeBonusProduct();
    base.selectBonusProduct();
    base.enableBonusProductSelection();
    base.showMoreBonusProducts();
    base.addBonusProductsToCart();
    base.focusChooseBonusProductModal();
    base.trapChooseBonusProductModalFocus();
    base.onClosingChooseBonusProductModal();
};
```

--------------------------------

### getCookie(cookieName)

Source: https://salesforcecommercecloud.github.io/b2c-dev-doc/docs/current/sfrajsdoc/js/client/global.html

Gets a cookie value by cookie name from the browser.

```APIDOC
## getCookie(cookieName)

### Description
Gets a cookie value by cookie name from the browser.

### Parameters
- **cookieName** (string) - Required - Name of the cookie.

### Returns
- **string** - Cookie value of the found cookie name.
```

--------------------------------

### new ProductSuggestions(suggestions, maxItems)

Source: https://salesforcecommercecloud.github.io/b2c-dev-doc/docs/current/sfrajsdoc/js/server/ProductSuggestions.html

Constructs a new ProductSuggestions instance with the provided SuggestModel and maximum number of items to retrieve.

```APIDOC
## new ProductSuggestions(suggestions, maxItems)

### Description
Creates a new ProductSuggestions instance.

### Constructor
`new ProductSuggestions(suggestions, maxItems)`

### Parameters
- **suggestions** (dw.suggest.SuggestModel) - Required - The Suggest Model.
- **maxItems** (number) - Required - Maximum number of items to retrieve.

### Source
`app_storefront_base/cartridge/models/search/suggestions/product.js`, line 88
```

--------------------------------

### get function for search refinements

Source: https://salesforcecommercecloud.github.io/b2c-dev-doc/docs/current/sfrajsdoc/js/server/app_storefront_base_cartridge_scripts_factories_searchRefinements.js.html

Retrieves refinement values based on refinement type. Handles category refinements by returning only current category, direct children, and direct parent, or creates a product search refinement. For other refinements, maps over refinement values using the model. Exports the get function.

```javascript
function get(productSearch, refinementDefinition, refinementValues) {
    var Model = getAttributeRefinementValueModel(refinementDefinition);

    if (refinementDefinition.categoryRefinement) {
        if (productSearch.categorySearch) {
            // return only current category, direct children and direct parent
            return createCategorySearchRefinement(productSearch, refinementDefinition, Model);
        }
        return createProductSearchRefinement(
            productSearch,
            refinementDefinition,
            refinementValues,
            Model);
    }

    return collections.map(refinementValues, function (value) {
        return new Model(productSearch, refinementDefinition, value);
    });
}

module.exports = {
    get: get
};
```

--------------------------------

### Account EditProfile - Get Endpoint

Source: https://salesforcecommercecloud.github.io/b2c-dev-doc/docs/current/sfrajsdoc/js/server/app_storefront_base_cartridge_controllers_Account.js.html

Defines the GET endpoint for editing a shopper's profile. It uses middleware for HTTPS, CSRF protection, user login validation, and consent tracking. It retrieves the account model and profile form, clears the form, and sets the first name from the account model.

```javascript
server.get(
    'EditProfile',
    server.middleware.https,
    csrfProtection.generateToken,
    userLoggedIn.validateLoggedIn,
    consentTracking.consent,
    function (req, res, next) {
        var Resource = require('dw/web/Resource');
        var URLUtils = require('dw/web/URLUtils');
        var accountHelpers = require('*/cartridge/scripts/account/accountHelpers');

        var accountModel = accountHelpers.getAccountModel(req);
        var profileForm = server.forms.getForm('profile');
        profileForm.clear();
        profileForm.customer.firstname.value = accountModel.profile.firstName;
```

--------------------------------

### new account(currentCustomer, addressModel, orderModel)

Source: https://salesforcecommercecloud.github.io/b2c-dev-doc/docs/current/sfrajsdoc/js/server/account_.html

Constructor for the account class. It initializes an account instance representing the current customer's profile dashboard, using the provided customer, address, and order data.

```APIDOC
## new account(currentCustomer, addressModel, orderModel)

### Description
Account class that represents the current customer's profile dashboard.

### Constructor
new account(currentCustomer, addressModel, orderModel)

### Parameters
- **currentCustomer** (Object) - Required - Current customer
- **addressModel** (Object) - Required - The current customer's preferred address
- **orderModel** (Object) - Required - The current customer's order history

### Source
app_storefront_base/cartridge/models/account.js, line 117
```

--------------------------------

### findValue(formGroup, name) → {Object}

Source: https://salesforcecommercecloud.github.io/b2c-dev-doc/docs/current/sfrajsdoc/js/server/global.html

Get values of a formGroup to object

```APIDOC
## findValue(formGroup, name) → {Object}

### Description
Get values of a formGroup to object

### Parameters
- **formGroup** (dw.web.FormGroup) - Required - Form group
- **name** (string) - Required - The name of the formGroup

### Returns
- **Object** - Object with nested values

### Source
- modules/server/forms/forms.js, line 63
```

--------------------------------

### Handle Billing Address and Basket Model Initialization

Source: https://salesforcecommercecloud.github.io/b2c-dev-doc/docs/current/sfrajsdoc/js/server/app_storefront_base_cartridge_controllers_CheckoutShippingServices.js.html

This snippet demonstrates copying the billing address to the basket, managing multi-shipping state, recalculating the basket, and initializing the order model for the JSON response.

```javascript
if (req.currentCustomer.addressBook
    && req.currentCustomer.addressBook.preferredAddress) {
    // Copy over preferredAddress (use addressUUID for matching)
    COHelpers.copyBillingAddressToBasket(
        req.currentCustomer.addressBook.preferredAddress, currentBasket);
} else {
    // Copy over first shipping address (use shipmentUUID for matching)
    COHelpers.copyBillingAddressToBasket(
        currentBasket.defaultShipment.shippingAddress, currentBasket);
}
}
var usingMultiShipping = req.session.privacyCache.get('usingMultiShipping');
if (usingMultiShipping === true && currentBasket.shipments.length < 2) {
    req.session.privacyCache.set('usingMultiShipping', false);
    usingMultiShipping = false;
}

COHelpers.recalculateBasket(currentBasket);

var currentLocale = Locale.getLocale(req.locale.id);
var basketModel = new OrderModel(
    currentBasket,
    {
        usingMultiShipping: usingMultiShipping,
        shippable: true,
        countryCode: currentLocale.country,
        containerView: 'basket'
    }
);

res.json({
    customer: new AccountModel(req.currentCustomer),
    order: basketModel,
    form: server.forms.getForm('shipping')
});
});
}

return next();
}
);
```

--------------------------------

### Base/Login-Logout()

Source: https://salesforcecommercecloud.github.io/b2c-dev-doc/docs/current/sfrajsdoc/js/server/Login.html

This endpoint is called to log the shopper out of the session. It is a sensitive GET operation.

```APIDOC
## Base/Login-Logout()

### Description
This endpoint is called to log the shopper out of the session.

### Method
GET

### Endpoint
Base/Login-Logout

### Parameters
#### Category
- **category** (string) - sensitive

### Server Function
- **serverfunction** (string) - get

```

--------------------------------

### EinsteinCarousel-Load endpoint implementation

Source: https://salesforcecommercecloud.github.io/b2c-dev-doc/docs/current/sfrajsdoc/js/server/app_storefront_base_cartridge_controllers_EinsteinCarousel.js.html

Defines the server.get('Load') endpoint that parses query parameters, iterates over components, and renders product tiles using the product factory and templates. It limits the number of rendered recommendations and sets an 'active' class on the first successful rendering.

```javascript
'use strict';

/**
 * @namespace EinsteinCarousel
 */

var server = require('server');
var Template = require('dw/util/Template');
var ProductMgr = require('dw/catalog/ProductMgr');
var HashMap = require('dw/util/HashMap');

/**
 * EinsteinCarousel-Load : This endpoint is used to populate the model with information needed to display a carousel with product tiles based on einstein recommendations
 * @name Base/EinsteinCarousel-Load
 * @function
 * @memberof EinsteinCarousel
 * @param {querystringparameter} - limit - a number representing the max number of recommendations that are being request for displaying in the carousel
 * @param {querystringparameter} - components - an array of objects that represent attributes configured in the BM for this page designer component
 * @param {category} - non-sensitive
 * @param {serverfunction} - get
 */
server.get('Load', function (req) {
    var newFactory = require('*/cartridge/scripts/factories/product');
    var URLUtils = require('dw/web/URLUtils');
    var components = (JSON.parse(req.querystring.components));
    var limit = parseInt(req.querystring.limit, 10);
    var successfulrenderings = 0;
    components.forEach(function (component) {
        if (limit <= successfulrenderings) {
            return;
        }
        var model = new HashMap();
        model.index = successfulrenderings;

        if (component.model.type === 'product') {
            var product = ProductMgr.getProduct(component.model.id);
            if (!product || !product.online) {
                return;
            }

            model.product = newFactory.get({ pid: component.model.id, pview: 'tile' });
            model.urls = {
                product: URLUtils.url('Product-Show', 'pid', component.model.id).relative().toString()
            };
            model.display = {
                swatches: component.swatches,
                ratings: component.displayratings,
                xs: component.classxs,
                sm: component.classsm,
                md: component.classmd
            };

            if (successfulrenderings === 0) {
                model.additionalClass = 'active';
            }
        }

        var template = new Template('experience/components/' + component.template);
        var renderedTemplate = template.render(model);
        response.writer.print(renderedTemplate.text); // eslint-disable-line no-undef
        successfulrenderings++;
    });
});

module.exports = server.exports();
```

--------------------------------

### setupContentSearch function in searchHelpers.js

Source: https://salesforcecommercecloud.github.io/b2c-dev-doc/docs/current/sfrajsdoc/js/server/app_storefront_base_cartridge_scripts_helpers_searchHelpers.js.html

Configures a content search model with recursive folder search, no folder filter, and the provided query. Returns a ContentSearch model instance.

```javascript
function setupContentSearch(params) {
    var ContentSearchModel = require('dw/content/ContentSearchModel');
    var ContentSearch = require('*/cartridge/models/search/contentSearch');
    var apiContentSearchModel = new ContentSearchModel();

    apiContentSearchModel.setRecursiveFolderSearch(true);
    apiContentSearchModel.setFilteredByFolder(false);
    apiContentSearchModel.setSearchPhrase(params.q);
    apiContentSearchModel.search();
    var contentSearchResult = apiContentSearchModel.getContent();
    var count = Number(apiContentSearchModel.getCount());
    var contentSearch = new ContentSearch(contentSearchResult, count, params.q, params.startingPage, null);

    return contentSearch;
}
```

--------------------------------

### GET Login-Logout

Source: https://salesforcecommercecloud.github.io/b2c-dev-doc/docs/current/sfrajsdoc/js/server/app_storefront_base_cartridge_controllers_Login.js.html

Logs the shopper out of the current session and redirects to the home page.

```APIDOC
## GET Login-Logout

### Description
This endpoint is called to log shopper out of the session. It logs out the customer and redirects to the home page.

### Method
GET

### Endpoint
Login-Logout

### Response
Redirects to Home-Show.

### Category
sensitive
```

--------------------------------

### new ProductSearch(productSearch, httpParams, sortingRule, sortingOptions, rootCategory)

Source: https://salesforcecommercecloud.github.io/b2c-dev-doc/docs/current/sfrajsdoc/js/server/ProductSearch.html

Creates a new ProductSearch instance. It initializes the search model with the provided product search object, HTTP query parameters, sorting rule, sorting options, and root category.

```APIDOC
## new ProductSearch(productSearch, httpParams, sortingRule, sortingOptions, rootCategory)

### Description
Creates a new ProductSearch instance. It initializes the search model with the provided product search object, HTTP query parameters, sorting rule, sorting options, and root category.

### Constructor
`new ProductSearch(productSearch, httpParams, sortingRule, sortingOptions, rootCategory)`

### Parameters
- **productSearch** (dw.catalog.ProductSearchModel) - Required - Product search object
- **httpParams** (Object) - Required - HTTP query parameters
- **sortingRule** (string) - Required - Sorting option rule ID
- **sortingOptions** (dw.util.ArrayList.<dw.catalog.SortingOption>) - Required - Options to sort search results
- **rootCategory** (dw.catalog.Category) - Required - Search result's root category if applicable

### Source
`app_storefront_base/cartridge/models/search/productSearch.js, line 184`
```

--------------------------------

### Ensure Valid Shipments

Source: https://salesforcecommercecloud.github.io/b2c-dev-doc/docs/current/sfrajsdoc/js/server/app_storefront_base_cartridge_scripts_checkout_checkoutHelpers.js.html

Starts the validation process for all shipments in a line item container.

```javascript
function ensureValidShipments(lineItemContainer) {
    var shipments = lineItemContainer.shipments;
```
Tokens:
Raw