Extensibility API

This topic applies to

Applies to

SuiteCommerce | SuiteCommerce Advanced


This information refers to the SuiteCommerce and the Aconcagua release of SuiteCommerce Advanced and later.

SuiteCommerce includes a conceptual layer on top of existing SuiteCommerce architecture. Conceptually, this layer provides an environment for extension developers to customize a Commerce web store and SuiteCommerce InStore (SCIS) through extensions, without the need to extend or customize the underlying application code.

Developers create extensions in their local environment using the extension developer tools. This environment/workspace is represented by the Developer Code Layer in the image above. Each extension contains any number of JavaScript, SuiteScript, or configuration files to perform some purpose. Within this code, developers include API calls to components in the Extensibility API. This is represented by the Extensibility API Layer.

The API then accesses frontend and backend modules (routers, models, views, etc.) in the Application Layer. In this way, extensions are separated programmatically from the application and interact with the API only, not with the application directly. This makes customization more seamless and intuitive for extension developers and ensures that future updates to the application do not compromise developer custotmizations.

See the following topics for more information about the Extensibility API:

  • Extensibility Component Classes – This topic provides an overview of the Component Classes available to you when creating extensions.

  • Extensibility API Tutorials – This topic explains how to use the components plus their methods and events when building your extensions. This includes everything from accessing components to building CCTs, Views, etc.

  • SCIS Extensibilty API – This topic includes information about the components available to you when creating extensions for SCIS.

Go to the Extensibility API Reference for complete documentation on the available component classes.