post https://www.clickpost.in/api/v2/ndr-update-api
This API instructs the courier company to take action on an AWB. Using this API, enterprises can Reattempt the shipment with the updated address, preferred delivery date, and phone number. Enterprises can also Initiate a Return to Origin
Important Links
Payload Example
{
"action": "INITIATE_RTO / REATTEMPT",
"waybill": "4152912745934",
"cp_id": 4,
"account_code": "Delhivery-Express",
"address":"Updated Address details",
"landmark": "Updated Address landmark if any",
"drop_pincode": "Updated pincode",
"phone_number":"8080808080",
"preferred_date": "2022-12-25",
"source": "whatsapp"
}
Request Body
| Field Name | Data Type | Field | Description |
|---|---|---|---|
action | string | Mandatory | Action to be passed to carrier partner: either INITIATE_RTO or REATTEMPT |
waybill | string | Mandatory | AWB Number that needs to be updated |
cp_id | num | Mandatory | The carrier partner ID (https://track.clickpost.in/carrier_partner) |
account_code | string | Mandatory | The account code of the carrier partner on Clickpost dashboard, which is used to generate the AWB Number |
address | string | Optional | The updated address. Mandatory in case of REATTEMPT |
landmark | string | Optional | The updated landmark. Mandatory in case of REATTEMPT |
drop_pincode | string | Optional | The updated drop Pincode. Mandatory in case of REATTEMPT |
phone_number | string | Optional | The updated phone number. Mandatory in case of REATTEMPT |
preferred_date | string | Optional | The updated delivery date. Mandatory in case of REATTEMPT |
| source | string | Optional | If you are a whatsapp communication channel using this API, please pass the value as whatsapp |
Response
meta [meta parameters]
| Field Name | Data Type | Description | Example |
|---|---|---|---|
success | Boolean | Indicates the success of the API request | true |
message | String | SUCCESS in case request was successfully processed by Clickpost, else returns error message. | "SUCCESS" |
status | HTTP Code | The HTTP response status code of the API request | 200 |