...
Create a process for sending the syncing entity object information as Orders to ShipHawk. This is usually done by a scheduled job (e.g. every 5-15 minutes) for all transactions that have a certain status or value prior to being available to sync to and have not already been sent to ShipHawk.
If the POST to Orders is successfully created in ShipHawk, the connector should:
Record that the shipment has been sent to ShipHawk with a date/time stamp
Record the successfully created order_id from ShipHawk in [ERP/Source]
If the POST to Orders is NOT successful, the connector should:
Log failures including error messages provide by ShipHawk
Provide a method for the Merchant to manually retrigger a sync
When POSTing Orders to ShipHawk, remember, the payload MUST include the Warehouse Codes for each Location the order or shipment is shipping from so that the correct warehouse fulfills it in ShipHawk. We expect the customer will add the Warehouse Code from ShipHawk to location in [ERP/Source] so that the Warehouse Code can be sent to ShipHawk with the Order or Order Line Item Warehouse Code reference. This is critical to ensure that the order is fulfilled from the right Warehouse location, and remember to pass warehouse code at both Order and Order Line Item level:
Order level looks like: "warehouse": {"code": "CA_Warehouse"}
Order line item looks like : "warehouse_code": “CA_Warehouse”
Standard Order fields usually include: order number, warehouse code, destination address (the recipient), billing_address (the person billed for the order, almost always the same as recipient, unless it is a gift order), total price, items, shipping price, source system id
Full list: https://docs.shiphawk.com/#order-object
Standard Order Line Items usually include: name, SKU, quantity, value, warehouse location, dimensions, weight, harmonization code, country of manufacture/origin, source system id
Full list: https://docs.shiphawk.com/#order-orderlineitem-object
...
When a syncing entity record is updated in the Source system, the corresponding Order in ShipHawk should also be updated (update an order).
...
Step 5. Update Source with Shipment data from ShipHawk
...