Versions Compared

Old Version 26

changes.mady.by.user Michael Stivers

Saved on

compared with

New Version 27

changes.mady.by.user Michael Stivers

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Term

Definition

Source

The system you are integrating ShipHawk with (typically an ERP system).

App

The name of the solution that contains the code that enables integration and interaction between Source and ShipHawk. 

“Connector” or “Plug-in” may be used interchangeably with App.

Order

In ShipHawk, an Order is the object in ShipHawk that represents an order that is ready for shipment.

Shipment

In ShipHawk a Shipment is the object that represents a shipment. 

Proposed Shipment

A Proposed Shipment is an object in ShipHawk that represents the intermediate state between an Order and a Shipment.
A Proposed Shipment contains the details about how certain items from an Order should be shipped. 
ShipHawk generates Proposed Shipments asynchronously as Orders are created in ShipHawk.
A Proposed Shipment is a mutable object that the warehouse team interacts with during fulfillment. 
In contrast, a Shipment (and its package details) is not editable once created: a Shipment can only progress to a status of ‘delivered’ or ‘cancelled’.

Warehouse 

In ShipHawk, the object that represents the location used to fulfill an Order.

Merchant

The business enterprise using ShipHawk for its fulfillment process, such as an eCommerce company. 

Customer

The Merchant’s customer: a buyer, consumer, or recipient the items being shipped.

Understanding Orders in ShipHawk

In ShipHawk, Orders represent one or more items/SKUs that are ready to be fulfilled (ready to be shipped).

...

Note

You should 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 specific items that are ready (and in inventory) to be shipped.

Integration Checklist

For developers, a high-level checklist of all working parts required for an ERP integration with ShipHawk includes the following:

✅ Sync’ing of the ERP objects for shipment (e.g., item fulfillment or shipment objects) to ShipHawk Orders using an API request.

✅ Sync’ing of ShipHawk shipments to the ERP shipment objects (e.g., item fulfillment or shipment objects) using webhooks or by pulling data from the ShipHawk API.

✅ Rating of ERP sales orders (send rating information from ShipHawk into the ERP).

✅ Providing an integration configuration screen on the ERP user interface, including the API configuration settings, ERP to ShipHawk field mappings, logging, and other settings as needed.

Integration Planning

The following is a high-level summary of topics you should consider when planning an ERP integration with ShipHawk.

...