Develop Your Extension

This topic applies to

Applies to

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 and later) – 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. To take advantage of themes, extensions, and the Extensibility API, 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:

Step

Description

More Information

1

Create a set of baseline extension files.

The extension developer tools give you a starting point for extension development. Follow these instructions to create a baseline Hello World extension.

Create Extension Files

2

Customize your extension.

You can introduce JavaScript, SuiteScript, Json, HTML templates, and Sass files, as needed. The Extensibility API is available to access frontend and backend modules within the application.

Extensibility API

3

Add any assets to your extension source files, such as fonts and images. This step requires manually updating your extension’s manifest.json file.

Extension Manifest

4

Optionally build your extension to integrate with Site Management Tools (SMT) as custom content.

Create a Custom Content Type

5

Deploy your extension.

You can test your extension on a local server. However, you must first deploy your extension files to your account and activate the extension on a domain before testing locally.

Deploy an Extension to NetSuite

6

Activate your extension.

To see your extension in action, you must activate it for a domain.

Manage Themes and Extensions

7

After activating your extension for a domain in NetSuite, you can test your extension code on a local server for debugging purposes.

Test an Extension on a Local Server

8

When you are satisfied with your extension code, deploy using the extension developer tools.

Important

You must activate the extension before any deployed changes take effect. See Manage Themes and Extensions for details.


Deploy an Extension to NetSuite

9

Create a bundle for your extension.

If you intend to publish your extension and share it with other accounts, follow these instructions to bundle your extension as a SuiteApp.

Theme and Extension SuiteApps