For sending information to ShipHawk, the following requirements must be met:
1. Shipments must be synced to ShipHawk
When a shipment is ready to be packed and/or shipped in ShipHawk, the shipment must be synced over to ShipHawk. Only the object related to the actual shipment needs to be synced.
For example, in NetSuite there are Sales Order objects, and each Sales Order may have multiple Item Fulfillment records which represent the pick task and shipment.
This sync must take into account the mappings that have been configured by the administrator.
Order sync must be able to recover in the case of order sync failing
For example, if a shipment sync (or any request to the ShipHawk API) failed:
Save detailed information to logs that can be accessed by an administrator
Ensure there is a system that will try sending the record again after some time
If fails constantly (10 attempts over 5 hours with exponential delay), mark the order/fulfillment as failed to sync.
Allow the user to manually sync an order to ShipHawk by clicking a button
Serial/lot numbers must be synced with ShipHawk
The serial/lot numbers available for packing/ shipping must be synced with ShipHawk as part of order sync so that they can be verified in ShipHawk.
Order sync uses the ___ endpoint. Please refer to the order sync documentation for information on various JSON objects . The following fields are required:
The order_number of the object being shipped.
Origin address block, with the warehouse code field populated.
The warehouse code is an ID that is set in ShipHawk to differentiate warehouses. The order creation request should include a warehouse ID that corresponds to a warehouse inputted in ShipHawk:
The destination address block
The items being shipped, in the order_line_items block:
Required:
sku
name
description
qty
item weight
ShipHawk specific Smartpacking information:
item_type (parcel, handling_unit, unpacked)
type_of_item (loose, box, pallet)
do_not_pack_with_other_items (boolean)
do_not_palletize (boolean)
do_not_pack_before_palletize (boolean)
If available:
item dimensions (length, width, height)
item value
UPC
LTL information, such as:
freight_class
nmfc
commodity_description
International information, such as:
hs_code
country of origin
inventory_identifiers: this is used to send serial/lot numbers from the ERP to ShipHawk. Each serial number/ lot number available for the line item must be sent here.
In ShipHawk, users may scan serial numbers to add them to the shipment. ShipHawk needs a list of serial numbers for the line item to be able to verify that the serial number scanned is available for packing/shipping in the ERP.
After the shipment has been booked, ShipHawk will return which serial/lot numbers were used for each item shipped.
order status
order level reference_numbers, as mapped by the administrator
billing_details, if mapped by the administrator
Note: If the bill_to field is not populated by the mapping, then the field should default to ‘sender’