Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

About the ShipHawk SuiteCommerce Connector

The ShipHawk SuiteCommerce Connector allows your organization to use ShipHawk’s in-cart rating functionality with your SuiteCommerce website. By connecting your SuiteCommerce solution with the ShipHawk extension, your organization can ensure your customers are receiving the optimal shipping rate at the time of checkout.

ShipHawk SuiteCommerce Connector Features

The ShipHawk extension is built for NetSuite’s SuiteCommerce and SuiteCommerce Advanced solutions. The extension allows you to apply ShipHawk’s features to your SuiteCommerce solution. These features enable users to carry out their organization’s fulfillment needs.

To learn more about the features included with the SuiteCommerce ShipHawk Connector, refer to How the ShipHawk SuiteCommerce Connector Works.

Local Development Setup

Required Prerequisites

  • An Integrated Development Environment (IDE) is required. Visual Studio Code is recommended.

  • Ensure the latest version of Node.js is installed. If you have a higher version, downgrade to the required version.

“ShipHawk SCA Connector” Bundle Setup

  1. Go to the TMS Netsuite Sca Connector repository, and clone it to your local machine.

...

  1. You will be prompted to enter a new authentication ID (auth ID). Enter any value that is clear and meaningful to you.

  2. A new NetSuite browser window will populate and prompt you to log in to your account. Ensure you are logged into your account

  3. Click Allow.

  4. You have now established you are working with this NetSuite account from your IDE.

  5. After making any changes, you need to deploy the modified files back to your NetSuite account.

  6. Enter the following command in your terminal: suitecloud project:deploy

“ShipHawkSCExtension” Extension Setup

  1. Log in to your NetSuite Dev account and install the ShipHawk SCA Connector bundle from the “ShipHawk Integration - 2017A V1.0” account by following the installation instructions.

  2. Go to the Bundles list find the SuiteCommerce Extension Management bundle and remember the bundle ID.

...

  1. After testing your changes on the dev account Copy/Paste them to the TMS Netsuite Sca Connector.

Installation instructions (public)

Prerequisites

Before beginning the installation process, you must meet the prerequisites listed below. If your NetSuite account has SuiteCommerce installed, these prerequisites will likely already have been fulfilled.

...

Note

The required ShipHawk bundle version is 2024.7.2 or newer.

To install the bundle

  1. Log into your NetSuite account. 

  2. From the NetSuite menu at the top of the screen, select ​Customization > SuiteBundler > Search & Install Bundles.

...

Congratulations, you have installed the ShipHawk SCA Connector!

Troubleshooting:

If the ShipHawk SCA Connector is already installed on your account you might encounter the situation shown below. Then please select the Replace Existing Objects action while installing the bundle.

...

To activate the extantion

Though the ShipHawk SuiteCommerce Connector may be installed, it needs to be manually activated in NetSuite in order for it to display on your SuiteCommerce website.

...

  1.  Locate the ShipHawk SuiteCommerce Extension and select the Active Checkbox. 

  2. Click the Activate button, located at either the top or bottom of the list.

...

To deactivate the extantion

  1. Navigate to the Extension Manager page. From your NetSuite menu bar, click Commerce > Extensions > Extension Manager.

  2. Find your SuiteCommerce Domain and click Edit. This will take you to the Activate Themes and Extensions page.

...

NetSuite will utilize the native Shipping Functionality when your connector becomes deactivated.

Troubleshooting:

If you opt to deactivate your SuiteCommerce Connector and it is still appearing on your SuiteCommerce site and Domain, you may need to clear your site’s cache in NetSuite for the change to take effect. This section will instruct you on how to do so:

...

You have cleared your cache for your domain. This will update your domain with the ‘deactivated’ extension status.

Additional Settings

The last step in the installation process is to configure some additional settings in NetSuite.

...

Receiving an “ERROR: Field not found” when installing the extension can be caused by adding the custom sales order fields incorrectly, or failing to add them altogether. 

  1. Click Save.

Ensuring Rates can be used at Checkout:

  1. Navigate to Lists > Accounting > Shipping Items.

  2. From the list, locate all Shipping Rates you want returned at the time of checkout. Repeat this for each Shipping Item necessary.

  3. Click Edit.

...

Receiving an “ERROR: Please select  a shipping method” error when installing the extension can be caused by failing to select the  Display in Web Site checkbox.

Troubleshooting: Cannot locate Connector from Extension Manager Page

If the connector you installed is not present on the Extension Manager page, it may be because there is an incorrect target version attached to the file. If this is the case, you can still find your connector in the SC ExtMech Extension page and clear the target version to fix this issue. 

To ensure your connector was deployed to your NetSuite account:

  1. From the NetSuite search bar, enter: SC ExtMech Extension.

  2. From the list of search results, locate and select: Page: SC ExtMech Extension.

...

  1. Click Save to update the record.

  2. If there was a target version on this field, this should resolve the error and you should now see the ShipHawk SCExtension populated on the Extension Manager page.

Customizations in customer installations (internal only)

A list of customers who have their own customizations for our extension (provided by Katoomi):

...