This is a repository of code samples for NetSuite SuiteCommerce and SuiteCommerce Advanced. The snippets show how the code works; they are not official features or modules for SuiteCommerce.
Dependencies
In order to use these samples and develop a web store you will need at a minimum:
- An active NetSuite account
- An installed SuiteCommerce or SuiteCommerce Advanced (Denali or newer) bundle and their associated bundles
- The developer tools installed on your machine
Furthermore, it is recommended that you have:
- Read the official documentation, in particular the developer overview sections
- Completed the SuiteCommerce: Web Store Administration training
- Completed the SuiteCommerce: Theme and Extension Development training (if your web store uses SuiteCommerce or SuiteCommerce Advanced Aconcagua (2018.1) or newer)
Organization of the Repository
This repository contains code samples (in the directory called samples) split up by version. The version indicates roughly when the code was written, but given the flexibility of the code, some of it will be backwards-compatible, and some will be forwards-compatible.
The code samples are there to show you things fit together and to give you ideas about customizations that you can make to SuiteCommerce and SuiteCommerce Advanced web stores. They are not 'official' NetSuite features --- you should consider them learning materials to improve your understanding of the products.
Installation
There is no installation required for these code samples.
Some users may prefer to use GitHub to browse the code samples; others may wish to clone the repository to their local machine.
If you wish to use them in your site's source code, you will need to follow the standard/documented steps (depending on the type of customization). For example:
- Creating a new module in SuiteCommerce Advanced: https://netsuite.custhelp.com/app/answers/detail/a_id/44323
- Creating a new extension: https://netsuite.custhelp.com/app/answers/detail/a_id/71057
- Creating a CCT module: https://netsuite.custhelp.com/app/answers/detail/a_id/65904
Documentation
No official documentation for NetSuite products are hosted in this repository --- that is available in the Help Center via your NetSuite account, or SuiteAnswers.
Primary documentation for these code samples come in the form of comments in the source files. However, you should also search the developer portal as you will likely find an accompanying article that explains the code (and the process for writing it) in more detail.
Support
No support is provided for these code samples, they are provided as-is.
Issues
This repository is to help developers get started and work on customizations for SuiteCommerce and SuiteCommerce Advanced. Do NOT raise issues to ask general questions about SuiteCommerce, or to report bugs with the bundles or NetSuite. Issues must relate only to the content within this repository only --- unrelated issues will be closed and/or removed.
Security Issues
If you have security concerns about the code in this repository, do NOT raise a GitHub issue. Instead, please follow the instructions in SECURITY.md.
Contributions
Community contributions are not currently being accepted.
If you have ideas, comments, or issues to discuss, create an issue in this repository.
See CONTRIBUTING for more details.
Third-Party Libraries
This repository references the third-party libraries that are used within the SuiteCommerce and SuiteCommerce Advanced bundles. Links to their licenses can be found in THIRD_PARTY_LICENSES.
License
Copyright (c) 2020, Oracle and/or its affiliates.
Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl.
See LICENSE for more details.