Versions Compared

Old Version 6

changes.mady.by.user jonathan.day

Saved on

compared with

New Version Current

changes.mady.by.user louise.stivers

Saved on

Key

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

For sending information to ShipHawk, the following requirements must be met:

Table of Contents
minLevel1
maxLevel6
outlinefalse
stylenone
typelist
printablefalse

1. Shipments must be synced to ShipHawk

When a shipment is ready to be packed and/or shipped in ShipHawk TMS, the shipment must be synced over to ShipHawk TMS. Only the object related to the actual shipment needs to be synced. 

  1. 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. 

  2. This sync must take into account the mappings that have been configured by the administrator. 

  3. Order sync must be able to recover in the case of order sync failing

    1. 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.

  4. Allow the user to manually sync an order to ShipHawk TMS by clicking a button

  5. Serial/lot numbers must be synced with ShipHawk TMS

    1. The serial/lot numbers available for packing/ shipping must be synced with ShipHawk TMS as part of order sync so that they can be verified in ShipHawk TMS. 


...

The user must be able to scan a serial/lot number into ShipHawk

...

ShipHawk must have a list of serial/lot numbers in stock for that SKU, and be able to verify the serial number scanned. 

...

Expand
titleTechnical details

Order sync uses the ___ endpoint. Please refer to the order sync endpoint 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 TMS to differentiate warehouses. The order creation request should include a warehouse ID that corresponds to a warehouse inputted in ShipHawk TMS:

  • The destination address block

  • The items being shipped, in the order_line_items block:

    • Required:

      • sku

      • name

      • description

      • qty

      • item weight

      • ShipHawk TMS 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

      • order line item reference number mappings (as mapped)

      • 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 TMS. Each serial number/ lot number available for the line item must be sent here.

        • In ShipHawk TMS, users may scan serial numbers to add them to the shipment. ShipHawk TMS 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 TMS 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’

  • requested_rate_id, for cases where the user rates the shipment. See #2 below.

...

Prior to fulfillment, users must be able to rate the order in the ERP with ShipHawk by clicking a button. Upon clicking this button, the connector must send a rating request to shiphawk, receive rates from ShipHawk, and display them in a dropdown menu. If a rate is selected, it is to be applied to the ‘ship method’ field. 

  1. In our other integrations, this rating exists at the Sales Order level, and not at the shipment level object. 

  2. Not all customers will use this, but it is important for some B2B use cases. 

The serial/lot numbers available for packing/ shipping must be synced with ShipHawk so that they can be verified in ShipHawk.