Storefront Routes

​

JavaScript File Structure

module.exports = function(context, callback) {
    // Your custom code here
    callback();
};

​

Context: HTTP

• request
• response
• items.siteContext
• items.pageContext
• items.navigation

• exec.loginUser
• exec.logOut

• request.get
• response.get
• response.set
• response.set
• response.remove
• response.redirect
• response.end
• get.resource
• get.resourceStatus
• items.urlHelper.getUrl

• apiContext
• configuration

​

Context Objects Available to All HTTP Actions

​

request

context.request.url;

​

response

context.response.header;

​

items.siteContext

• websiteName (string)—Name of the site as configured in the Admin general settings.
• timeZone (string)—The site time zone as configured in general settings in admin. Stored as human-readable string, e.g. “Mountain Standard Time”.
• allowInvalidAddresses (Boolean)—TRUE if address validation is enabled and invalid addresses are allowed, as configured in the Admin general settings.
• googleAnalyticsEcomEnabled (Boolean)—TRUE if Google Analytics is enabled and Google Analytics eCom tracking parameters are also enabled. In the Core theme and Core-derived themes, this results in a set of extra calls to the Google Analytics tracking beacon on the Order Confirmation page.
• googleAnalyticsEnabled (Boolean)—TRUE if Google Analytics is enabled. In the Core theme and Core-derived themes this results in a call to the Google Analytics tracking beacon on every page.
• googleAnalyticsId (string)—The UA number provided by the Google Analytics account as configured by the site.
• isAddressValidationEnabled (Boolean)—TRUE if address validation is enabled as configured in the Admin general settings.

• payByMail (Boolean)—TRUE if pay-by-mail is enabled in the Admin checkout settings.
• isPayPalEnabled (Boolean)—TRUE if PayPal Express is enabled in Admin checkout settings.
• supportedCards (Dictionary<string, string>)—List of credit cards enabled in the Admin checkout settings.

• domainName (string)—the name of the domain.
• isPrimary (Boolean)—TRUE if the given domain is the primary one.

• EnglishName (string)—the currency name.
• symbol (string)—the currency symbol.
• precision (integer)—the number of digits to display after the period.
• roundingType (string)—the rounding type value: “UpToCurrencyPrecision”, “NearestNickel”, “DownToNearestNickel”, “DownToCurrencyPrecisionMinusOne”, or “NearestHalfUnit”.
• currencyCode (string)—for example, “USD” for U.S. dollars. Other values include: “EGP”, “GBP”, “TZS”, “UYU”, “UZS”, “WST”, “YER”, “ZMK”, “TWD”, “GHS”, “VEF”, “SDG”, “RSD”, “MZN”, and “AZN”.

context.items.siteContext.siteId;

​

items.pageContext

• path (string)—name or ID of the CMS document.
• documentTypeFQN (string)—the documentType such as “web_page”.
• document (pointer)—a pointer to the CMS document.

• pageSize (int)—the maximum number of items to return in the collection.
• query (string)—A filter expression for Kibo eCommerce collections. You can filter products based on their properties by writing a string expression as your argument. For example: properties.firstname eq "Brenda".
• sortBy (string)—A string representing how to sort the collection. You can sort on any property, date (such as createDate), or document name. After specifying the name of the property you are sorting on, include a space followed by “asc” or “desc” to specify sorting in ascending or descending order.
• categoryId (int)—the category to facet products for.
• A keyed collection of facets to filter on.

• isAuthenticated (Boolean)—TRUE if the user is logged in.
• userId (string)—the unique identifier for the user.
• firstName (string)—the user’s first name.
• lastName (string)—the user’s last name.
• email (string)—the user’s email address.
• isAnonymous (Boolean)—TRUE if the user is not logged in.
• accountId (int)—the unique identifier of the user’s account.

context.items.pageContext.categoryCode;

​

items.navigation

• name (string)—the name of the node.
• url (string)—the URL to which the node links.
• index (int)—the unique identifier for the node.
• isHidden (Boolean)—TRUE if the node does not display in the site’s navigation bar.
• parent (NavigationNode)—the parent of the current node.
• items (list of NavigationNode)—the children of the current node.

context.items.navigation.breadcrumbs;

​

Context Methods Available to All Storefront Actions

​

exec.loginUser

• userId (string)—The 32-character alphanumeric ID of the user to authenticate.
• userName (string)—The username of the user to authenticate (this field is not required if you provide a userId).
• rememberUser (Boolean)—Specifies whether the authentication cookie should be persistent.

• err An error object if the user is not found.
• data The authentication ticket for the user.

var config = {
   rememberUser:true,
   userId: '48577d74a86044bfb2872a4c184ce33c'
};

context.exec.loginUser(config, function (err, result){
//handle the possible error and call the callback
//if successful the result should be the customer auth ticket.
   if (err){
   //bubble up error to the platform
      callback (err);
      return;
   }

//return control flow to the platform
callback();
});

​

exec.logOut

context.exec.logOut();

​

Context Methods Available to All HTTP Actions

​

request.get

context.request.get(field);

"object"

​

response.get

context.response.get(field);

"string"

​

response.set

context.response.set({ myCustomHeader: "howdy" });

​

response.set2

context.response.set("name", "stuff");

​

response.remove

context.response.remove(header);

​

response.redirect

context.response.redirect("http://someOtherSite/foo");

​

response.end

context.response.end();

​

get.resource

context.get.resource();

​

get.resourceStatus

context.get.resourceStatus();

​

items.urlHelper.getUrl

context.items.urlHelper.getUrl(type, object, config);

​

Context Objects Available to All Actions

​

apiContext

context.apiContext.baseUrl;

​

configuration

context.configuration.customData;