The ShipHawk-Acumatica connector is a solution designed to allow users to install the ShipHawk app for Acumatica. The app is an Acumatica Certified Application (ACA), meaning it adheres to standards set for Acumatica integration and functionality. When the application is successfully installed and configured, ShipHawk is able to sync Acumatica shipments as orders in the ShipHawk platform and complete the order fulfillment process.
...
✔︎ Appropriate permissions enabled for the user importing the ShipHawk package
Terminology
Term | Definition |
App / Connector | The package that can be installed and loaded into Acumatica. It contains the code that enables integration and interaction between Acumatica and ShipHawk. |
Orders | The object in ShipHawk that represents an order. |
Shipments (ShipHawk) | The object in ShipHawk that represents a shipment. Shipments in ShipHawk are created automatically after an order is set to ship. |
Sales Orders | The object in Acumatica that represents an order. |
Shipments (Acumatica) | The object in Acumatica that represents a shipment. Users sync Shipments in Acumatica to ShipHawk as an Order. |
Installation Procedures
You may begin the installation process if you have reviewed the prerequisites and determined they have been met by your organization.
...
Log in to Acumatica, navigate to Configuration> Customization > Customization Projects
The Customization Projects page will appear, with a list of the customization projects available for the current application instance.
Click the Import button in the form toolbar. A drop-down menu will appear.
Select Import New Project from the drop-down menu.
Select the Choose File button in the Open Package pop-up window.
Select the ShipHawk package file from your computer’s file manager.
Click Open
The selected package will display in the open package popup. Click the Upload button to upload the file. It may take a few moments to load on the screen.
...
Locate the ShipHawk package you imported to the Customization Projects page, displayed as a row in the grid.
Ensure the row containing the ShipHawk solution is selected.
Select the checkbox to the left of the Published column.
You can publish multiple packages by selecting the checkbox for each respective package.
Click the Publish button in the form toolbar. A drop-down menu will appear.
Select the ‘Publish to Multiple Tenants’ option from the menu.
A pop-up window will appear titled Publish to Multiple Tenants. From this window, select the Selected checkbox, located in the same row as the Tenant Name ‘ShipHawk’ .
Select the ‘Execute All Database Scripts’ checkbox. Then, click OK.
Following the Publish to Multiple Tenants pop-up, the Publish Customization pop-up will appear. When prompted, click Publish.
If the package is successfully published, the checkbox under the Published column will display as selected against the ShipHawk package in the Customization Projects grid.
To unpublish your solution, deselect the Published checkbox and click the Unpublish All button in the form toolbar.
...
Log in to the Acumatica instance that contains the published ShipHawk solution.
Navigate back to the Customization projects page. Click Configuration> Customization > Customization Projects
The Customization Projects page will appear. This page should have the published ShipHawk solution displayed as a row in the grid.
Ensure the row containing the ShipHawk solution is selected.
From the form toolbar at the top of the grid, select the Import button. The Import drop-down menu will appear.
Select the ‘Replace Highlighted Project Content’ option from the drop-down menu.
Select the Choose File button from the Open Package pop-up window.
Locate and select the updated file from your Computer’s file manager.
Verify that the correct file appears in the Open Package pop-up. Click Upload.
Navigate back to the Custom Projects page and select the recently uploaded file.
Select both versions of the ShipHawk package.
Click on the Publish button, then select the Publish with Cleanup option.
...
Log in to the Acumatica instance that contains the ShipHawk solution.
Navigate back to the Customization projects page. Click Configuration > Customization > Customization Projects
The Customization Projects page will appear. This page should contain the ShipHawk solution.
If selected, clear the checkboxes for the ShipHawk package.
Click the Publish button located in the form toolbar. The Compilation pop-up window will appear.
Click Publish in the Compilation window.
Sequentially select and delete the rows with the solution packages unpublished. This can be done by highlighting the row containing the package, then clicking the X button in the toolbar to delete the row.
If executed correctly, you will no longer see the ShipHawk package in the Customization Projects grid.
...
After you have installed and published the ShipHawk application to your instance of Acumatica, you must set up your ShipHawk workspace in Acumatica and ensure the two solutions have successfully connected. The setup process is accomplished by using the ShipHawk Setup and ShipHawk Mapping screens in Acumatica. Both screens are described in detail below.
IMPORTANT: To avoid any issues, be sure to complete the steps described in this section as part of the installation process.
ShipHawk Setup Screen
This section describes how to configure the ShipHawk Setup screen in Acumatica, and provides definitions for each of the fields in the screen. This screen contains settings you can modify to alter the way ShipHawk processes orders from Acumatica. You can also use this screen to test the connection between both solutions.
...
If your ShipHawk package was installed correctly, an icon for the ShipHawk application will appear on the More Items menu.
The icon may also appear below the More Items menu, depending on your display size.
Navigate to the ShipHawk Setup Screen by clicking More Items > ShipHawk > Setup Screens > ShipHawk Setup.
You can modify the different fields in the ShipHawk Setup screen to better align with your organization’s needs. The fields on this screen are defined in the table below:
ShipHawk Setup Screen
...
Field Definitions
IMPORTANT: Entering the API URL and API Key is required during the installation process. If you do not enter this information, the integration can stop working until those fields are populated.
This screen includes fields for SHIPHAWK SETUP, PURGE LOG DETAILS, and IMPORT SHIPMENTS SETTINGS.
...
Allow Delete Sales Order/Shipment | If this field is enabled it means that a user can delete the sales orders that are already synced from Acumatica to ShipHawk, and can also delete shipments in the ShipHawk portal. |
Syncing Entity | This drop-down allows you to select whether an order, shipment, or other entity is being synced to ShipHawk at any given time. You can return to this field and manually change the syncing option based on your business requirements at the time. |
Days To Keep | Users can provide a number of days in the field to keep day logs in the ShipHawk Log Details screen. For instance, if a user enters the number 7, that means log details are purged every 7 days (or once a week). |
API URL & API Key | Users retrieve this information from the ShipHawk platform connected to their Acumatica instance. The API key is used to test the connection between ShipHawk and Acumatica. This process is described in the following section. |
Update Freight Cost and Freight Price Fields | Select this option to have ShipHawk write back the freight cost and freight price data to Acumatica. |
Update Control Quantity Field | Select this option to have ShipHawk write back the control quantity data to Acumatica. |
To have ShipHawk write back the freight cost, freight price, and controlled quantity data to Acumatica, be sure to select the Update Freight Cost and Freight Price Fields option and the Update Control Quantity Field option.
...
Log in to your ShipHawk Platform.
On the right side of ShipHawk’s top menu bar, click on the Settings
icon and select the Settings option from the dropdown below. The Settings screen appears.From the left-hand side menu, select the Developer API option under Integrations. The API Keys screen will appear.
Your API Key should appear in a card on the screen. You can click the Copy button to the right of the key to copy the API Key to your clipboard. The URL will also be displayed under the key.
Navigate back to the ShipHawk Setup screen in Acumatica.
Paste the API Key & API Url details you copied from the API Keys screen in the ShipHawk platform to their respective fields in Acumatica.
.
IMPORTANT: Entering the API URL and API Key is required during the installation process. If you do not enter this information, the integration can stop working until those fields are populated.Click the Test Connection button located in the form toolbar. If your connection is successful a green checkmark will appear to the right of this button.
ShipHawk Mapping Screen
...
Navigate to the ShipHawk Mapping Screen by clicking More Items >ShipHawk > SetupScreens > ShipHawkMapping.
The ShipHawk Mapping screen will appear. The screen contains a grid that specifies which fields in ShipHawk map to which fields in Acumatica.
Click on the Mapping Entity drop-down at the top of the grid. Select whether you would like to modify the Order or Shipment mapped fields.
The grid will populate with the default field mappings of the entity you selected. To alter the default field mapping configuration, you must manually alter the fields in the grid.
The ShipHawk Object and ShipHawk Field columns will appear as read-only, meaning they cannot be modified. You can still alter field mappings by modifying fields under the Acumatica View Name and Acumatica Field columns in the grid.
Double-click a record under the Acumatica View Name or Acumatica Field column to alter it. A drop-down menu will appear prompting you to make a different selection.
For example, if you want to alter the Acumatica Field that maps back to the ShipHawk Field ‘phone_number’:
Locate the row the ShipHawk field is in.
Double-click the Acumatica Field that corresponds to the ShipHawk Field ‘phone_number’, which would be Phone1.
Make a different selection from the drop down.
Repeat this process for other fields in Acumatica you wish to change.
If you made any changes to the grid, you can click the Save icon in the form toolbar to save them.
You have configured the Setup Screens in Acumatica to better align with your organization’s shipping process.
...
Before you begin creating sales orders, ensure the Syncing Entity field in the ShipHawk Setup screen is set to Order.
Navigate to the Sales Order screen. From the menu, click Sales Orders > New Sales Order. A blank sales order form will appear.
In the Sales Order page, Enter an order number in the Order No: field. You can use the lookup icon in the field to select an existing order that has not yet been shipped.
In the Line Details tab, verify there are multiple stock items associated with the sales order.
You can use the Add Items button at the top of the grid to add stock items if the Line Details grid is empty.
Click the Save icon in the header to save your sales order.
After you have successfully saved your sales order with multiple stock items, you must create a shipment.Click the Create Shipment button on the form toolbar of the Sales Order page. Verify the details in the Specify Shipment Parameters pop-up window. You will be redirected to the Shipments screen.
Verify that the ShipHawk Shipment Details section is completely blank by default.
Click on the ShipHawk Actions button in the header. Select ‘Export to ShipHawk’ from the drop-down.
...
Log in to your ShipHawk account. Confirm the account you are using is the same account that is linked to Acumatica.
Click the Orders button in the top menu bar. This will bring you to the Orders page.
If your shipment was exported successfully, your shipment number should appear as an Order number on the Orders page.
You can verify this by entering the order number from the Acumatica Sales Order page into the search box on the ShipHawk Orders page.
Click on the Order #.
In the expanded Order page, verify the details of your shipment populated correctly:
Stock item details
Warehouse
Shipping address
Product dimensions
You can click on the Print Labels button in the Order Details page to generate the labels associated with your order.
Click Ship. Your Order details page will be updated after you opt to ship your order.
Click on the Shipment number, located on the title card under the Order number. This will redirect you to the Shipment page.
In the Shipment page, locate the Status field.
Set the Shipment status to Confirmed.
...