Track Shipment
Introduction
This API is responsible for tracking the shipment status for a particular Waybill and Courier partner Id.
cURL
curl --location 'https://api-preproduction.signzy.app/api/v3/underwriting/track-shipment' \
--header 'Authorization: <Auth Token>' \
--header 'Content-Type: application/json' \
--data '{
"wayBill": "<Waybill>",
"courierPartnerId": <Courier Partner Id>
}'Request Headers
Key | Value |
|---|---|
Authorization | shared by Signzy |
Content-type | application/json |
Request Body
{
"wayBill": "RM973467646IN",
"courierPartnerId": 1001
}PARAMETERS | DESCRIPTION | TYPE | VALUE (COMPULSORY OR OPTIONAL) |
|---|---|---|---|
wayBill | The tracking number for the shipment | String | COMPULSORY |
courierPartnerId | The Id of the Courier Partner | Number | COMPULSORY |
Response Data
{
"meta": {
"status": 200,
"success": true,
"message": "SUCCESS"
},
"result": {
"RM973467646IN": {
"latestStatus": {
"timeStamp": "2023-11-17 16:14:56",
"location": "",
"remarks": "MANUAL UPDATE - PICKEDUP",
"status": "Receive item from customer (Otb)",
"statusCode": 4,
"statusDescripttion": "PickedUp",
"statusBucket": 2,
"statusbucketDescription": "Shipped"
},
"scans": [
{
"timeStamp": "2023-11-17 16:14:56",
"location": "",
"remarks": "MANUAL UPDATE - PICKEDUP",
"status": "Receive item from customer (Otb)",
"statusCode": 4,
"statusDescripttion": "PickedUp",
"statusBucket": 2,
"statusbucketDescription": "Shipped"
},
{
"timeStamp": "2023-08-24 17:53:36",
"location": "Chinchwad East S.O",
"remarks": "Item Delivered(Addressee) ",
"status": "Item Delivered",
"statusCode": 8,
"statusDescripttion": "Delivered",
"statusBucket": 6,
"statusbucketDescription": "Delivered"
},
{
"timeStamp": "2023-08-24 09:49:18",
"location": "Chinchwad East S.O (Beat Number:6)",
"remarks": "Item Delivered [To: sector 16 (Addressee) ]",
"status": "Item Delivered",
"statusCode": 8,
"statusDescripttion": "Delivered",
"statusBucket": 6,
"statusbucketDescription": "Delivered"
},
{
"timeStamp": "2023-08-24 09:43:36",
"location": "Chinchwad East S.O",
"remarks": "Out for Delivery ",
"status": "Out for Delivery ",
"statusCode": 6,
"statusDescripttion": "OutForDelivery",
"statusBucket": 4,
"statusbucketDescription": "Out for delivery"
},
{
"timeStamp": "2023-08-23 21:00:37",
"location": "Pune CRC L1R",
"remarks": "Item Received ",
"status": "Item Received ",
"statusCode": 5,
"statusDescripttion": "InTransit",
"statusBucket": 3,
"statusbucketDescription": "In transit"
},
{
"timeStamp": "2023-08-23 16:40:21",
"location": "Chinchwadgaon S.O",
"remarks": "Item Dispatched ",
"status": "Item Dispatched ",
"statusCode": 5,
"statusDescripttion": "InTransit",
"statusBucket": 3,
"statusbucketDescription": "In transit"
},
{
"timeStamp": "2023-08-23 15:29:00",
"location": "Chinchwadgaon S.O",
"remarks": "Item Bagged ",
"status": "Item Bagged ",
"statusCode": 5,
"statusDescripttion": "InTransit",
"statusBucket": 3,
"statusbucketDescription": "In transit"
},
{
"timeStamp": "2023-08-23 12:56:16",
"location": "Chinchwadgaon S.O",
"remarks": "Item Redirected to Chinchwad East S.O Insufficient Address",
"status": "Item Redirected Insufficient Address",
"statusCode": 18,
"statusDescripttion": "ShipmentDelayed",
"statusBucket": 3,
"statusbucketDescription": "In transit"
},
{
"timeStamp": "2023-08-22 09:33:45",
"location": "Chinchwadgaon S.O",
"remarks": "Item Received ",
"status": "Item Received ",
"statusCode": 5,
"statusDescripttion": "InTransit",
"statusBucket": 3,
"statusbucketDescription": "In transit"
},
{
"timeStamp": "2023-08-21 06:18:07",
"location": "Pune TSO TMO",
"remarks": "Item Dispatched ",
"status": "Item Dispatched ",
"statusCode": 5,
"statusDescripttion": "InTransit",
"statusBucket": 3,
"statusbucketDescription": "In transit"
},
{
"timeStamp": "2023-08-21 05:13:30",
"location": "Pune TSO TMO",
"remarks": "Item Received ",
"status": "Item Received ",
"statusCode": 5,
"statusDescripttion": "InTransit",
"statusBucket": 3,
"statusbucketDescription": "In transit"
},
{
"timeStamp": "2023-08-21 03:32:45",
"location": "Pune CRC L1R",
"remarks": "Item Dispatched ",
"status": "Item Dispatched ",
"statusCode": 5,
"statusDescripttion": "InTransit",
"statusBucket": 3,
"statusbucketDescription": "In transit"
},
{
"timeStamp": "2023-08-21 00:58:00",
"location": "Pune CRC L1R",
"remarks": "Item Bagged ",
"status": "Item Bagged ",
"statusCode": 5,
"statusDescripttion": "InTransit",
"statusBucket": 3,
"statusbucketDescription": "In transit"
},
{
"timeStamp": "2023-08-20 19:46:34",
"location": "Pune CRC L1R",
"remarks": "Item Received ",
"status": "Item Received ",
"statusCode": 5,
"statusDescripttion": "InTransit",
"statusBucket": 3,
"statusbucketDescription": "In transit"
},
{
"timeStamp": "2023-08-20 14:46:46",
"location": "Pune RS TMO",
"remarks": "Item Dispatched ",
"status": "Item Dispatched ",
"statusCode": 5,
"statusDescripttion": "InTransit",
"statusBucket": 3,
"statusbucketDescription": "In transit"
},
{
"timeStamp": "2023-08-20 14:20:57",
"location": "Pune RS TMO",
"remarks": "Item Received ",
"status": "Item Received ",
"statusCode": 5,
"statusDescripttion": "InTransit",
"statusBucket": 3,
"statusbucketDescription": "In transit"
},
{
"timeStamp": "2023-08-20 04:59:53",
"location": "BCRC DADAR",
"remarks": "Item Dispatched ",
"status": "Item Dispatched ",
"statusCode": 5,
"statusDescripttion": "InTransit",
"statusBucket": 3,
"statusbucketDescription": "In transit"
},
{
"timeStamp": "2023-08-20 03:32:17",
"location": "BCRC DADAR",
"remarks": "Item Bagged ",
"status": "Item Bagged ",
"statusCode": 5,
"statusDescripttion": "InTransit",
"statusBucket": 3,
"statusbucketDescription": "In transit"
}
],
"valid": true,
"additional": {
"isStuck": true,
"orderId": null,
"edd": {
"minSla": null,
"maxSla": null,
"exactSla": null
},
"pickupCity": null,
"dropCity": null,
"courierpartnerEdd": null,
"channelName": null,
"nonDeliveryReport": {},
"courierPartnerId": 1001,
"courierName": "IndiaPost"
}
}
}
}PARAMETERS | DESCRIPTION | TYPE | VALUE (COMPULSORY OR OPTIONAL) |
|---|---|---|---|
meta.status | This is an unique 13 character long alphanumeric string created during successful | String | COMPULSORY |
meta.message | Denotes the message (including errors) | String | COMPULSORY |
meta.success | Whether the request is successful or not | Boolean | COMPULSORY |
result<WB>.latestStatus | Status object representing the last recorded status of the shipment | Object | COMPULSORY |
result<WB>.scans | List of status objects, each denoting one scan of the status of the shipment | List[Object] | COMPULSORY |
result<WB>.valid | Whether the wayBill provided is valid or not | Boolean | COMPULSORY |
result<WB>.additional | An object encapsulating additional details of the shipment | Object | COMPULSORY |
NOTE: Above fields are Compulsory during 200 OK Response.
Sample Status Codes And Messages
{
"error": {
"reason": "VALIDATION_ERROR",
"status": 400,
"message": "\"wayBill\" must be a string",
"type": "Bad Request",
"statusCode": 400,
"name": "error"
}
}
1. 'wayBill' is required
2. 'wayBill' must be a string
3. 'wayBill" is not allowed to be empty'
4. 'courierPartnerId' must be a number