Versions Compared

Key

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

...

Use webhooks if possible. Otherwise, scheduled jobs should minimize unnecessary usage and potential API charges. If going this route, the connector should be a good steward of the ShipHawk API, limiting the number of calls made to ShipHawk.

...

Example: The syncing entity or fulfillment record in the Source will usually need to be updated with the following information at a minimum:

  • "carrier": "USPS",

  • "service_name": "Priority Mail",

  • "total_price": 7.17, // the shipping cost to write back to [ERP/Source]

  • "tracking_number": "9405510200864427693834",

  • “shid”: 368765 // the related Shiphawk Shipment ID

When fetching shipment data, you can use GET /orders/:id to accomplish this. Shipment details are provided in the “shipments” node in the order response object.

 For more information on setting up webhooks, see Setting New Webhook in ShipHawk .