Tracking Shipment using Polling
This API uses polling to track order statuses, given details for the order and the carrier partner involved.
Overview
Enterprise can get the latest tracking updates from Clickpost in two ways: Polling or Webhooks. This API uses polling to track order statuses. Polling API retrieves the historic statuses and the current status of the package.
Usecase
This is a standard API which applies to all MPS (Multi-Piece Shipment) and SPS (Single Piece Shipment) orders
Geography
This API is applicable for all geographies (Indian, worldwide and cross-border shipments).
Path
API type: GET API
Sample URL:
https://api.clickpost.in/api/v2/track-order/?username=*&key=*&waybill=*&cp_id=*
URL Parameters
| Field Name | Data Type | Field | Description | Max Length | Example |
|---|---|---|---|---|---|
key | String | Mandatory | Unique license key that is given to you by Clickpost team | 100 | "34be9be5-3de8-4223-ad14-d7391159b80e" |
username | String | Mandatory | Registered username given to you by Clickpost team | 100 | "test-enterprise" |
waybill | String | Mandatory | Waybill of the shipment to be used for tracking. You can pass multiple waybills [comma seperated, upto 5] in a single request, make sure all AWBs belong to same carrier | 100 | "TESTAWB000001" |
cp_id | String | Mandatory | cp_id of the carrier to which this AWB belongs. | 25 |
Response
Sample Response
{
"meta": {
"status": 200,
"success": true,
"message": "SUCCESS"
},
"result": {
"4210610508756": {
"latest_status": {
"timestamp": "2022-10-31 19:56:16",
"location": "Faridabad_Mthurard_CP (Haryana)",
"remark": "Shipment not received from client",
"status": "Not Picked",
"clickpost_status_code": 2,
"clickpost_status_description": "PickupPending",
"clickpost_status_bucket": 1,
"clickpost_status_bucket_description": "Order Placed",
"created_at": "2022-10-27 11:10:28"
},
"scans": [
{
"timestamp": "2022-10-31 19:56:16",
"location": "Faridabad_Mthurard_CP (Haryana)",
"remark": "Shipment not received from client",
"status": "Not Picked",
"clickpost_status_code": 2,
"checkpoint_id": 9629321255,
"tracking_id": 493656670,
"created_at": "2022-10-31 15:30:31",
"clickpost_status_description": "PickupPending",
"clickpost_status_bucket": 1,
"clickpost_status_bucket_description": "Order Placed"
},
{
"timestamp": "2022-10-29 19:56:42",
"location": "Faridabad_Mthurard_CP (Haryana)",
"remark": "Shipper unavailable",
"status": "Manifested",
"clickpost_status_code": 3,
"checkpoint_id": 9577278643,
"tracking_id": 493656670,
"created_at": "2022-10-29 15:29:30",
"clickpost_status_description": "PickupFailed",
"clickpost_status_bucket": 1,
"clickpost_status_bucket_description": "Order placed"
},
{
"timestamp": "2022-10-29 09:26:32",
"location": "Faridabad_Mthurard_CP (Haryana)",
"remark": "Out for Pickup",
"status": "Out for Pickup",
"clickpost_status_code": 25,
"checkpoint_id": 9562545783,
"tracking_id": 493656670,
"created_at": "2022-10-29 05:45:22",
"clickpost_status_description": "OutForPickup",
"clickpost_status_bucket": 1,
"clickpost_status_bucket_description": "Order placed"
},
{
"timestamp": "2022-10-28 14:53:24",
"location": "Faridabad_Mthurard_CP (Haryana)",
"remark": "Pickup scheduled",
"status": "Manifested",
"clickpost_status_code": 1,
"checkpoint_id": 9540836463,
"tracking_id": 493656670,
"created_at": "2022-10-28 09:49:16",
"clickpost_status_description": "OrderPlaced",
"clickpost_status_bucket": 1,
"clickpost_status_bucket_description": "Order placed"
},
{
"timestamp": "2022-10-28 14:53:22",
"location": "Faridabad_Mthurard_CP (Haryana)",
"remark": "Shipment not ready for pickup",
"status": "Manifested",
"clickpost_status_code": 2,
"checkpoint_id": 9540836456,
"tracking_id": 493656670,
"created_at": "2022-10-28 09:49:16",
"clickpost_status_description": "PickupPending",
"clickpost_status_bucket": 1,
"clickpost_status_bucket_description": "Order Placed"
},
{
"timestamp": "2022-10-28 12:34:10",
"location": "Faridabad_Mthurard_CP (Haryana)",
"remark": "Out for Pickup",
"status": "Out for Pickup",
"clickpost_status_code": 25,
"checkpoint_id": 9537993020,
"tracking_id": 493656670,
"created_at": "2022-10-28 07:58:23",
"clickpost_status_description": "OutForPickup",
"clickpost_status_bucket": 1,
"clickpost_status_bucket_description": "Order placed"
},
{
"timestamp": "2022-10-27 16:40:32",
"location": "Faridabad_Mthurard_CP (Haryana)",
"remark": "Pickup scheduled",
"status": "Manifested",
"clickpost_status_code": 1,
"checkpoint_id": 9519481038,
"tracking_id": 493656670,
"created_at": "2022-10-27 14:16:37",
"clickpost_status_description": "OrderPlaced",
"clickpost_status_bucket": 1,
"clickpost_status_bucket_description": "Order placed"
},
{
"timestamp": "2022-10-27 16:40:27",
"location": "Faridabad_Mthurard_CP (Haryana)",
"remark": "Shipment details manifested",
"status": "Manifested",
"clickpost_status_code": 1,
"checkpoint_id": 9519481036,
"tracking_id": 493656670,
"created_at": "2022-10-27 14:16:37",
"clickpost_status_description": "OrderPlaced",
"clickpost_status_bucket": 1,
"clickpost_status_bucket_description": "Order placed"
}
],
"valid": true,
"additional": {
"is_stuck": false,
"order_id": "1234556689",
"sku": [
"Footwear"
],
"edd": {
"max_sla": 3,
"min_sla": 2,
"exact_sla": null
},
"invoice_number": "ABCD11111",
"pickup_city": "Delhi",
"drop_city": "Bangalore",
"cod_value": 1000.0,
"currency_code": "INR",
"courier_partner_edd": null,
"channel_name": "ABCDEF",
"qc_images": [],
"ndr": {
"ndr_bucket_code": 14,
"ndr_description": "Customer Unavailable"
},
"courier_partner_id": 4,
"courier_name": "Delhivery"
}
}
}
}
{
"meta": {
"status": 200,
"success": true,
"message": "SUCCESS"
},
"result": null
}
The sample response can have the following fields
| Field Name | Data Type | Description |
|---|---|---|
meta | Object | Metadata for the result, e.g. status code, error messages. |
result | Object | Actual result of the request |
Response Meta
| Field Name | Data Type | Description |
|---|---|---|
status | Integer | Status code of the response (including, but not limited to HTTP Status codes) |
message | String | Error message (if any errors) for the request. |
success | Boolean | Whether the request is successful or not. |
Response Result
| Field Name | Data Type | Description |
|---|---|---|
<AWB>(The AWB value itself) | String | The AWB itself that is being tracked |
The <AWB> field can have the following fields:
| Field Name | Data Type | Description |
|---|---|---|
latest_status | Object[Status Object] | Status object representing the last recorded status of the shipment |
scans | List[Status Object] | List of status objects, each denoting one scan of the status of the shipment |
valid | Boolean | Whether the AWB provided is valid/existing or not |
additional | Object | An object encapsulating additional details of the shipment |
The Status Objects mentioned above can have the following fields:
| Field Name | Data Type | Description |
|---|---|---|
timestamp | String | Timestamp of the Status object, i.e. the time when this status was recorded (in YYYY-MM-DD HH:MM:SS format) |
location | String | Location where this status was recorded |
remark | String | Remarks/comments regarding this status |
status | String | Actual status string of the object |
clickpost_status_code | Integer | Status code of the order |
clickpost_status_description | String | Description of the status code of the order |
clickpost_status_bucket | Integer | A consolidated ID of the status, built on top of clickpost_status_codes. They are used to show the status to the customer on the Track Orders page. |
clickpost_status_description | String | Description of the status, corresponding to the clickpost_status_bucket field. |
The additional object can have the following fields:
| Field Name | Data Type | Description |
|---|---|---|
is_stuck | Boolean | Whether the shipment is stuck somewhere mid-journey |
order_id | String | Order Number of the shipment |
sku | List | List of SKUs of the items in the shipment |
edd | Object | Object containing details of the estimated date of delivery of the shipment |
invoice_number | String | Invoice number of the shipment |
pickup_city | String | City of pickup of the shipment |
drop_city | String | City of delivery of the shipment |
cod_value | Float | COD Value of the shipment |
currency_code | String | Currency code of the shipment |
courier_partner_edd | String/Null | Estimated date of delivery of the shipment (YYYY-MM-DD format if not null) |
channel_name | String | Name of the channel through which the order was placed |
qc_images | List | List of URLs for any images of the product, for use in quality checking. |
ndr | Object | Details regarding the Non-Delivery Report status |
courier_partner_id | Integer | Partner ID of the carrier shipping the order |
courier_name | String | Name of the carrier shipping the order |
The edd object can have the following fields
| Field Name | Data Type | Description |
|---|---|---|
min_sla | Integer | Minimum estimated days of delivery agreed upon by the SLA |
max_sla | Integer | Maximum estimated days of delivery agreed upon by the SLA |
exact_sla | Integer/Null | Exact estimated days (if any) of delivery agreed upon by the SLA |
The ndr object can have the following fields:
| Field Name | Data Type | Description |
|---|---|---|
ndr_bucket_code | Integer | Clickpost-defined status ID of the NDR status |
ndr_description | String | Description of the NDR status |
Updated about 1 year ago