Documentation Portal

GlobalE.SetMerchantParameters({client_settings}); // JSON object

GlobalE.ScriptsURL("Global‑e_client_js_sdk_hostname"); // for ex. https://www2.bglobale.com

GlobalE.SetCookieDomain("site_cookie_domain"); // for ex. www.site.com

More details about Global‑e Client JS SDK, available commands and functions are in Global‑e Client SDK online document.

Standard Global‑e welcome pop-up can be initialized by executing the JavaScript function:

GlobalE.LoadWelcome("US", "en-US", "USD");

Standard Global‑e Country Switcher can be initialized by executing the JavaScript function:

Global‑e Checkout is loading in an iframe within standard SFCC container (by default int_globale_{architecture}/cartridge/templates/default/globale/checkout/iframe.isml):

The installation of the Global‑e Salesforce B2C Commerce cartridge(s) should be as simple as just upload Global‑e cartridges, adding them to the cartridge path of the Site, import metadata, set the configuration in Organization and Site Preferences and run GlobaleSettings Job.

Administration > Sites > Manage Sites > (Your Site) > [Settings Tab]

Please add Global‑e cartridges as shown on the following screenshots.

SiteGenesis Pipelines or Controllers. Please add two Global‑e cartridges before your brand cartridges (from left to right) - int_globale_sitegenesis_popups and int_globale, as shown on the screenshot:

SFRA. Please add two Global‑e cartridges before app_storefront_base cartridge and after your brand cartridges (from left to right) - int_globale_sfra_popups and int_globale, as shown on the screenshot:

The details of import metadata are described in the Global‑e integration guide document.

The Site URL on the Global-e side for each operated or non-operated country (present in the Country Switcher) can be empty, set as a string (static URL), or set as a special format, which should be used on the SFCC side for generating the real static URL.

Here are the parameters of the special Site URL format:

For example, the following Site URL (configured on the Global‑e side for selected Country) "Home-Show|RefArch|en_US|demo.merchant.com|source=12345678" will be parsed and generated to the "https://demo.merchant.com/s/SiteGenesis/home?source=12345678" final Site redirect URL.

The list of all currencies supported by Global‑e can be obtained from GLOBALE_CURRENCIES Custom Object. Each Global‑e Currency:

Once the Country and/or Currency is selected in your custom Country Switcher, you must save it properly to a Global-e Cookie.

Use the snippet below to save the selected Country/Currency to a Global-e Cookie and reload the page:

GlobalE.UpdateCustomerInfo(countryISO2, currencyISO3, redirect);

Find more information and samples here.

Global‑e Cartridge int_globale has a scheduled job - GlobaleSettings, which is part of the cartridge and ready to use out-of-the-box.

One of the step of this job is CountryCoefficients, this step is pulling the data about coefficients (/Browsing/CountryCoefficients) and store it either into GLOBALE_COUNTRY_COEFFICIENTS or GLOBALE_PRODUCT_CLASS_COEFFICIENTS Custom Object, depends on type of the Coefficient.

If ProductClassCode is provided then the Coefficient Rate will be applied for products of the specified Product Class / Category, Country Coefficient Rate will be ignored.

You need to specify (in Global-e Site Preferences GLOBALE-PRODUCT) the attribute (system or custom, both supported) of the system object Product which will be storing the ID/name of Product Class / Category, which should be used when the end-customer price is calculated.

The value can be simple ID of the product attribute (like "brand"), in this case Global-e cartridge will try to find that attribute as system attribute "brand" of the product.

Custom attributes are also supported

To set a customer attribute set the attribute as "custom.any_custom_attribute" and the Global-e cartridge will try to find that attribute as custom attribute "any_custom_attribute" of the product ("any_custom_attribute" should be replaced by the ID of your custom attribute).

Once the Product Class Code Property ID/Name has been found, Global‑e cartridge will go to GLOBALE_PRODUCT_CLASS_COEFFICIENTS Custom Object and try to find the record of Coefficient Rate configured to the specified Product Class / Category and Shipping Country:

If "ProductClassCode" is empty (not provided) then the Country Coefficient Rate will be applied. Global-e cartridge will go to GLOBALE_COUNTRY_COEFFICIENTS Custom Object and try to find the record of Coefficient Rate configured to the specified Shipping Country.

If "Is applicable to Global‑e" is set to "None", this custom attribute will not be applicable.  This custom attribute represents all Discount Types currently supported by Global‑e. It should be set to the same value under the SFCC "Promotion Rule" section.

If this is enabled, the promotion discount value is used as is, which is calculated by SFCC logic in the native currency. For example, check this box if you would like the promotion to give a discount of 10 currency value regardless of the currency the customers use (e.g. $10, €10, or £10). This is only applicable for AMOUNT, FIXED_PRICE, PRICE_BOOK_PRICE or TOTAL_FIXED_PRICE discount types.

Exclusivity is totally up to you.

All settings of the Promotion are optional (following the standard SFCC Rules), so you can configure it according to your requirements, except only the following:

All settings of the Campaign are optional, so you can configure it according to your requirements, based on standard SFCC instructions.

Once the Promotion and Campaign become applicable (either due to Customer Group, Source Code or Coupon Code entered on a Cart page), the Customer should be able to see Free shipping option on Global‑e Checkout:

You currently run 10% off all men’s gloves promotion for your domestic customers. Your current promotion is configured as shown below.

You want to extend this promotion to all international customers as well. To extend this promotion to an international customer, in the same Promotion, go to the “Global-e Settings” section and add the following.

Make sure the Customer Group for your Campaign includes international customers. It could be “Everyone” customer group, or any other specific customer group you setup that you’d like to qualify for the promotion. For example, if you would like only customers from Canada to receive this discount in addition to your domestic customers, you could configure a specific customer group for them and add it here.

On the storefront, the promotion is now applicable to both domestic and Global‑e operated countries.

You currently run a “10$ Off All Earrings” promotion for your domestic customers. Your current promotion is configured as shown below.

You want to extend this promotion to customers in your focus countries which include Canada, Spain, and Italy. And instead of giving them 10 USD off, you want to give the customer the discount equivalent to 10 of the customer currency. To do that, the following updates are made to the promotion. Note the “Do Not Convert Promotional Discount” is checked.

A new customer group is created to include Canada, Spain and Italy.

Then update the associated Campaign to include this customer group.

On the storefront, the promotion is now applicable for domestic customers, and customers from Canada, Spain and Italy. Note that the discount amount is in customer currency.

You currently run a “Buy Cluster Drop Necklace, Get Free Matching Earrings” promotion for your domestic customers. Your current promotion is configured as shown below.

You want to extend this promotion to all international customers as well. To extend this promotion to an international customer, in the same Promotion, go to the “Global-e Settings” section and add the following.

Make sure the Customer Group for your Campaign includes international customers. It could be “Everyone” customer group, or any other specific customer group you setup that you’d like to qualify for the promotion. For example, if you would like only customers from Canada to receive this discount in addition to your domestic customers, you could configure a specific customer group for them and add it here.

On the storefront, when a customer adds the Cluster Drop Necklace to their basket, the Cluster Drop Earrings are added as a bonus for all domestic customers and customers from GE operated countries.

You currently run a $50 off when buying 5 or more items promotion for your domestic customers. You want to extend this promotion to all international customers as well. Your current promotion is configured as shown below.

To extend this promotion to an international customer, in the same Promotion, go to the “Global-e Settings” section and add the following.

Make sure the Customer Group for your Campaign includes international customers. It could be “Everyone” customer group, or any other specific customer group you setup that you’d like to qualify for the promotion. For example, if you would like only customers from Canada to receive this discount in addition to your domestic customers, you could configure a specific customer group for them and add it here.

On the storefront, the promotion is now applicable to both domestic and Global‑e operated countries.

Since “Do not Convert Promotional Discount” is unchecked, the $50 discount is automatically converted to customer’s currency.

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

Please 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), so 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 doesn't contain placeholders then for promotion should be applied dynamic group(it should be done in a configuration of the campaign).

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>

To integrate third party API calls in Global-e code please check the custom hook handler cartridges\int_globale\cartridge\scripts\globale\hooks\onGlobaleValidateCart.js.

/**
 * Handler function of 'GlobalE.OnCheckoutStepLoadedHandler' event
 * @param {Object} data - Event data
 */
GeScriptLoader.prototype.onCheckoutStepLoadedHandler = function (data) {
    try {
        if (data.StepId === data.Steps.CONFIRMATION) {
            // stop sending keepAlive ajax call
            if (('globaleKeepAlive' in window) && window.globaleKeepAlive) {
                clearInterval(window.globaleKeepAlive);
            }
        }

        /**
         * If you need to implement the frontend analytics please put it here
         */

        /**
         * Only for Backend Analytics, like standard SFCC Merchant Tools / Analytics / Purchase Reports.
         * Should be handled in Globale-Analytics controller
         */
        var geIframe = document.querySelector('#gle_iframe');
        Helpers.makeJsonAjaxCall(geIframe.dataset.analyticsUrl, 'POST', JSON.stringify(data))
            .then(function (response) { // eslint-disable-line no-unused-vars
                // handle response
            })
            .catch(function (e) {
                console.warn(e); // eslint-disable-line no-console
            });
    } catch (e) {
        console.warn(e); // eslint-disable-line no-console
    }
};
       

Sample:

var globalePrice = require('*/cartridge/scripts/factories/globale/price');
var gePrice = globalePrice(11.12, 12345678);

Path to the file (relatively to int_globale/cartridge/scripts/factories/globale/ folder): money.js

Parameters:

Sample:

var globaleMoney = require('*/cartridge/scripts/factories/globale/money');
var geMoney = globaleMoney(11.12, 'USD');

Path to the file (relatively to int_globale/cartridge/scripts/factories/globale/ folder): optionModel.js

Parameters:

Sample:

var globaleOptionModel = require('*/cartridge/scripts/factories/globale/optionModel');
var geOptionModel = globaleOptionModel(product.optionModel);

Path to the file (relatively to int_globale/cartridge/scripts/factories/globale/ folder): priceModel.js

Parameters:

Sample:

var globalePriceModel = require('*/cartridge/scripts/factories/globale/priceModel');
var gePriceModel = globalePriceModel(product.priceModel, product);

<isset name="globaleSession" value="${require('*/cartridge/models/globale/session')}" scope="page"/>
<isif condition="${!globaleSession.get('geOperatedCountry')}">
    <div class="col-12">
        ...
    </div>
</isif>

<isset name="globaleSession" value="${require('*/cartridge/models/globale/session')}" scope="page"/>

/**
 * Calculates and returns Global-e Product.MetaData API
 * @returns {Object|null} - Global-e Product.MetaData API
 */
function getMetadata() {
    var metadata = {};
    var attributes = [];

    // For backordered products
    if (this.apiProduct.availabilityModel.availabilityStatus === dw.catalog.ProductAvailabilityModel.AVAILABILITY_STATUS_BACKORDER) {
        var StringUtils = require('dw/util/StringUtils');
        var Resource = require('dw/web/Resource');
        var backOrderAttribute = {};
        var backOrderedMsg = StringUtils.format(Resource.msg('global.allbackorder', 'locale', null));

        if (this.apiProduct.availabilityModel.inventoryRecord != null &&
            this.apiProduct.availabilityModel.inventoryRecord.inStockDate != null &&
            this.apiProduct.availabilityModel.inventoryRecord.inStockDate > new Date()
        ) {
            backOrderedMsg += StringUtils.format(
                Resource.msg('global.inStockDate', 'locale', null),
                this.apiProduct.availabilityModel.inventoryRecord.inStockDate.toDateString()
            );
        }
        backOrderAttribute.AttributeKey = 'Backordered';
        backOrderAttribute.AttributeValue = backOrderedMsg;
        attributes.push(backOrderAttribute);
    }

    if (attributes.length > 0) {
        metadata.Attributes = attributes;
    }
    return metadata;
}

<div id="GlobaleFreeShippingBannerContainer"> </div>

Unfortunately you won't be able to use our cartridges for SFRA Storefront Architecture if the Compatibility Mode of your SFCC Digital is older that 17.7.

If you are unable to upgrade the Compatibility Mode of your Salesforce B2C Commerce Digital to 17.7, use the following workaround that will allow Global-e cartridges to work with your Compatibility Mode version.

Note that if you are making any changes in the main Global-e SFCC cartridge int_globale - you won't be able to apply our updates easily, you will always have to thoroughly check the differences manually.

We strongly recommend that you do not change any files in the int_globale cartridge but copy any original files from the main cartridge int_globale into your *_ext cartridge and make any required changes there. The screenshots below are from the UI of Eclipse.