Documentation Portal

The function helper that applies the promotion to the search result is defined here: "int_globale/cartridge/scripts/helpers/globaleHelpers.js"

/**
 * Apply searchable products promotion
 * @param {dw.catalog.SearchModel} apiProductSearch - SearchModel
 * @param {boolean} isExecuteSearch - allow/prevent executing 'search' method of 'dw.catalog.SearchModel' class
 * @returns {dw.catalog.SearchModel} SearchModel
 */
function applySearchableProductsPromotion(apiProductSearch, isExecuteSearch) {
    /**
     * It is possible to exclude Restricted or Forbidden products from search results
     * In the example below, the exclusion will be done by using the Promotion ID,
     * for example SearchableProducts_AU - will be applied only for Australia,
     * where all Restricted or Forbidden products will be added in 'Qualifying Products' => 'Excluding products',
     * so the promotion will have qualifying products but won't have any discounted products,
     * thus we can filter the search results but the promotional callout message won't be displayed on storefront.
     */
    var globaleSession = require('*/cartridge/models/globale/session');
    if (!globaleSession.get('geOperatedCountry')) {
        return apiProductSearch;
    }
    var searchableProductsPromotionId = getPreference(preferenceKeys.geSearchableProductsPromotionId);
    var searchableProductsPromotion;
    if (searchableProductsPromotionId) {
        var PromotionMgr = require('dw/campaign/PromotionMgr');
        var collections = require('*/cartridge/scripts/util/globale/collections');
        searchableProductsPromotionId = searchableProductsPromotionId
            .replace(/\{country\}/ig, globaleSession.get('geCountry'))
            .replace(/\{currency\}/ig, globaleSession.get('geCurrency'))
        ;
        var applicablePromotions = PromotionMgr.getActiveCustomerPromotions().getProductPromotions();
        if (applicablePromotions && applicablePromotions.length > 0) {
            searchableProductsPromotion = collections.find(applicablePromotions, function (promotion) { return (promotion.ID === searchableProductsPromotionId); });
        }
        if (searchableProductsPromotion) {
            var ProductSearchModel = require('dw/catalog/ProductSearchModel');
            apiProductSearch.setPromotionID(searchableProductsPromotion.ID);
            apiProductSearch.setPromotionProductType(ProductSearchModel.PROMOTION_PRODUCT_TYPE_QUALIFYING);
            if (isExecuteSearch) {
            	apiProductSearch.search();
            }
        }
    }    
    return apiProductSearch;
}

In SFRA architecture the search result is modified here: int_globale_sfra/cartridge/scripts/helpers/searchHelpers.js

searchHelpers

setupSearch: {
    value: function () {
        var globaleHelpers = require('*/cartridge/scripts/helpers/globaleHelpers');
        var apiProductSearch = this.super.setupSearch.apply(this.super, Array.prototype.slice.call(arguments));
        // apply searchable products promotion
        apiProductSearch = globaleHelpers.applySearchableProductsPromotion(apiProductSearch);
        return apiProductSearch;
    }
}

In SiteGenesis architecture the search result is modified here: int_globale_sitegenesis/cartridge/scripts/models/SearchModel.js

initializeProductSearchModel: {
    value: function () {
        var globaleHelpers = require('*/cartridge/scripts/helpers/globaleHelpers');
        var apiProductSearch = this.super.initializeProductSearchModel.apply(this.super, Array.prototype.slice.call(arguments));
        // apply searchable products promotion
        apiProductSearch = globaleHelpers.applySearchableProductsPromotion(apiProductSearch);

        return apiProductSearch;
    }
}

This is how the Site Preference in GLOBALE preference group can be configured:

The Promotion in the example below is configured for Australia only (with using Customer Groups), so the restricted/forbidden products will be excluded from Search result for Australia only.

Note: You can also configure one promotion for more than one Global-e operated country by using the Customer Group in Campaign

Note that Salesforce B2C Commerce ignores the campaign configuration for Promotions used in ProductSearchModel.setPromotionID(), but we would like to use Campaign and assigned Customer Groups to be able to filter the restricted/forbidden products only for Global‑e operated countries (in this example - Australia). Therefore, we will assign this Promotion to one of the existing Global‑e Campaign and Australian Customer Group.

If the promotion ID contains the placeholders in the code below, you do not need to configure a dynamic customer group and apply it to the campaign

searchableProductsPromotionId = searchableProductsPromotionId
    .replace(/\{country\}/ig, globaleSession.get('geCountry'))
    .replace(/\{currency\}/ig, globaleSession.get('geCurrency'))

If the promotion ID does not contain placeholders, then you do need to apply a dynamic group in the campaign configuration.

In SFRA architecture it can be implemented in the "Product" controller with the next piece of the code.

Redirect to Home Page for Restricted and/or Forbidden products

/**
 * Global-e Product Show
 *
 * Merchant Customization: Add custom code to this route if you need custom behavior for
 * Restricted or Forbidden product on PDP page. For example, you could redirect international
 * customers to home page if they click on a restricted or forbidden product as shown in
 * the example below.
 * @example
 * var URLUtils = require('dw/web/URLUtils');
 * var ProductMgr = require('dw/catalog/ProductMgr');
 * var globaleSession = require('{@literal *}/cartridge/models/globale/session');
 * var globaleHelpers = require('{@literal *}/cartridge/scripts/helpers/globaleHelpers');
 * var apiProduct = ProductMgr.getProduct(req.querystring.pid);
 * // Restricted and Forbidden Products
 * var geRestrictionForbiddenMessage = globaleHelpers.getProductRestrictionMessage(apiProduct, globaleSession.get('geCountry'));
 * // Restricted Products only
 * var geRestrictionMessage = globaleHelpers.getProductRestrictionMessage(apiProduct, globaleSession.get('geCountry'), true);
 * // Forbidden Products only
 * var geForbiddenMessage = globaleHelpers.getProductRestrictionMessage(apiProduct, globaleSession.get('geCountry'), false, true);
 * if (geRestrictionForbiddenMessage) {
 *      res.redirect(URLUtils.url('Home-Show')); // redirect to home page
 *      next();
 * }
 */

In SiteGenesis architecture it can be implemented in the "Product" controller/pipeline with the next piece of the code.

Redirect to Home Page for Restricted and/or Forbidden products

/**
 * Global-e Product Show
 *
 * Merchant Customization: Add custom code to this route if you need custom behavior for
 * Restricted or Forbidden product on PDP page. For example, you could redirect international
 * customers to home page if they click on a restricted or forbidden product as shown in
 * the example below.
 * @example
 * var URLUtils = require('dw/web/URLUtils');
 * var ProductMgr = require('dw/catalog/ProductMgr');
 * var globaleSession = require('{@literal *}/cartridge/models/globale/session');
 * var globaleHelpers = require('{@literal *}/cartridge/scripts/helpers/globaleHelpers');
 * var apiProduct = ProductMgr.getProduct(params.pid.stringValue);
 * // Restricted and Forbidden Products
 * var geRestrictionForbiddenMessage = globaleHelpers.getProductRestrictionMessage(apiProduct, globaleSession.get('geCountry'));
 * // Restricted Products only
 * var geRestrictionMessage = globaleHelpers.getProductRestrictionMessage(apiProduct, globaleSession.get('geCountry'), true);
 * // Forbidden Products only
 * var geForbiddenMessage = globaleHelpers.getProductRestrictionMessage(apiProduct, globaleSession.get('geCountry'), false, true);
 * if (geRestrictionForbiddenMessage) {
 *      response.redirect(URLUtils.https('Home-Show')); // redirect to home page
 * }
 */

To hide the restricted/forbidden products from the Einstein Product Recommendations - adjust the templates which renders the Einstein Product Recommendations, according to the instruction provided in SFCC documentation.

A sample is below:

Hide Global‑e Restricted/Forbidden Products from Einstein Product Recommendations

<iscontent type="text/html" charset="UTF-8" compact="true"/>
<iscomment> should not be cached, the tiles are cached individually.</iscomment>
<isset name="globaleHelpers" value="${require('*/cartridge/scripts/helpers/globaleHelpers')}" scope="page" />
<isset name="globaleSession" value="${require('*/cartridge/models/globale/session')}" scope="page"/>
<isif condition="${slotcontent}">
    <div class="product-listing product-listing-1x4">
        <h2>${slotcontent.calloutMsg}</h2>
        <ul class="search-result-items tiles-container">
            <isloop items="${slotcontent.content}" var="product" begin="0" end="3">
                <isobject object="${product}" view="recommendation">
                    <isif condition="${globaleHelpers.getProductRestrictionMessage(product, globaleSession.get('geCountry'))}"><iscontinue/></isif>
                    <li class="grid-tile">
                        <isinclude url="${URLUtils.url('Product-HitTile',
                            'pid', product.ID,
                            'showswatches', 'true',
                            'showpricing', 'true',
                            'showpromotion', 'true',
                            'showrating', 'true')}"/>
                    </li>
                </isobject>
            </isloop>
        </ul>
    </div>
</isif>