POST /v1/external/ndr/{awb}/action
This API will let you take actions like Reattempt and RTO on the shipments that are in NDR.
Parameters:
| PARAMS | REQUIRED | DATA TYPE | DESCRIPTION | EXAMPLE |
|---|
action | YES | string | The action needs to be specified | ‘fake-attempt’ or ‘re-attempt’ or 'return' |
comments | YES | string | Any comment can be mentioned | The Byer does not want the product |
phone | NO | string | The phone number will be updated at the time of re-attempt and fake-attempt | 9999988888 |
proof_audio | CONDITIONAL YES | string | URL of the audio which will be updated at the time of the fake attempt | https://s3-ap-southeast-1.amazonaws.com/kr-multichannel/imports/ndr/1655100133_file_example_MP3_700KB.mp3 |
proof_image | CONDITIONAL YES | string | URL of the image which will be updated at the time of the fake attempt | https://s3-ap-southeast-1.amazonaws.com/kr-multichannel/imports/ndr/img_7687678678.jpg |
remarks | CONDITIONAL YES | string | Remarks will be updated at the time of a fake attempt | Delivery Requested |
address1 | NO | string | address1 will be updated at the time of re-attempt and fake-attempt | U-56, sector-23, Noida, India |
address2 | NO | string | addres2 will be updated at the time of re-attempt and fake-attempt | U-56, sector-23, Noida, India |
deferred_date | NO | date(string) | Deferred date will be updated as preferred_date at the time of fake-attempt and re-attempt | 2022-08-10 |
Servers
- https://apiv2.shiprocket.in
Path parameters
| Name |
Type |
Required |
Description |
awb |
String |
Yes |
|
Request headers
| Name |
Type |
Required |
Description |
Content-Type |
String |
Yes |
The media type of the request body.
Default value: "application/json"
|
Request body fields
| Name |
Type |
Required |
Description |
action |
String |
No |
|
comments |
String |
No |
|
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.
