ShipHawk Guide
Integrating with 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.
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.
The integration process is as follows:
Installation Instructions
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.
The prerequisites for installing the ShipHawk SCA Connector are as follows:
SuiteCommerce is installed on your NetSuite account and you have configured an associated SuiteCommerce Domain.
Your role has the necessary permissions required to install and upload bundles to your NetSuite account
The most recent version of bundles are listed as installed on the Installed Bundles List page:
SuiteCommerce Extension Management
SuiteCommerce Configuration
SuiteCommerce Base Theme
SuiteCommerce
ShipHawk
When updating the ShipHawk bundle set the PREFERENCE to “Update Deployments“ for Shiphawk Shipping Method Map Suitelet
The required ShipHawk bundle version is 2024.7.2 or newer.
To install the bundle
Log into your NetSuite account.
From the NetSuite menu at the top of the screen, select Customization > SuiteBundler > Search & Install Bundles.
The Search & Install Bundles screen is displayed. The ShipHawk SCA Connector bundle is displayed in the grid below.
Click on the appropriate ShipHawk SCA Connector link in the grid based on the account where you want to install it —Sandbox (548896) or Production (548895). The ShipHawk Bundle Details screen populates.
Click the Install button to begin the installation process for ShipHawk SCA Connector. A series of pop-up windows and prompts will populate.
Confirm all prompts.
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 extension
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.
Navigate to the Extension Manager page. From your NetSuite menu bar, click Commerce > Extensions > Extension Manager.
The Extension Manager can also be accessed from the NetSuite menu bar by clicking Setup > SuiteCommerce Advanced > Extension Manager.
The Extension Manager screen appears, with a list of all your installed extensions.
Find your SuiteCommerce Domain and click Edit. This will take you to the Activate Themes and Extensions page.
From the Activate Themes and Extensions page, click the Extensions tab.
Locate the ShipHawk SuiteCommerce Extension and select the Active Checkbox.
Click the Activate button, located at either the top or bottom of the list.
To deactivate the extension
Navigate to the Extension Manager page. From your NetSuite menu bar, click Commerce > Extensions > Extension Manager.
Find your SuiteCommerce Domain and click Edit. This will take you to the Activate Themes and Extensions page.
From the Activate Themes and Extensions page, click the Extensions tab.
Locate the ShipHawk SuiteCommerce Extension and deselect the Active Checkbox.
Click the Activate button (similar to how you would activate the extension), located at either the top or bottom of the list.
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:
Navigate to Commerce > Content Management > Cache Invalidation Requests > New.
You will be redirected to the Cache Invalidation Request pop-up window.
From here, select the Domain associated with your extension from the Available Domains field. Use the right and left arrows to the right of the field to move your Domain to the Selected Domains field, as demonstrated in the screenshot below:
Select the Clear cache for the whole domain option. Click Submit.
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.
After you have successfully installed the bundle, navigate to Commerce > Website > Website list -> ‘Name of the website’ > Edit
Ensure the ‘Scriptable Cart and Checkout’ checkbox is selected under the Preferences heading.
Ensure the related custom fields are exposed to your site. Navigate to Commerce > Websites > Configuration.
Select the Website and Domain you associated with your SuiteCommerce Connector from the fields. Click Configure.
From the Configuration screen, click the Advanced tab. Then click Custom Fields.
Under the Sales Order custom field add the following under Field ID:
custbody_shiphawk_rate
custbody_shiphawk_cart_rates
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.
Click Save.
Ensuring Rates can be used at Checkout
Navigate to Lists > Accounting > Shipping Items.
From the list, locate all Shipping Rates you want returned at the time of checkout. Repeat this for each Shipping Item necessary.
Click Edit.
Ensure the Display In Web Site checkbox is selected. If not, select the Display In Web Site checkbox and click Save.
Repeat this process for every shipping rate you want used at checkout.
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:
From the NetSuite search bar, enter: SC ExtMech Extension.
From the list of search results, locate and select: Page: SC ExtMech Extension.
You will be redirected to the SC ExtMech Extension List page.
Locate the ShipHawkSCEExtension record from the list. Click Edit to edit this record.
This will open an editable record of the ShipHawkSCExtension.
Locate the Target Version field in this record.
If there is a target version present in this field, clear the target version.
Click Save to update the record.
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.
Related content
Contact Technical Support
© ShipHawk 2024. All Rights Reserved.