In January 2025, ShipHawk made available the ShipHawk TMS SuiteApp.

Pre-Installation Planning

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.

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:

1. Enable token-based authentication setup. Install the ShipHawk SuiteApp in your NetSuite instance.

2. Customize your script deployment settings.

3. Set up your proxy user.

4. Generate  access tokens.

5. Configure ShipHawk’s SuiteApp settings for NetSuite.

6. Add your ShipHawk API key to NetSuite.

7. Add your ShipHawk warehouse IDs to NetSuite.

8. Add your NetSuite account ID to ShipHawk.

9. 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

1. From your NetSuite top menu, select Setup > Company > Enable Features.
   

   

   The Enable Features screen is displayed.
   

   

2. Click the SuiteCloud tab to access these options. New options populate below:
   

   

    

3. Under the Manage Authentication section, enable the Token-Based Authentication setting.

   

   ShipHawk now can interact with NetSuite’s security using token-based authentication.

Installing the ShipHawk TMS SuiteApp

1. Navigate to the SuiteApps Marketplace. In NetSuite, you can either:

   1. access it from the SuiteApps menu
      

      

   2. access it from the Customization > SuiteCloud Development > SuiteApp Marketplace menu
      

      

      
      

2. Navigate to the ShipHawk SuiteApp, and click on the ShipHawk tile (not the ShipHawk WMS for NetSuite tile):
   

   

   
   

3. Click Install:
   

   

   
   

4. Next, confirm you want to proceed by clicking Install:
   

   

   
   

5. Click to Accept the terms of service:
   

   

   
   

6. If you experience any issues, check the logs by choosing Customization > SuiteCloud Development > Deployment Audit Trail, and review any log messages.
   

   

   

   
   

7. Once the installation is complete, you can find in Installed SuiteApps, by choosing Customization > SuiteCloud Development > Installed SuiteApp List:
   

   

   
   

   

   
   

8. Now the installation of the ShipHawk SuiteApp is complete.

Configuring the ShipHawk TMS SuiteApp

See SuiteApp Administration and Configuration Guide for NetSuite

Upgrading the ShipHawk TMS SuiteApp

1. Navigate to the SuiteApps Marketplace. In NetSuite, you can either:

   1. access it from the SuiteApps menu

      

   2. access it from the Customization > SuiteCloud Development > SuiteApp Marketplace menu

      

2. Navigate to the ShipHawk SuiteApp, and click on the ShipHawk tile (not the ShipHawk WMS for NetSuite tile):

   

3. Click Upgrade:
   

   

4. Select the most recent version and click Yes:

   

5. Click to Accept the terms of service:

   

6. If you experience any issues, check the logs by choosing Customization > SuiteCloud Development > Deployment Audit Trail, and review any log messages.
   

   

7. Once the installation is complete, you can find in Installed SuiteApps, by choosing Customization > SuiteCloud Development > Installed SuiteApp List:
   

   

8. Now the upgrade of the ShipHawk SuiteApp is complete.