Shipment Tracking APIs
Track Shipment
This API is responsible for tracking the shipment status for a particular Waybill and Courier partner Id.
Production
Pre-Production
1curl --location 'https://api-preproduction.signzy.app/api/v3/underwriting/track-shipment' \
2--header 'Authorization: <Auth Token>' \
3--header 'Content-Type: application/json' \
4--data '{
5 "wayBill": "<Waybill>",
6 "courierPartnerId": <Courier Partner Id>
7}'
Key | Value |
Authorization | shared by Signzy |
Content-type | application/json |
JSON
1{
2 "wayBill": "RM973467646IN",
3 "courierPartnerId": 1001
4}
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 |
200 OK
1{
2 "meta": {
3 "status": 200,
4 "success": true,
5 "message": "SUCCESS"
6 },
7 "result": {
8 "RM973467646IN": {
9 "latestStatus": {
10 "timeStamp": "2023-11-17 16:14:56",
11 "location": "",
12 "remarks": "MANUAL UPDATE - PICKEDUP",
13 "status": "Receive item from customer (Otb)",
14 "statusCode": 4,
15 "statusDescripttion": "PickedUp",
16 "statusBucket": 2,
17 "statusbucketDescription": "Shipped"
18 },
19 "scans": [
20 {
21 "timeStamp": "2023-11-17 16:14:56",
22 "location": "",
23 "remarks": "MANUAL UPDATE - PICKEDUP",
24 "status": "Receive item from customer (Otb)",
25 "statusCode": 4,
26 "statusDescripttion": "PickedUp",
27 "statusBucket": 2,
28 "statusbucketDescription": "Shipped"
29 },
30 {
31 "timeStamp": "2023-08-24 17:53:36",
32 "location": "Chinchwad East S.O",
33 "remarks": "Item Delivered(Addressee) ",
34 "status": "Item Delivered",
35 "statusCode": 8,
36 "statusDescripttion": "Delivered",
37 "statusBucket": 6,
38 "statusbucketDescription": "Delivered"
39 },
40 {
41 "timeStamp": "2023-08-24 09:49:18",
42 "location": "Chinchwad East S.O (Beat Number:6)",
43 "remarks": "Item Delivered [To: sector 16 (Addressee) ]",
44 "status": "Item Delivered",
45 "statusCode": 8,
46 "statusDescripttion": "Delivered",
47 "statusBucket": 6,
48 "statusbucketDescription": "Delivered"
49 },
50 {
51 "timeStamp": "2023-08-24 09:43:36",
52 "location": "Chinchwad East S.O",
53 "remarks": "Out for Delivery ",
54 "status": "Out for Delivery ",
55 "statusCode": 6,
56 "statusDescripttion": "OutForDelivery",
57 "statusBucket": 4,
58 "statusbucketDescription": "Out for delivery"
59 },
60 {
61 "timeStamp": "2023-08-23 21:00:37",
62 "location": "Pune CRC L1R",
63 "remarks": "Item Received ",
64 "status": "Item Received ",
65 "statusCode": 5,
66 "statusDescripttion": "InTransit",
67 "statusBucket": 3,
68 "statusbucketDescription": "In transit"
69 },
70 {
71 "timeStamp": "2023-08-23 16:40:21",
72 "location": "Chinchwadgaon S.O",
73 "remarks": "Item Dispatched ",
74 "status": "Item Dispatched ",
75 "statusCode": 5,
76 "statusDescripttion": "InTransit",
77 "statusBucket": 3,
78 "statusbucketDescription": "In transit"
79 },
80 {
81 "timeStamp": "2023-08-23 15:29:00",
82 "location": "Chinchwadgaon S.O",
83 "remarks": "Item Bagged ",
84 "status": "Item Bagged ",
85 "statusCode": 5,
86 "statusDescripttion": "InTransit",
87 "statusBucket": 3,
88 "statusbucketDescription": "In transit"
89 },
90 {
91 "timeStamp": "2023-08-23 12:56:16",
92 "location": "Chinchwadgaon S.O",
93 "remarks": "Item Redirected to Chinchwad East S.O Insufficient Address",
94 "status": "Item Redirected Insufficient Address",
95 "statusCode": 18,
96 "statusDescripttion": "ShipmentDelayed",
97 "statusBucket": 3,
98 "statusbucketDescription": "In transit"
99 },
100 {
101 "timeStamp": "2023-08-22 09:33:45",
102 "location": "Chinchwadgaon S.O",
103 "remarks": "Item Received ",
104 "status": "Item Received ",
105 "statusCode": 5,
106 "statusDescripttion": "InTransit",
107 "statusBucket": 3,
108 "statusbucketDescription": "In transit"
109 },
110 {
111 "timeStamp": "2023-08-21 06:18:07",
112 "location": "Pune TSO TMO",
113 "remarks": "Item Dispatched ",
114 "status": "Item Dispatched ",
115 "statusCode": 5,
116 "statusDescripttion": "InTransit",
117 "statusBucket": 3,
118 "statusbucketDescription": "In transit"
119 },
120 {
121 "timeStamp": "2023-08-21 05:13:30",
122 "location": "Pune TSO TMO",
123 "remarks": "Item Received ",
124 "status": "Item Received ",
125 "statusCode": 5,
126 "statusDescripttion": "InTransit",
127 "statusBucket": 3,
128 "statusbucketDescription": "In transit"
129 },
130 {
131 "timeStamp": "2023-08-21 03:32:45",
132 "location": "Pune CRC L1R",
133 "remarks": "Item Dispatched ",
134 "status": "Item Dispatched ",
135 "statusCode": 5,
136 "statusDescripttion": "InTransit",
137 "statusBucket": 3,
138 "statusbucketDescription": "In transit"
139 },
140 {
141 "timeStamp": "2023-08-21 00:58:00",
142 "location": "Pune CRC L1R",
143 "remarks": "Item Bagged ",
144 "status": "Item Bagged ",
145 "statusCode": 5,
146 "statusDescripttion": "InTransit",
147 "statusBucket": 3,
148 "statusbucketDescription": "In transit"
149 },
150 {
151 "timeStamp": "2023-08-20 19:46:34",
152 "location": "Pune CRC L1R",
153 "remarks": "Item Received ",
154 "status": "Item Received ",
155 "statusCode": 5,
156 "statusDescripttion": "InTransit",
157 "statusBucket": 3,
158 "statusbucketDescription": "In transit"
159 },
160 {
161 "timeStamp": "2023-08-20 14:46:46",
162 "location": "Pune RS TMO",
163 "remarks": "Item Dispatched ",
164 "status": "Item Dispatched ",
165 "statusCode": 5,
166 "statusDescripttion": "InTransit",
167 "statusBucket": 3,
168 "statusbucketDescription": "In transit"
169 },
170 {
171 "timeStamp": "2023-08-20 14:20:57",
172 "location": "Pune RS TMO",
173 "remarks": "Item Received ",
174 "status": "Item Received ",
175 "statusCode": 5,
176 "statusDescripttion": "InTransit",
177 "statusBucket": 3,
178 "statusbucketDescription": "In transit"
179 },
180 {
181 "timeStamp": "2023-08-20 04:59:53",
182 "location": "BCRC DADAR",
183 "remarks": "Item Dispatched ",
184 "status": "Item Dispatched ",
185 "statusCode": 5,
186 "statusDescripttion": "InTransit",
187 "statusBucket": 3,
188 "statusbucketDescription": "In transit"
189 },
190 {
191 "timeStamp": "2023-08-20 03:32:17",
192 "location": "BCRC DADAR",
193 "remarks": "Item Bagged ",
194 "status": "Item Bagged ",
195 "statusCode": 5,
196 "statusDescripttion": "InTransit",
197 "statusBucket": 3,
198 "statusbucketDescription": "In transit"
199 }
200 ],
201 "valid": true,
202 "additional": {
203 "isStuck": true,
204 "orderId": null,
205 "edd": {
206 "minSla": null,
207 "maxSla": null,
208 "exactSla": null
209 },
210 "pickupCity": null,
211 "dropCity": null,
212 "courierpartnerEdd": null,
213 "channelName": null,
214 "nonDeliveryReport": {},
215 "courierPartnerId": 1001,
216 "courierName": "IndiaPost"
217 }
218 }
219 }
220}
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.
200 OK
400
401
409
500
1{
2 "error": {
3 "reason": "VALIDATION_ERROR",
4 "status": 400,
5 "message": "\"wayBill\" must be a string",
6 "type": "Bad Request",
7 "statusCode": 400,
8 "name": "error"
9 }
10}
11
121. 'wayBill' is required
132. 'wayBill' must be a string
143. 'wayBill" is not allowed to be empty'
154. 'courierPartnerId' must be a number