The Shipwell SuiteApp for NetSuite makes connecting NetSuite to Shipwell seamless and can be completed in minutes. This page describes connecting SuiteApp to the Shipwell account and how it behaves step-by-step from user and technical perspectives. It requires that the Shipwell user have user permissions to manage their company’s integrations and also requires that the SuiteApp has been activated for your Shipwell account. Make sure to contact your Customer Success Manager for SuiteApp access and if you have any questions.
SuiteApp configuration form
Go to ‘Manage’ → ‘Company’ → ‘Integrations’ → Click ‘Connect’ on the NestSuite card → Click ‘Configure with SuiteApp’ → Empty form displayed:
Generating certificate & public key
Enter NetSuite Account Number → “Generate key” button enabled:
Click “Generate key” button → Certificate & key section will appear and there is an ability to download generated certificate & public key:
Downloading state:
Tech aspects:
- Validation: “Generate key” button will be disabled until there will be value in the “NS account number” field.
Connecting SuiteApp
Enter NetSuite Cert ID → “Connect” button enabled:
Click “Connect” button → Validation success → Success toast shows up and form left in connected state with “Disconnect” button:
Open Screenshot 2023-03-22 at 15.08.02.png
Click “Connect” button → Validation failed → Error toast shows up and form brings up user to the entry point of configuration(empty form).
Tech aspects:
- Validation: “Connect” button will be disabled until there will be value in the “NetSuite Cert ID” field.
Generating New key
After SuiteApp connected there is an ability to generate new public key but it will disconnect SuiteApp from the Shipwell account and require to reconnect.
Click “Generate New Key” button → Warning modal appears:
Click “Yes, Generate Key” → Success toast appears and “NetSuite Cert ID” field is empty on the form:
Enter NetSuite Cert ID and click “Connect” to reconnect SuiteApp.
Disconnecting SuiteApp
To disconnect SuiteApp click “Disconnect” → Warning modal appears:
Click “Yes, Disconnect” → Success toast shows up and form brings up user to the entry point of configuration(empty form):
Configuring the SuiteApp
The SuiteApp will come preconfigured with common configurations that work for many customers. See default Shipwell - NetSuite field mappings here. However, there may be the interest in modifying these configurations to fit your preferences. Many of these modifications can simply be made under the ‘Data Mapping’ tab in the NetSuite Suite Configuration page.
The Shipwell SuiteApp provides an interface within the Shipwell Integrations area for NetSuite to map out your SuiteApp custom fields if you do not seek to use standard mappings for Shipwell. You can access this page by selecting ‘Manage’ → ‘Company’ → ‘Intgegrations’ → ‘NetSuite’ → ‘Data Mapping’. There are sections for:
Order Information In
Order Information: Provides reference level data field mapping for orders including Custom Reference Data.
Ship From: Provides ship from level data field mapping for orders including Custom Stop Data.
Ship To: Provides ship to level data field mapping for orders including Custom Stop Data.
Order Line Items: Provides order line item data field mapping for orders including Custom Line Item Data.
Global Field Configurations: Provides global field configurations that supercede certain individual fields.
Shipment Information Out: Provides key shipment level information mapping back from Shipwell into NetSuite.
When a user wants to map a field different from the SuiteApp’s default mapping then you simply search for the NetSuite custom field that is available and choose from the ‘NetSuite Field’ dropdown to map the against the designated ‘Shipwell Field’. Customers can map no fields and the Shipwell SuiteApp will use its standard mappings or users can map one or more mappings as they see fit.
Frequently Asked Questions (FAQs)?
Can I make updates to my field mappings?
Yes, anyone with proper user permissions can indeed make mapping changes.
Area all NetSuite fields available for mappings?
Many but not all. Currently all NetSuite custom data fields that fit into a string, integer, decimal types are available. We will also be adding boolean and date and time types shortly. In the future, we expect to support list types.
What happens to my previous orders within Shipwell if I change field mappings?
It is perfectly fine to update field mappings within Shipwell SuiteApp configuration area. Field mapping changes will NOT impact prior orders but instead will be used in going forward process.
Do I need to do anything to have these expanded SuiteApp benefits?
No, these will be available to all existing Shipwell SuiteApp customers once the release is completed automatically
Are there different mappings for different types of SuiteApp orders (e.g. Purchase Orders, Sales Orders, etc.)?
Not at this time. Potentially in the future this is something we may support based on customer interest. If there is a need for this we would appreciate you letting your Customer Success Manager know.
What happens if I delete or rename a custom field within NetSuite that is mapped in the Shipwell SuiteApp configuration?
The deleted or modified NetSuite field will be recognized as no longer available and Shipwell SuiteApp will go back to usinh the default field mapping for the respective Shipwell field.
Is the Shipwell SuiteApp for NetSuite Right For You? In order to determine if the SuiteApp is right for you as a stand alone option or whether additional API development might be needed, we recommend leveraging the following process:
Start by identifying your successful process and data flows between NetSuite and Shipwell. This means being specific on which fields in both NetSuite and Shipwell are looking to be leveraged and the process around those being leveraged.
Identify which of those processes, data, and data flows are necessary versus nice to have. Not everything will likely be currently supported by the SuiteApp and being able to segment the critical items versus the nice-to-have items will help you in determining the appropriate choice.
Identify which items are supported via the Shipwell SuiteApp natively and which items are not. This document and associated documents will be a strong guide in this but there should also be engagement with your Shipwell Solution Engineer that will help guide you here.
Based on understanding of what is supported and what is not supported via the SuiteApp, then determine if those gaps in aggregate are minimal and move forward with the SuiteApp. Or if gaps more substantial, then engage a potential integrator (internal or external) to evaluate the level of effort to either fill in those gaps between desired process and data flows between NetSuite and Shipwell not supported by the Shipwell SuiteApp.
For modifications sought that are not supported via the SuiteApp Data Mapping section we can still leverage the SuiteApp API Routes to support these. Please contact your Customer Success Manager if you might need assistance here.
What SuiteApp Enhancements Are Next?
Upcoming is the ability allow customers to:
1. Upgrade their Shipwell SuiteApp from v2 orders to v3 orders and gain many of the additional capabilities of v3 orders.
2. Making enhancements on Shipment Financial information coming back from Shipwell into NetSuite.
3. Expanding out the Shipwell SuiteApp to support all Shipwell modes.