About this document

This article explains how the SPS Commerce ASN Connector integration works in NetSuite, which sends shipping and package data to SPS Commerce from ShipHawk for ASN generation. 

About SPS Commerce

SPS Commerce is an electronic data interchange (EDI) provider that generates ASNs using package detail information derived from NetSuite. Advanced shipment notices (ASNs) are a type of document that provide recipients with information about a pending shipment. ASNs are commonly used when delivering large quantities of packages to retailers, so that the retailer can prepare for the placement and storage of these packages before they are delivered. 

Each retailer has their own requirements for how ASNs should be formatted. As such, SPS Commerce works with their customers to customize ASNs for each retailer. The role of ShipHawk in this process is to provide SPS Commerce with basic package information so SPS Commerce can then curate custom ASNs for their customers.

How ShipHawk Works with SPS Commerce

ShipHawk consumes item fulfillments (or sales orders) originating from NetSuite. When these are booked, ShipHawk communicates with NetSuite via web services to make updates to the Item Fulfillment record.

For details on how ShipHawk works with NetSuite,  see SuiteApp Administration and Configuration Guide for NetSuite .

When updating Item Fulfillment records, by default, ShipHawk  writes package-level information back to custom ShipHawk fields in NetSuite. When you enable the SPS Commerce connector however, ShipHawk will write the shipment package-level information to SPS Commerce’s custom records in NetSuite instead. 

Specifically, ShipHawk writes package details to the custom SPS EDI Packages tab under the item fulfillment record. SPS Commerce then uses the package details to generate ASNs.

ShipHawk’s interaction with SPS  Commerce ends when the package details are written to the SPS Commerce’s records and the ASN file is generated (depending on the Autogenerate ASN setting, described below). Further downstream processes related to EDI and ASN are handled by SPS Commerce.

The package details ShipHawk sends to this custom tab for SPS Commerce to retrieve include:

• Width

• Height

• Length

• Weight

• Tracking Number

• Package Quantity

• Item Fulfillment ID (itemFulfillmentId)

• Carton Index (cartonIndex)

• UCC Label ID (labelid)

• Bill of Lading Number

• Carrier PRO Number

• Carrier Alpha Code

• Items object, which includes the following for each item in the package:

  • itemId

  • itemFulfillmentLine

  • itemQuantity

Configuration Prerequisites

The SPS Commerce integration is intended for any customer using SPS Commerce as their EDI provider. For a ShipHawk customer to use this integration, they must already have the following SPS Commerce bundles configured on their instance of NetSuite:

• SPS Commerce Fulfillment for NetSuite

• SPS Commerce

• SPS Commerce Supplier Automation

• SPS Integration Status

SPS Commerce Configuration Tasks

SPS Commerce configuration includes the following:

1. Create New Package Record for Custom Entry Form

2. Enable ShipHawk to Automatically Generate ASNs

Create New Package Record for Custom Entry Form

Create a new Package record for a custom entry form as follows.

1. Select  Customization > Lists, Records, & Fields > Record Types:
   

   

   
   

2. Click on the Package record (ID: customrecord_sps_package):
   

   

   
   
   

3. Under the  Forms tab, for the SPS Package Form, click Customize:
   

   

   
   
   

4. Select  the FORM IS PREFERRED  checkbox (make sure it is checked on), then under Subtabs, find Contents.
   

   

   
   
   

5. Using the Move To Bottom button, move the Contents row to the bottom, and select the SHOW checkbox (make sure it is checked on):
   

   

   
   
   

6. In the LABEL field, enter the text  “Contents (Scripted - not for UI use)”:
   

   

   
   
   

7. Finally, near the upper left corner of the screen, click Save.

Enable ShipHawk to Automatically Generate ASNs

To enable ShipHawk to automatically generate ASNs, complete the following steps:

1. Select Customization > Scripting > Script Deployments:
   

   

   
   
   

2. In the SCRIPT field, select the SPS SL SVC Create ASN script ( ID: customscript_sps_sl_svc_create_asn).
   

3. Next, in the row for the script, click the Edit link:
   

   

   
   
   

4. Select AVAILABLE WITHOUT LOGIN (make sure it is checked on):
   

   

   
   
   

5. Finally, click Save.

Enabling the SPS Commerce Connector

Before you can access SPS Commerce settings in the ShipHawk user interface, your ShipHawk Account Manager must enable this feature for your account. 

Now you can enable the SPS Commerce connector as follows:

1. On the ShipHawk user interface, navigate to Settings > Integrations > NetSuite.
   You will be redirected to the NetSuite Manage Your Accounts screen.
   

2. On the NetSuite Manage your Accounts screen, click on the Advanced tab.
   

3. Under the SPS Commerce Connector for ASN heading, select Enable SPS Commerce Connector for ASN.
   

   

   
   

4. Click Save.

Once this is enabled, ShipHawk writes necessary shipment and package information to SPS Commerce’s records in NetSuite, which are available in the Item Fulfillment record.

You will not be able to see shipment package data in the ShipHawk Package Items tab in the Item Fulfillment record. Instead, the package information will appear under the SPS EDI Packages tab in the Item Fulfillment record. This is to avoid duplication and delays in the Item Fulfillment update process.

When you have selected Enable SPS Commerce Connector for ASN, you can optionally select the Autogenerate ASN option. This option automatically generates ASNs in NetSuite after the shipment is made and the package information is written to SPS Commerce’s records.

Additionally, once you have enabled the above options, you will also be able to see ASN generation status added to the Source System Sync Status modal, which is available in the ShipHawk Shipment details page: