Versions Compared

Key

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

...

Table of Contents
minLevel1
maxLevel6
outlinefalse
typelist
printablefalse

ShipHawk Terminology

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

...

It’s important to understand what Orders in ShipHawk are, and to understand how the ERP you’re working with identifies what’s ready for fulfillment.

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

In many ERPs, the concept of what’s been purchased is separate distinct from the concept of what’s ready to be fulfilled.  For example, NetSuite has Sales Orders (what’s been purchased), and then Item Fulfillments (what’s ready to be fulfilled).  While the Sales Order contains all of the items purchased, the Item Fulfillment contains only the particular items that are ready to be fulfilled at a particular time.  Similarly, the Acumatica ERP has Sales Orders (what’s been purchased), and then Shipments (what’s ready to be fulfilled). ERPs typically use the term “sales orders” for what has been purchased by a customer, but different ERPs can have varying terms for what’s ready to be fulfilled for a given sales order.

✔️ 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.

...