Failed Delivery API (Coming Soon)

Overview

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 codes to address delivery challenges.

Base URL

https://{Account_slug}.myeshopbox.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 (dd-mm-yyyy)
shippingDetails	object	Optional	Updated shipping information
shippingDetails.name	string	Optional	Recipient name
shippingDetails.email	string	Optional	Recipient email
shippingDetails.currentAddress	string	Optional	Original delivery address
shippingDetails.updatedAddress	string	Optional	Updated delivery address
shippingDetails.landmark	string	Optional	Nearby landmark for delivery
shippingDetails.notes	string	Optional	Additional delivery instructions
contactPhoneNumber	string	Yes	Contact phone number (e.g., "9692XXXXXX"
remarks	string	Optional	Additional remarks about the resolution

Resolution Codes

Common NDR resolution codes include:

Code	Description	Customer Message
ACTF001	Address correction requested	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.
ACTF005	Customer will pick up from nearest hub	"I will pick up the order from the nearest delivery hub. Sorry for the inconvenience. Learn more about out-for-delivery areas"

Example Request

{
    "actionSource": "",
    "customerOrderNumber": "6308432675062",
    "resolutionCode": "ACTF002",
    "trackingId": "32346210357136",
    "deferredDate": "2025-04-18",
    "shippingDetails": {
        "name": "John Doe",
        "email": "[e-mail]",
        "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-04-18",
 "shippingDetails": {
  "name": "John Doe",
  "email": "[e-mail]",
  "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": "[e-mail]",
 "actionSource": ""
}