post https://ds.clickpost.in/api/v2/predicted_sla_api/
By entering the pick up and drop pin codes, the enterprises can fetch the expected date of delivery and expose the same on their website inorder to improve the customer experience.
Important Links
Payload Examples
[
{
"pickup_pincode": "600040",
"drop_pincode": "421504"
}
]
[
{
"pickup_pincode": "600040",
"drop_pincode": "421504",
"optional" : {
"cp_id" :5,
"awb": "ABCD12345",
"account_code": "Bluedart"
}
}
]
Request Payload
optional [optional parameters] [optional]
| Field Name | Data Type | Field | Description |
|---|---|---|---|
cp_id | num | Optional | Carrier Partner ID. This can be found on the dashboard or you can refer it to here. If you pass a cp_id, then the API will return the serviceability of that particular carrier partner |
awb | string | Optional | Airway bill number of a shipment for which the Expected date of delivery needs to be calculated |
| Field Name | Data Type | Field | Description |
|---|---|---|---|
drop_pincode | num | Mandatory | The drop pincode for which the EDD needs to be ascertained |
pickup_pincode | num | Mandatory | The pickup pincode for which the EDD needs to be ascertained |
Response
meta [meta parameters]
| Field Name | Data Type | Description |
|---|---|---|
success | Boolean | Indicates the success of the API request |
message | String | The message from Clickpost. In case of success, it will be "SUCCESS". In case there are no carrier partners that are servicing the pincodes it will be ”Pincode not serviceable" |
status | HTTP Code | The HTTP response status code of the API request |
result [result parameters]
| Field Name | Data Type | Description |
|---|---|---|
predicted_sla_min | num | The minimum time in days in which the shipment will be delivered to the drop Pincode |
predicted_sla_max | num | The maximum time in days in which the shipment will be delivered to the drop Pincode |
all_map | object | Returns an array for each carrier partner with the minimum and maximum SLA |
min_sla_cp_id | num | Returns the carrier partner id (cp_id) which has the lowest SLA in days |
pickup_date | string | The date on which shipment will be picked up by the carrier partner |
NOTE
Here Estimated date of delivery would be "Pickup date" + "SLA" (receievd from EDD API)