StarShipIT sends webhook requests when relevant updates from the courier occurs for your shipments to the notification endpoint URL.
You can use the notification endpoint URL to receive our webhook data and trigger a certain event in your own application.
E.g. Send an order update email to your customer or update the order status in your database when 'OutForDelivery' tracking status is received.
The notification endpoint URL needs to be built to accept the POST request that returns HTTP 200 OK response and the URL can be set in Settings > Customer Notifications
Webhook JSON Data Definitions:
|order_number||string||The identifier of the order pulled from source e-Commerce platform|
|carrier_name||string||Name of the courier used for shipment delivery|
|carrier_service||string||Courier product service used for shipment delivery|
|shipment_date||datetime||The date when the label was generated for the shipment|
|tracking_number||string||Courier tracking number|
|tracking_status||string||Last tracking status from the courier|
|last_updated_date||datetime||Last tracking updated date from the courier|
Webhook POST Data Example: