Failed Delivery API

The Failed Delivery Resolution API allows you to submit resolution actions for orders that couldn't be delivered. This API enables you to provide updated delivery information or select resolution code

Base URL

https://wms.eshopbox.com/api/v2/ndrResolution

Authentication

This API uses Bearer Token authentication. Include the JWT token in the Authorization header.

Request

HTTPS Method

POST

Headers

  • Authorization: Bearer <token> - JWT authentication token

  • Content-Type: application/json - Specifies JSON request body

Request Body (JSON)

Parameter
Type
Required
Description

actionSource

string

Optional

Source of the resolution action

customerOrderNumber

string

Yes

Customer's order number (e.g., "DR-903").

resolutionCode

string

Yes

NDR resolution code (e.g., "ACTF001")

trackingId

string

Yes

Shipment tracking ID (e.g., "82616846149")

deferredDate

string

Optional

New delivery date if deferred (yyyy-mm-dd). This is applicable only for ACTF002. (Example: 2025-06-14)

shippingDetails

object

Optional

Updated shipping information

shippingDetails.name

string

Optional

Recipient name. This is applicable for ACTF001, ACTF003 and ACTF004.

shippingDetails.email

string

Optional

Recipient email. This is applicable for ACTF001, ACTF003 and ACTF004.

shippingDetails.currentAddress

string

Optional

Original delivery address. This is applicable for ACTF001, ACTF003 and ACTF004.

shippingDetails.updatedAddress

string

Optional

Updated delivery address. This is applicable for ACTF001, ACTF003 and ACTF004.

shippingDetails.landmark

string

Optional

Nearby landmark for delivery. This is applicable for ACTF001, ACTF003 and ACTF004.

shippingDetails.notes

string

Optional

Additional delivery instructions. This is applicable for ACTF001, ACTF003 and ACTF004.

contactPhoneNumber

string

Yes

Contact phone number (e.g., "9692XXXXXX". You need to use the same phone number that is associated with the order.

remarks

string

Optional

Additional remarks about the resolution

Resolution Codes

Common NDR resolution codes include:

Code
Description
Customer Message

ACTF001

Reattempt delivery

I will request another delivery attempt (You can update your address and contact details.)

ACTF002

Delivery rescheduled

I will choose a new delivery date.

ACTF003

Cancel

I will cancel my order.

ACTF004

Return to origin initiated

I will request another delivery attempt as I disagree with the courier mentioned reason for failed delivery.

Example Request ACTF001 (Reattempt delivery)

{
    "actionSource": "",
    "customerOrderNumber": "6308432675062",
    "resolutionCode": "ACTF001",
    "trackingId": "32346210357136",
    "deferredDate": "",
    "shippingDetails": {
        "name": "John Doe",
        "email": "johndoe@test.com",
        "currentAddress": "del, v3 floor, Delhi, Delhi, 110001",
        "updatedAddress": "House 111, v3 floor, Delhi, Delhi- 110001",
        "landmark": "",
        "notes": ""
    },
    "contactPhoneNumber": "999999999",
    "remarks": ""
}

Response

{
 "customerOrderNumber": "6308432675062",
 "orderItemID": "6308432675062-43527461",
 "resolutionCode": "ACTF002",
 "deferredDate": "",
 "shippingDetails": {
  "name": "John Doe",
  "email": "johndoe@test.com",
  "currentAddress": "del, v3 floor, Delhi, Delhi, 110001",
  "updatedAddress": "House 111, v3 floor, Delhi, Delhi- 110001",
  "landmark": "",
  "notes": ""
 },
 "contactPhoneNumber": "9999999999",
 "trackingId": "32346210357136",
 "remarks": "",
 "timeline": "forwardTrackingTimeline",
 "clientEmail": "john@test.com",
 "actionSource": ""
}

Example Request ACTF002 (Delivery rescheduled)

{
    "actionSource": "",
    "customerOrderNumber": "6308432675062",
    "resolutionCode": "ACTF002",
    "trackingId": "32346210357136",
    "deferredDate": "2025-05-14",
    "shippingDetails": {
        "name": "John Doe",
        "email": "johndoe@test.com",
        "currentAddress": "del, v3 floor, Delhi, Delhi, 110001",
        "updatedAddress": "House 111, v3 floor, Delhi, Delhi- 110001",
        "landmark": "",
        "notes": ""
    },
    "contactPhoneNumber": "999999999",
    "remarks": ""
}

Response

{
 "customerOrderNumber": "6308432675062",
 "orderItemID": "6308432675062-43527461",
 "resolutionCode": "ACTF002",
 "deferredDate": "2025-05-14",
 "shippingDetails": {
  "name": "John Doe",
  "email": "johndoe@test.com",
  "currentAddress": "del, v3 floor, Delhi, Delhi, 110001",
  "updatedAddress": "House 111, v3 floor, Delhi, Delhi- 110001",
  "landmark": "",
  "notes": ""
 },
 "contactPhoneNumber": "9999999999",
 "trackingId": "32346210357136",
 "remarks": "",
 "timeline": "forwardTrackingTimeline",
 "clientEmail": "john@test.com",
 "actionSource": ""
}

Example Request ACTF003 (Cancel)

{
    "actionSource": "",
    "customerOrderNumber": "6308432675062",
    "resolutionCode": "ACTF003",
    "trackingId": "32346210357136",
    "remarks": "cancel"
}

Response

{
    "customerOrderNumber": "6308432675062",
    "orderItemID": "6308432675062-43527461",
    "resolutionCode": "ACTF003",
    "trackingId": "32346210357136",
    "remarks": "cancel",
    "timeline": "forwardTrackingTimeline",
    "clientEmail": "john@test.com",
    "actionSource": "",
}

Example Request ACTF004 (Report false delivery attempt )

{
    "actionSource": "",
    "customerOrderNumber": "6308432675062",
    "resolutionCode": "ACTF004",
    "trackingId": "32346210357136",
    "deferredDate": "",
    "shippingDetails": {
        "name": "John Doe ",
        "email": "johndoe@test.com",
        "currentAddress": "B BLOCK 1335 INDRA NAGAR LUCKNOW, , Lucknow, Uttar Pradesh, 226016",
        "updatedAddress": "B BLOCK 1335 INDRA NAGAR LUCKNOW, h, Lucknow, Uttar Pradesh- 226016",
        "landmark": "h",
        "notes": ""
    },
    "contactPhoneNumber": "9999999999",
    "remarks": "Re attempt "
}

Response

{
    "customerOrderNumber": "6308432675062",
    "orderItemID": "6308432675062-43527461",
    "resolutionCode": "ACTF004",
    "deferredDate": "",
    "shippingDetails": {
        "name": "John Doe ",
        "email": "johndoe@test.com",
        "currentAddress": "B BLOCK 1335 INDRA NAGAR LUCKNOW, , Lucknow, Uttar Pradesh, 226016",
        "updatedAddress": "B BLOCK 1335 INDRA NAGAR LUCKNOW, h, Lucknow, Uttar Pradesh- 226016",
        "landmark": "h",
        "notes": ""
    },
    "contactPhoneNumber": "9999999999",
    "trackingId": "32346210357136",
    "remarks": "Re attempt ",
    "timeline": "forwardTrackingTimeline",
    "clientEmail": "john@test.com",
    "actorType": "seller",
    "actionSource": "",
    "actor": "john@test.com"
}
PreviousActivityNextRate Calculator

Last updated

Was this helpful?