Fetch Expected Date of Delivery [Global]
By entering pickup details and drop details, International customer can get the EDD
Overview
This API is useful if you want to fetch the EDD for shipments in USA and EU regions.
By providing pickup_details and drop_details, you can determine the Expected Date of Delivery (EDD) for a shipment.
This Global EDD API computes the minimum and maximum delivery timeframe (in days) between the pickup and drop locations. Optionally, we can specify a particular carrier partner via cp_id.
Enterprises can integrate this API to:
Retrieve the min/max delivery days for any shipment between two pincodes.
Endpoint
POST https://ds.clickpost.in/api/v1/global_edd/
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
key | String | Yes | Clickpost API key. Provided by Clickpost team |
username | String | Yes | Clickpost username. Provided by Clickpost team |
Request Payload
| Field Path | Data Type | Required | Description | Example |
|---|---|---|---|---|
pickup_details.pincode | String | Yes | pickup pincode/zipcode | "122413" |
pickup_details.country | String | Yes | country code for pickup location | "IN" |
drop_details.pincode | String | Yes | drop pincode/zipcode | "328158" |
drop_details.country | String | Yes | country code for drop location | "SG" |
optional.cp_id | Integer | No | Carrier Partner ID. If provided, EDD is computed only for this carrier. List of carriers: https://carriers.clickpost.ai/ | 5 |
optional.awb | String | No | AWB number of shipment. If it's passed, system will try to fetch the EDD for this shipment. | "ABCD12345" |
optional.account_code | String | No | Carrier account code identifier, that you create while creating a carrier account on Clickpost dashboard | "ABC" |
optional.is_pudo | String | No | If "true", returns results based on pickup‑drop‑off service of the carrier | "true" |
Response
Meta
| Field | Type | Description | Example |
|---|---|---|---|
success | Boolean | Indicates whether the request succeeded | true |
message | String | A message describing the result | "SUCCESS" |
status | Integer | Status code | 200 |
Result
An array containing exactly one object with the following fields:
| Field | Type | Description | Example |
|---|---|---|---|
predicted_sla_min | Integer | Minimum delivery time (in days) from pickup to drop. | 5 |
predicted_sla_max | Integer | Maximum delivery time (in days) from pickup to drop. | 7 |
min_sla_account_id | Integer | Enterprise account ID that yields the minimum SLA. | null |
pickup_date | String | Date on which the shipment was picked up (YYYY‑MM‑DD), if derived from AWB metadata. | null |
account_map | Array | List of account‑level SLA details (if account_code provided). | [] |
fallback_edd | Boolean | true if ML model fallback was applied (e.g., no historical data). | false |
if_combination_edd | Boolean | true if a combination of SLA sources was used. | false |
source_edd_model | String | Name of the ML model or SLA source used for computation (e.g., "Uploaded SLA"). | "Uploaded SLA" |
Example
Request
curl --location 'https://ds.clickpost.in/api/v1/global_edd/?key=******&username=*****' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"pickup_details": {
"city": "",
"state": "",
"pincode": "122413",
"country": "IN"
},
"drop_details": {
"city": "",
"state": "",
"pincode": "328158",
"country": "SG"
},
"optional": {
"cp_id": 5,
"is_pudo": "true",
"awb": "ABCD12345",
"account_code": "ABC"
}
}'Response
{
"meta": {
"status": 200,
"message": "SUCCESS",
"success": true
},
"result": [
{
"predicted_sla_min": 5,
"predicted_sla_max": 7,
"min_sla_account_id": null,
"pickup_date": null,
"account_map": [],
"fallback_edd": false,
"if_combination_edd": false,
"source_edd_model": "Uploaded SLA"
}
]
}Updated 7 months ago
Did this page help you?
