Configuration and Administration Requirements

In a ShipHawk - ERP integration, an administrator must be able to do the following:

1. Ease of integration

An administrator must be able to easily set up the integration between the order source (ERP) and ShipHawk.

1. A developer should not be required in order to set up the integration.

2. If any tasks are needed, they must be fully documented as part of the integration.

3. Additionally, the administrator must be able to change their ShipHawk API key and ShipHawk hostname when needed.

 Examples

Here is a screenshot of part of the ShipHawk settings page on Netsuite:

Here is a screen of one of the ShipHawk configuration pages in Acumatica:

2. Mappings Configuration

An administrator must be able to set up mappings to the following:

1. Order reference number mappings. Reference numbers in ShipHawk are used to bring custom data into ShipHawk for use on shipping documentation or on the ShipHawk Rules Engine. An administrator must be able to map at least 30 fields in the syncing entity (the ERP) to reference numbers in ShipHawk.

 Examples

Here are the Order Reference number mapping settings as in the Netsuite connector:

Here is the order reference number mapping page in Acumatica:

2. Order field mappings. Order fields in ShipHawk are values that exist at the order level. Typically, this information can be stored in different places on the object being synced to ShipHawk. Order mappings can include a wide range of different fields in the ShipHawk order object, but the most important ones include:

   1. Billing details (third party billing, collect billing, and so on)

   2. Pickup and delivery instructions (for LTL)

   3. Alternate return address mappings

 Examples

Here is what the order field mapping look like in Netsuite:

Here is what order field mappings look like in Acumatica:

3. Line item field mappings. In some cases, line item fields are configured differently than the default.

 Examples

Here is what line item field mappings look like in Netsuite:

Here is where line item fields are mapped in Acumatica:

4. Line item reference number mappings.
   

 Examples

Here is what line item reference number mappings look like in Netsuite:

Here is where line item reference number are mapped in Acumatica:

5. Shipping method mappings. An administrator must have a way to map ShipHawk’s shipping methods to the shipping methods that are saved in the ERP.
   Example: If the ERP has a service called FedEx Ground, that service needs to be mapped to ShipHawk’s FedEx Ground service.

 Examples

Here is where shipment method mappings are configured in Netsuite:

Here is where shipping method mappings are configured in Acumatica:

3. Webhook Configuration

An administrator must be able to configure webhooks to receive information from ShipHawk (see Receiving Information from ShipHawk Requirements ).

4. Logs for Testing and Debugging

An administrator must be able to view logs of requests/responses to and from ShipHawk API and how they were processed by an ERP for testing and debugging purposes.

Additionally, an administrator must be able to set up the automatic cleanup (deletion) of logs after a specified number of days/weeks to mange space usage. Access to at least 2 weeks of logs is required; access to 4 weeks is recommended.

Ideally, an administrator should be able to enable/disable debug mode in general. If enabled: log full requests/responses; if disabled: log only facts of events that happened, without full details.