Fetch updated shipment list
The API retrieves the latest shipment tracking status updates between the specified start and end time. This API takes the start date and end date and returns the data for all the AWBs which were updated during this time period
Overview
Enterprise can use this API to retrieve the shipments which are updated between the specified start and end time.
Usecase
This is a standard API which applies to all MPS (Multi-Piece Shipment) and SPS (Single Piece Shipment) orders
URL
GET <https://api.clickpost.in/api/v1/updated-order>
Query Parameters
| Field Name | Data Type | Field | Description | Max Length | Example |
|---|---|---|---|---|---|
key | String | Mandatory | Unique license key for the enterprise user | 36 | "00000000-0000-0000-0000-000000000000" |
username | String | Mandatory | Username of the enterprise | 50 | "username-enterprise" |
start_date | Num | Mandatory | Start time in epoch (seconds). Example: 1616580960 | 10 | 1667311250 |
end_date | Num | Mandatory | end time in epoch (seconds). Difference between start time and end time cannot be greater than 1800 seconds(30 mins) | 10 | 1667313050 |
The difference between start_date and end_date cannot be more than 30 minutes. As a best practice, keep the window as small as possible [preferrably 5/10 mins] to sync status in your system near realtime.
Response
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 | Example |
|---|---|---|---|
waybill | String | The AWB of the shipment | "151894390057768" |
carrier_partner | Num | The carrier partner ID | 4 |
created_at | Timestamp | Created timestamp of the order | "2022-10-24T11:43:14.420571Z" |
updated_at | Timestamp | The Update timestamp of the order | "2022-11-02T11:44:59.449189Z" |
clickpost_status_code | Num | The clickpost status code of the shipment https://clickpost.readme.io/docs/tracking-status-codes | 8 |
timestamp | Timestamp | The scan time in the system. It is in the same timezone the shipment status was updated. For example, for a shipment in India, the field will have the time in IST. For a shipment in Canada, field will have timestamp in EST | "2022-11-01 19:57:58" |
clickpost_status_description | ENUM | Description of the status code saved by Clickpost for the object https://clickpost.readme.io/docs/tracking-status-codes | "PickupPending" |
reference_number | String | Unique Alphanumeric string to identify and distinguish each API request | "CR67254835" |
account_code | String | Courier partner account name configured on the Clickpost dashboard | "Delhivery_Surface_B2C" |
location | String | The location of the last scan of the shipment | "LKO/PKM, Lucknow, UTTAR PRADESH" |
remark | String | The remark shared by the carrier partner | "Shipment not received from client" |
status | String | The latest status shared by the carrier partner | "Not Picked" |
customer_feedback_present | Boolean | Represent whether any customer feedback was received either from the tracking link or IVR from the customer for the particular order | false |
Sample Response
{
"meta": {
"status": 200,
"success": true,
"message": "SUCCESS"
},
"result": [
{
"waybill": "1518943900534648",
"carrier_partner": 6,
"created_at": "2022-10-24T11:43:14.420571Z",
"updated_at": "2022-11-02T11:44:59.449189Z",
"clickpost_status_code": 8,
"timestamp": "2022-11-01 19:57:00",
"clickpost_status_description": "Delivered",
"reference_number": "CR494331676",
"account_code": "Xpressbees_Surface",
"location": "LKO/PKM, Lucknow, UTTAR PRADESH",
"remark": "Delivered",
"status": "Delivered",
"customer_feedback_present": false,
},
{
"waybill": "190254100234356",
"carrier_partner": 4,
"created_at": "2022-10-28T05:21:56.479618Z",
"updated_at": "2022-11-01T14:28:20.051713Z",
"clickpost_status_code": 2,
"timestamp": "2022-11-01 19:57:58",
"clickpost_status_description": "PickupPending",
"reference_number": "CR51401814",
"account_code": "Delhivery_Surface_B2C",
"location": "Bangalore_Kudlu_CP (Karnataka)",
"remark": "Shipment not received from client",
"status": "Not Picked",
"customer_feedback_present": false
}
]
}
Updated 6 days ago