...
...
...
| Panel | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
The ShipHawk TMS SuiteApp now replaces the existing NetSuite Bundle (Hybrid SuiteApp) described in this guide. ShipHawk will continue to support its NetSuite Bundle for existing customers, but as of the 2025.1.0 release, new ShipHawk TMS customers must install the ShipHawk TMS SuiteApp instead. For more information on the ShipHawk TMS SuiteApp, see ShipHawk TMS SuiteApp . |
ShipHawk’s NetSuite bundle - which is a Hybrid SuiteApp - provides Web Services integration between NetSuite and ShipHawk. Our SuiteApp communicates with NetSuite to perform the following tasks:
...
| Panel | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
During the installation and integration process, you must switch back and forth between your NetSuite and ShipHawk accounts. Open each account in a different browser tab or window to speed up navigation between accounts. |
SuiteApp Definitions
Bundle or SuiteBundle | The technical term for applications developed within NetSuite. They are called “bundles” because NetSuite applications are a group of scripts that each run different functions. These applications are also referred to as “SuiteApps.” These SuiteApps are hosted by NetSuite. They are stored in the same database and on the same servers as your company data and can be accessed directly from your NetSuite account. For the purpose of this document, “bundle” refers to ShipHawk’s NetSuite application. |
SuiteScript | SuiteScript is the NetSuite platform built on JavaScript that enables complete customization and automation of business processes. Using the SuiteScript web services, core business records and user information can be accessed and manipulated via scripts that are executed at predefined events. |
Hybrid SuiteApp | A category of SuiteApp based on how the application integrates with NetSuite. There are three types of SuiteApps: Native SuiteApps These apps live entirely within the SuiteCloud platform. Integrated SuiteApps These apps live mostly outside the NetSuite platform and communicate information back and forth. Hybrid SuiteApps These apps are a mixture of the native and integrated solutions. Hybrid SuiteApps integrate with NetSuite using custom UI elements and can store data both inside and outside the NetSuite platform. ShipHawk is a Hybrid SuiteApp. |
Proxy User | 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. |
Installation Procedures
This section provides detailed procedures for the installation of the ShipHawk bundle in your instance of NetSuite. The installation gives ShipHawk access to your NetSuite account and allows ShipHawk to create and/or update fulfillment information in your NetSuite. The following procedures guide you through the process of configuring your ShipHawk bundle installation. These procedures are intended for your organization’s system administrator.
...
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.
...
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.
| Info |
|---|
Only NetSuite users with Administrator role have access to ShipHawk Bundle 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 SHIPHAWK HOST NAME field:
Enter Shiphawk.com 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.com
NOTE: 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.
...
From the NetSuite dashboard, select Customization > SuiteBundler > Search & Install Bundles > List.
To go directly to the Installed Bundles screen, type “Page: Installed Bundles” into the Search bar at the top of the dashboard.
The Installed Bundles screen is displayed.
Locate the ShipHawk SuiteApp in the grid below.
Verify that the account is named ShipHawk Integration (TSTDRV2246640).From the Action
icon on the left hand column, click the Update link in the drop-down field.
The Preview Bundle Update screen is populated with a deprecated version notice.
IMPORTANT: When updating the Bundle, be sure to select Replace existing object (not Add and rename) to make sur duplicate fields are not created in NetSuite, which can later cause issues.
See also: https://docs.oracle.com/en/cloud/saas/netsuite/ns-online-help/section_N3397927.html#bridgehead_N3399371
Click the Update Bundle button.
A notice will generate.Click the OK button to accept. The bundle installation begins. You can view the installation progress on the Installed Bundles screen.
Once the bundle is successfully updated, the ShipHawk bundle will show the new bundle version and will reference a new deployment account called ShipHawk Integration (TSTDRV2246640).
You have now successfully updated the bundle to the latest version. Contact your ShipHawk Account Manager if you have any additional questions.
| Expand | ||||
|---|---|---|---|---|
| ||||
|