Arc.js Reference

Arc.js is a development framework that allows developers to execute custom code whenever certain actions occur in Kibo eCommerce. To learn the basics of Arc.js, refer to:

Reference Help

Domains | Software Requirements | Tools

The Arc.js reference help is organized first by domains, and then by the actions each domain contains. This structure mirrors how the Yeoman scaffolding tool organizes a project folder on your local machine. Each domain is a folder that contains actions, and each action is a JavaScript file in which you can insert your custom code. Each action has access to specific methods that can get or update Kibo eCommerce objects. To learn about these methods, refer to the individual action reference topics.

Domains

Domain Name Domain Description
commerce.carts This domain contains actions associated with the cart.
commerce.catalog.admin This domain contains actions associated with your catalog.
commerce.catalog.storefront.products This domain contains actions associated with storefront products.
commerce.catalog.storefront.shipping This domain contains actions associated with shipping.
commerce.catalog.storefront.tax This domain contains actions associated with tax.
commerce.customer This domain contains actions associated with shopper accounts.
commerce.orders This domain contains actions associated with orders.
commerce.payments This domain contains actions associated with payments.
commerce.return This domain contains actions associated with returns.
commerce.settings This domain contains actions associated with settings for sites, checkout, installed applications, locations, shipping, and general Kibo eCommerce settings.
platform.applications This domain contains actions associated with Kibo eCommerce applications.
storefront This domain contains actions associated with storefront pages.

Software Requirements

Install the following software on your local machine in order to code actions:

Tools

Arc.js provides the following tools to facilitate development: