In January 2025, ShipHawk made available the ShipHawk TMS SuiteApp.
As of the ShipHawk TMS 2025.1.0 release, new ShipHawk customers integrating with NetSuite must install the ShipHawk TMS SuiteApp rather than the NetSuite Bundle. ShipHawk will continue to support the NetSuite Bundle for existing customers, who should continue to use it. (Note that you cannot use both the ShipHawk TMS SuiteApp and the NetSuite Bundle at the same time.)
Pre-Installation
On Syncing Item Fulfillments to ShipHawk
ShipHawk uses item fulfillments in NetSuite to create Orders in ShipHawk. This is the preferred method of syncing data to ShipHawk because both Orders in ShipHawk and item fulfillments in NetSuite only contain items that are ready to be fulfilled.
Below is an explanation of how Item Fulfillments in NetSuite and Orders in ShipHawk interact:
When a user creates an item fulfillment in NetSuite:
An order is automatically created in ShipHawk with a corresponding proposed shipment.
The item fulfillment number is used as the order number in ShipHawk (ex: IF138296)
When a user updates an item fulfillment in NetSuite:
The corresponding order in ShipHawk will also be updated. This applies to updates such as line item changes and changes to the destination address.
When a user deletes an item fulfillment in NetSuite:
The order is deleted in ShipHawk.
When an order is fulfilled in ShipHawk:
The item fulfillment record is updated in NetSuite.
When a user deletes an order in ShipHawk:
The order or item fulfillment will not be automatically deleted in NetSuite
The order can be re-synced by updating the item fulfillment in NetSuite.
Sales orders in NetSuite can also be used as a syncing entity, but this method of syncing is not recommended. It is only acceptable to sync sales orders as Orders in ShipHawk if your organization is not concerned with inventory being out of stock.
The following charts illustrate the fulfillment workflow from NetSuite to ShipHawk when item fulfillments sync to ShipHawk compared to when sales orders do.
Sync Item Fulfillments as Orders (Recommended)
Sync Sales Orders as Orders (Not Recommended without Permission)
Regardless of which syncing entity your organization opts to use, the installation procedures outlined in this document remain the same.
Installation Checklist
To use ShipHawk’s functionality in your instance of NetSuite, you must complete the installation and setup tasks in the following order:
Enable token-based authentication setup. Install the ShipHawk SuiteApp in your NetSuite instance.
Customize your script deployment settings.
Set up your proxy user.
Generate access tokens.
Configure ShipHawk’s SuiteApp settings for NetSuite.
Add your ShipHawk API key to NetSuite.
Add your ShipHawk warehouse IDs to NetSuite.
Add your NetSuite account ID to ShipHawk.
Configure your NetSuite account in ShipHawk.
A proxy user is a method for transferring shipping order data from ShipHawk to NetSuite. In order to write data back into your NetSuite account after booking a shipment, ShipHawk creates a “proxy user” that has the correct permissions to send information to NetSuite’s database. The proxy user can be a user login used only for this purpose or it can be an existing administrative user. If the proxy user is an existing user, that user’s regular day-to-day use of NetSuite will not be affected by ShipHawk’s Web Services communications.
Enabling Token-based Authentication
NetSuite and ShipHawk communicate bilaterally. NetSuite sends item fulfillment data and information to ShipHawk via our API. ShipHawk uses web services in order to write information back to NetSuite. To set up these web services, we use token-based authentication, which you will set up in the following steps.
To create access tokens
From your NetSuite top menu, select Setup > Company > Enable Features.
The Enable Features screen is displayed.
Click the SuiteCloud tab to access these options. New options populate below:
Under the Manage Authentication section, enable the Token-Based Authentication setting.
ShipHawk now can interact with NetSuite’s security using token-based authentication.
Installation of SuiteApp
To install the ShipHawk TMS SuiteApp:
Navigate to the SuiteApps Marketplace. In NetSuite, you can either:
access it from the SuiteApps menu
access it from the Customization > SuiteCloud Development > SuiteApp Marketplace menu
Navigate to the ShipHawk SuiteApp, and click on the ShipHawk tile (not the ShipHawk WMS for NetSuite tile):
Click Install:
Next, confirm you want to proceed by clicking Install:
Click to Accept the terms of service:
If you experience any issues, check the logs by choosing Customization > SuiteCloud Development > Deployment Audit Trail, and review any log messages.
Once the installation is complete, you can find in Installed SuiteApps, by choosing Customization > SuiteCloud Development > Installed SuiteApp List:
Now the installation of the ShipHawk SuiteApp is complete.
Configuring Script Deployment Settings
In order to prevent potential communication conflicts between ShipHawk and NetSuite, the following script settings must be adjusted. Scripts determine how ShipHawk and NetSuite interact with each other and what information is exchanged.
To edit script deployments
From the top menu of your NetSuite dashboard, click Customization > Scripting > Script Deployments.
The Script Deployments screen is populated.
Locate and select the ShipHawk Sales Order ClientScript option from the Script dropdown field under the Filters section. ClientScripts are displayed under the Show Undeployed grid.
Locate the customdeploy_shiphawk_so_cs script. The record type for this script is Sales Order. Click Edit in the row corresponding to this script.
You will be redirected to the Script Deployment screen.
Verify three settings under the Audience tab:
The Select All checkbox for the Roles field is unchecked.
All subsidiaries in the Subsidiaries field must be selected. This grants them rights to use ShipHawk functionality.
The Select All checkbox for the Employees field is checked.
Click Save when you finish.
You now are finished configuring script settings for the installation.
To select multiple options in a list field like the Subsidiaries field, hold down the Control button on your keyboard and select each option by clicking on it with your mouse. Clicking again while holding down the Control key deselects the option.
Setting Up Proxy User
A user must be associated with the interactions between ShipHawk and NetSuite. You can choose an existing user or a user dedicated solely to the ShipHawk SuiteApp. Only one is required to establish the connection.
The proxy user is associated with programmatic interactions between ShipHawk and NetSuite. Deleting or disabling this user will break your integration with ShipHawk.
To manage users and their roles
From your NetSuite dashboard, click Setup > User/Roles > Manage Users.
The Manage Users screen is displayed.
Select any user whose role is currently Administrator. The Employee screen populates.
Navigate to the Access tab and click Edit.
From the Roles dropdown field, select ShipHawk Shipping Web Services and click Add.
ShipHawk Shipping Web Services should be displayed as a new role under the Roles table of the Access tab.
Click the Save button to finish.
Creating Access Tokens
Access tokens allow ShipHawk to interact with your NetSuite account programmatically. In this step, you will create the access tokens used to grant ShipHawk access.
To create an access token
From the NetSuite dashboard, select Setup > Users/Roles > Access Tokens > New.
You will be redirected to the Access Token screen.Complete the screen by entering the following information:
In the Application Name field, choose ShipHawk Integration.
In the User field, choose the proxy user you set up in the previous procedure.
In the Role field, select ShipHawk Shipping Web Services.
After you complete each field, the Token Name field automatically populates with a new token name. Click Save, but DO NOT EXIT THE SCREEN. A confirmation screen will populate.
This screen will not appear again. You will have to repeat this entire step if you lose the information on this screen.
Copy both the Token ID and the Token Secret in the Token Name field to a protected document or location outside of NetSuite. You will need to access this document later.
Configuring ShipHawk Settings in NetSuite
ShipHawk Settings control various aspects of the SuiteApp integration, including communication between ShipHawk and NetSuite, data synchronization, field mapping and more. This step focuses on connectivity for rating and order synchronization. Contact your ShipHawk Implementation Representative to discuss optional settings and configuration.
Only NetSuite users with Administrator role have access to the settings.
To add your ShipHawk API key to NetSuite
From the NetSuite dashboard, select ShipHawk > Setup > ShipHawk Settings.
You will be redirected to the ShipHawk Settings List screen.Click Edit to access ShipHawk settings.
Complete the ShipHawk Settings screen.
In the SHIPHAWK HOST NAME field:
Enter the ShipHawk endpoint to set up your Production environment.
For example, if the ShipHawk endpoint is:
https://abcdef.tms.myshiphawk.com
Enter:abcdef.tms.myshiphawk.comNOTE: If you are interested in a sandbox environment or user-acceptance testing environment, please contact your ShipHawk account manager for more information.
In the API Key field, enter the ShipHawk API key found in the ShipHawk platform. To locate the ShipHawk API key, complete the following steps:
Login to your ShipHawk account in a separate browser window or tab. If you are not sure which account to use, contact your ShipHawk Implementation Representative.
On the right side of ShipHawk’s top menu bar, click on the Settings
icon and select the Settings link. The Settings screen appears.From the left-side menu, click on the Developer API link. The API Keys screen appears.
Click the Create New API Key button located at the top of the screen. The Create API Key pop-up window appears.
Enter a Name for your API Key. Then, click Create API Key.
A success message will display at the top of the pop-up window to confirm your API Key has been generated.
Click Copy to copy your API Key.
Important: Your API Key will only be displayed one time. Ensure you have saved and copied your key correctly before exiting the Create API Key window.
After you have successfully copied the API Key to your clipboard, click Done.
Navigate back to NetSuite and the ShipHawk Settings screen.
Paste the ShipHawk API key into the API Key field in NetSuite.
Click on the Shipping Methods tab.
In the Default Shipping Method dropdown field, select your organization’s usual shipping method. If unknown, just select one from the dropdown list. Your ShipHawk Implementation Representative will assist you with this later.
Click Save when you are finished.
You cannot click Save until you have designated a default shipping method in the previous step.
Configuring NetSuite Settings in ShipHawk
Managing NetSuite Concurrent Connections and ShipHawk Performance
Adding ShipHawk Warehouses to NetSuite Locations
Confirm Connection
Upgrading the SuiteApp
To upgrade the ShipHawk TMS SuiteApp:
Navigate to the SuiteApps Marketplace. In NetSuite, you can either:
access it from the SuiteApps menu
access it from the Customization > SuiteCloud Development > SuiteApp Marketplace menu
Navigate to the ShipHawk SuiteApp, and click on the ShipHawk tile (not the ShipHawk WMS for NetSuite tile):
Click Upgrade:
Select the most recent version and click Yes:
Click to Accept the terms of service:
If you experience any issues, check the logs by choosing Customization > SuiteCloud Development > Deployment Audit Trail, and review any log messages.
Once the installation is complete, you can find in Installed SuiteApps, by choosing Customization > SuiteCloud Development > Installed SuiteApp List:
Now the upgrade of the ShipHawk SuiteApp is complete.
Further Configuration
See SuiteApp Administration and Configuration Guide for NetSuite