NDR Action Update
This API instructs the courier company to take action on an AWB. Two actions are supported: Re Attempt Delivery, and Initiate Return to Origin
Overview
This API instructs the courier company to take action on an AWB. Two actions are supported
- Initiate Return to Origin: Enterprise can use this API to initiate a return to the origin, in cases where the customer cancels the order
- Re-Attempt the delivery with the updated
addresslandmarkdrop_pincodephone_numberpreferred_date
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
NOTE
If the enterprise is using the NDR API, they need to ensure that the NDR reports for the particular carrier partner are enabled. Please reach out to support
Query Parameters
| Field Name | Data Type | Field | Description | Example |
|---|---|---|---|---|
username | string | Mandatory | Username of the enterprise | test-enterprise |
key | string | Mandatory | Unique license key provided by Clickpost for the enterprise | 00000000-0000-0000-0000-000000000000 |
Request Body
| Field Name | Data Type | Field | Description | Example |
|---|---|---|---|---|
action | string | Mandatory | Action to be passed to carrier partner: either INITIATE_RTO or REATTEMPT | "REATTEMPT" |
waybill | string | Mandatory | AWB Number that needs to be updated | "4152912745934" |
cp_id | num | Mandatory | The carrier partner ID (https://track.clickpost.in/carrier_partner) | 4 |
account_code | string | Mandatory | The account code of the carrier partner on Clickpost dashboard, which is used to generate the AWB Number | "Delhivery-Express" |
address | string | Optional | The updated address. Mandatory in case of REATTEMPT | "Updated Address details" |
landmark | string | Optional | The updated landmark. Mandatory in case of REATTEMPT | "Updated Address landmark if any" |
drop_pincode | string | Optional | The updated drop Pincode. Mandatory in case of REATTEMPT | "380001" |
phone_number | string | Optional | The updated phone number. Mandatory in case of REATTEMPT | "8080808080" |
preferred_date | string | Optional | The updated delivery date. Mandatory in case of REATTEMPT | "2022-10-31" |
| source | string | Optional | Helps in identifying the source of this update. If you are a whatsapp communication gateway using this API, please pass source as "whatsapp" | "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 |
Updated 10 months ago