...
In almost all cases, you will want to have ShipHawk sync with the ERP object that represents what’s ready to be fulfilled to create the order object in ShipHawk, to ensure you only fulfill the items that are ready (and in inventory) to be shipped.
Integration
...
Planning
The following is a high-level summary of integration stepstopics you should consider when planning an ERP integration with ShipHawk.
...
Map out your integration plan
As you think about building your integration, you will need to consider the following:
Installing/uninstalling the App that connects ShipHawk and the ERP/Source
Managing settings like authentication and syncing entities
Managing Order and Line Item field mappings
Creating Orders in ShipHawk
Updating the ERP/Source with shipment details from their ShipHawk
Log all interactions with ShipHawk APIs
...
Get Your ShipHawk API Key
Obtain your developer API Key in ShipHawk. In your ShipHawk account, set this up through Settings > Settings > Developer API > Create API Key. If you do not yet have a ShipHawk license, schedule a call with a member of our team to learn more.
Setup at least one Carrier Account in ShipHawk. FedEx or UPS is recommended. In your ShipHawk account, set this up through Settings > Carriers > Select Carrier. You will need this for testing later.
...
Review Settings and
...
Field Mapping Requirements
Your application will need to store the ShipHawk API Key and should consider supporting multiple environments, future API versions and enhancements, like:
...
In addition to field mappings, you will want to code source_system as the “[ERP/Source Name]” and source_system_domain as a unique identifier for each [ERP/Source] account. This makes it easy to know which system is being interacted with and can display this information inside ShipHawk.
...
Plan Process for Syncing ERP to ShipHawk
Create a process for sending the syncing entity object information as Orders to ShipHawk. This is usually done by a scheduled job (e.g. every 5-15 minutes) for all transactions that have a certain status or value prior to being available to sync to and have not already been sent to ShipHawk.
...
Plan How To Update ERP with Shipment
...
Data from ShipHawk
The recommended method for writing shipment data back to the Source is to setup and subscribe to ShipHawk Webhooks. Instead of creating scheduled jobs, you can improve performance by setting up a Webhook, subscribing to the shipment.create_from_order event and specifying a callback URL of your choice.
...