ShiprocketAPI

Webhooks

You can set up a webhook with Shiprocket to get tracking updates. We will proactively notify your system whenever there is a new tracking event for an order.

Setup:

  • Log in to your Shiprocket account

  • Go to Settings > API > Webhooks

  • Add the webhook URL

  • Enable the toggle

  • Add the security token (not mandatory)

When we get a new tracking event, a POST request is made to the callback URL you added to your Shiprocket account.

Webhook Specifications:

  • Method: POST

  • The Content-Type header should be set to application/json

  • Please do not use keywords like shiprocket, kartrocket, sr, or kr in your webhook URL

  • Security token should be anx-api-key

  • The URL should be set to send only code 200 in response.

Sample Body:

json
{
   "awb":"19041424751540",
   "courier_name":"Delhivery Surface",
   "current_status":"IN TRANSIT",
   "current_status_id":20,
   "shipment_status":"IN TRANSIT",
   "shipment_status_id":18,
   "current_timestamp":"23 05 2023 11:43:52",
   "order_id":"1373900_150876814",
   "sr_order_id":348456385,
   "awb_assigned_date":"2023-05-19 11:59:16",
   "pickup_scheduled_date":"2023-05-19 11:59:17",
   "etd":"2023-05-23 15:40:19",
   "scans":[
      {
         "date":"2023-05-19 11:59:16",
         "status":"X-UCI",
         "activity":"Manifested - Manifest uploaded",
         "location":"Chomu_SamodRd_D (Rajasthan)",
         "sr-status":"5",
         "sr-status-label":"MANIFEST GENERATED"
      },
      {
         "date":"2023-05-19 15:32:17",
         "status":"X-PPOM",
         "activity":"In Transit - Shipment picked up",
         "location":"Chomu_SamodRd_D (Rajasthan)",
         "sr-status":"42",
         "sr-status-label":"PICKED UP"
      },
      {
         "date":"2023-05-19 16:40:19",
         "status":"X-PIOM",
         "activity":"In Transit - Shipment Recieved at Origin Center",
         "location":"Chomu_SamodRd_D (Rajasthan)",
         "sr-status":"6",
         "sr-status-label":"SHIPPED"
      },
      {
         "date":"2023-05-19 17:19:14",
         "status":"X-DBL1F",
         "activity":"In Transit - Added to Bag",
         "location":"Chomu_SamodRd_D (Rajasthan)",
         "sr-status":"NA",
         "sr-status-label":"NA"
      },
      {
         "date":"2023-05-20 10:27:56",
         "status":"X-DLL2F",
         "activity":"In Transit - Bag Added To Trip",
         "location":"Chomu_SamodRd_D (Rajasthan)",
         "sr-status":"18",
         "sr-status-label":"IN TRANSIT"
      },
      {
         "date":"2023-05-20 12:23:44",
         "status":"X-ILL2F",
         "activity":"In Transit - Trip Arrived",
         "location":"Jaipur_Sez_GW (Rajasthan)",
         "sr-status":"18",
         "sr-status-label":"IN TRANSIT"
      },
      {
         "date":"2023-05-20 14:24:50",
         "status":"X-ILL1F",
         "activity":"In Transit - Bag Received at Facility",
         "location":"Jaipur_Sez_GW (Rajasthan)",
         "sr-status":"18",
         "sr-status-label":"IN TRANSIT"
      },
      {
         "date":"2023-05-20 15:23:38",
         "status":"X-IBD3F",
         "activity":"In Transit - Shipment Received at Facility",
         "location":"Jaipur_Sez_GW (Rajasthan)",
         "sr-status":"18",
         "sr-status-label":"IN TRANSIT"
      },
      {
         "date":"2023-05-20 15:23:38",
         "status":"X-DWS",
         "activity":"In Transit - System weight captured",
         "location":"Jaipur_Sez_GW (Rajasthan)",
         "sr-status":"NA",
         "sr-status-label":"NA"
      },
      {
         "date":"2023-05-20 16:01:22",
         "status":"X-DBL1F",
         "activity":"In Transit - Added to Bag",
         "location":"Jaipur_Sez_GW (Rajasthan)",
         "sr-status":"NA",
         "sr-status-label":"NA"
      },
      {
         "date":"2023-05-21 09:50:45",
         "status":"X-DLL2F",
         "activity":"In Transit - Bag Added To Trip",
         "location":"Jaipur_Sez_GW (Rajasthan)",
         "sr-status":"18",
         "sr-status-label":"IN TRANSIT"
      },
      {
         "date":"2023-05-22 22:01:12",
         "status":"X-ILL2F",
         "activity":"In Transit - Trip Arrived",
         "location":"Bhiwandi_Mega_GW (Maharashtra)",
         "sr-status":"18",
         "sr-status-label":"IN TRANSIT"
      },
      {
         "date":"2023-05-23 02:55:34",
         "status":"X-ILL1F",
         "activity":"In Transit - Bag Received at Facility",
         "location":"Bhiwandi_Mega_GW (Maharashtra)",
         "sr-status":"18",
         "sr-status-label":"IN TRANSIT"
      },
      {
         "date":"2023-05-23 07:38:08",
         "status":"X-DLL2F",
         "activity":"In Transit - Bag Added To Trip",
         "location":"Bhiwandi_Mega_GW (Maharashtra)",
         "sr-status":"18",
         "sr-status-label":"IN TRANSIT"
      },
      {
         "date":"2023-05-23 09:48:27",
         "status":"X-ILL2F",
         "activity":"In Transit - Trip Arrived",
         "location":"Mumbai_MiraRdIndEstate_I (Maharashtra)",
         "sr-status":"18",
         "sr-status-label":"IN TRANSIT"
      },
      {
         "date":"2023-05-23 10:14:27",
         "status":"X-ILL1F",
         "activity":"In Transit - Bag Received at Facility",
         "location":"Mumbai_MiraRdIndEstate_I (Maharashtra)",
         "sr-status":"18",
         "sr-status-label":"IN TRANSIT"
      },
      {
         "location":"Mumbai_MiraRdIndEstate_I (Maharashtra)",
         "date":"2023-05-23 11:43:46",
         "activity":"In Transit - Shipment Received at Facility",
         "status":"X-IBD3F",
         "sr-status":"18",
         "sr-status-label":"IN TRANSIT"
      }
   ],
   "is_return":0,
   "channel_id":3422553,
   "pod_status":"OTP Based Delivery",
   "pod":"Not Available"
}