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.
...
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.
...
To test your connection using your API Key
Log in to your ShipHawk PlatformTMS 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 From the main menu, choose ⚙️ > Settings > Developer API.
Get the API URL: On the Developer API screen, the field Use this URL for all API integrations provides the API URL.
Get the API Key: To create a new API key, click CREATE API KEY. In the pop-up, enter a descriptive name for the API key.
In Acumatica, go to the ShipHawk Setup screen.
Paste the API URL and API Key details you copied from the ShipHawk TMS platform to their respective fields in Acumatica.
| Note |
|---|
...
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
...
.
If your connection is successful, you will get the following message:
Finally, on the Acumatica ShipHawk Setup screen, in WEBHOOK INTEGRATIONS, click CREATE WEBHOOK.
ShipHawk Mapping Screen
Field mapping allows ShipHawk to extract data from specific Acumatica fields back to the ShipHawk platform. When the ShipHawk application is installed to your instance of Acumatica, this process is done automatically. However, you can use the ShipHawk Mapping screen to manually alter which fields in Acumatic map back to which specific fields in ShipHawk. This section describes how to override native field mappings using the ShipHawk Mapping screen.
...