Versions Compared

Key

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

...

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 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:

  • 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

...

and the rate_id should be synced over to ShipHawk. Not all customers will use this, but it is important for some B2B use cases. In our other integrations, this rating exists at the Sales Order level, and not at the shipment level object. 

...

Expand
titleTechnical details

Here is what rating looks like in Netsuite:

Image Added

Here is what rating looks like in Acumatica:

In order to rate in ShipHawk, the rates endpoint must be used.

The following fields are required:

  • Apply rules: true

  • Any origin or destination accessorials

  • ~most fields from the shipment sync above~ (to be copied over later)

3. Serial/lot numbers must be synced with ShipHawk

...