Develop Your Extension

This topic applies to

Applies to

Aconcagua | SuiteCommerce Web Stores

Extensions require interacting with the Extensibility API. The Extensibility API is available to extension developers for both SuiteCommerce and SuiteCommerce Advanced (SCA). Be aware of the following requirements:

  • SuiteCommerce – The Extensibility API is required to create extensions for SuiteCommerce.

  • SuiteCommerce Advanced (Aconcagua) – Creating extensions using the Extensibility API is a best practice for developing Suite Commerce Advanced. However, if your SCA customizations require access to JavaScript, SuiteScript, or configuration objects that are not accessible using this API, you must use the core SCA developer tools and customization practices. See Core SCA Source Code for details.

  • SuiteCommerce Advanced (Kilimanjaro and Earlier) – The Extensibility API is not available for these implementations of SCA. You must either migrate your site to the latest release of SCA or use the core SCA developer tools and customization practices to customize your site. See Core SCA Source Code for details.

Extension Development Steps

Follow this general guide to develop your extension:

Note

If your extension requires access to objects not available using the Extensibility API, refer to Core SCA Source Code for further instructions.


Step

Description

Create Extension Files

The first step is to create a baseline set of files. The extension developer tools help you out by walking you through a series of questions. The developer tools then create an example extension within your extension workspace as a starting point for development.

Develop Your Extension using the Extensibility API

Build your extension code. Use the Extensibility API to access all components as necessary.

Deploy an Extension to NetSuite if Implementing SuiteScript and Configuration Files

If your extension includes SuiteScript or configuration (JSON) files, you must deploy your files to your account and activate the extension before testing locally. SuiteScript includes services, which do not exist in your account’s backend until you deploy them. Likewise, changes to configuration JSON files do not apply to a domain until deployed.

Note

Although deploying your code is a required task later in the process, doing so at this time is required if you intend to test your extension locally and your extension includes SuiteScript or configuration files.


Test an Extension on a Local Server

Follow these instructions to run your extension on a local server. This involves combining your extension development files into compiled, runtime files for a specific domain. If your extension includes SuiteScript or Configuration files, you must deploy your files before testing them locally.

Deploy an Extension to NetSuite

Follow these instructions to deploy your extension files to your NetSuite Account.

Activate Themes and Extensions

After you deploy your extension to an account, you must now activate it for a domain before your changes take effect. This is required if you are for both creating a new extension or updating a pre-existing one.