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

      • 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. 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’

3. Serial/lot numbers must be synced with ShipHawk