Fetch Expected Date of Delivery
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.
Overview
By entering the pick_up and drop pin codes, the enterprises can determine the expected date of delivery.
The expected date of delivery API computes the minimum/maximum time range, a shipment lifecycle may take between the pickup and drop Pincode using our predictive machine learning algorithm.
By default, it computes the range for all carrier companies available and gives the carrier partner id which might deliver the shipment fastest.
An optional cp_id carrier partner id can be passed to see the range for a specific carrier partner
-
On the product page, enterprises can call Clickpost's EDD API to show the Expected Delivery Date to the customer
-
At the time of checkout, the enterprise can show the Expected Date of Delivery to the customer
-
Get the minimum and maximum time in days for a particular shipment from pickup Pincode to drop Pincode
Usecase
This is a standard API which applies to all MPS (Multi-Piece Shipment) and SPS (Single Piece Shipment) orders
Geography
This is a standard API which supports all shipments created and transported within
- India
- North America
- Europe
- South East Asia
NOTE
The API uses our predictive machine learning algorithm
Request Payload
optional [optional parameters] [optional]
| Field Name | Data Type | Field | Description | Max Length | Example |
|---|---|---|---|---|---|
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 | 4 | |
awb | string | Optional | Airway bill number of a shipment for which the Expected date of delivery needs to be calculated | 76593744312 |
| Field Name | Data Type | Field | Description | Max Length | Example |
|---|---|---|---|---|---|
drop_pincode | num | Mandatory | The drop pincode for which the EDD needs to be ascertained | 6 char | 380001 |
pickup_pincode | num | Mandatory | The pickup pincode for which the EDD needs to be ascertained | 6 char | 380015 |
Response
meta [meta parameters]
| Field Name | Data Type | Description | Example |
|---|---|---|---|
success | Boolean | Indicates the success of the API request | true |
message | String | The message from clickpost. In case of success it will be "SUCCESS". In case that there are no carrier partners that are servicing the pincodes it will be”Pin code not serviceable" | "SUCCESS" |
status | HTTP Code | The HTTP response status code of the API request | 200 |
result [result parameters]
| Field Name | Data Type | Description | Example |
|---|---|---|---|
predicted_sla_min | num | The minimum time in days in which the shipment will be delivered to the drop Pincode | 2 |
predicted_sla_max | num | The maximum time in days in which the shipment will be delivered to the drop Pincode | 4 |
all_map | object | Returns an array for each carrier partner with the minimum and maximum SLA | "6": [ 2, 3 ] |
min_sla_cp_id | num | Returns the carrier partner id (cp_id) which has the lowest SLA in days | 6 |
pickup_date | string | The date on which shipment will be picked up by the carrier partner | "2021-06-22" |
NOTE
Here Estimated date of delivery would be "Pickup date" + "SLA" (receievd from EDD API)
Updated over 1 year ago