Shipment Tracking Unified API

How does the response body look for an Undeliverable/Return shipment?

Created by: Jhonathan Ibanez

Modified on: Thu, 26 Oct, 2023 at 1:38 PM

Shipments that can't be delivered often become "return shipments". Find below a fictitious example of how the response body is shown for one of these cases, where the shipment wasn't delivered and completed its path back to the original sender. In such cases, the original sender ends up "becoming" the final recipient as well.


{

    "shipments": [

        {

            "serviceUrl": "https://www.dhl.de/de/privatkunden.html?piececode=00123456789765432101",

            "returnFlag": true,

            "id": "00123456789765432101",

            "service": "parcel-de",

            "origin": {

                "address": {

                    "countryCode": "DE"

                }

            },

            "destination": {

                "address": {

                    "countryCode": "DE"

                }

            },

            "status": {

                "timestamp": "2023-10-26T12:08:00",

                "location": {

                    "address": {

                        "addressLocality": "Germany"

                    }

                },

                "statusCode": "delivered",

                "status": "The shipment has been successfully delivered",

                "description": "The shipment has been successfully delivered"

            },

            "details": {

                "product": {

                    "productName": "DHL PAKET (parcel)"

                },

                "receiver": {

                    "@type": "Person",

                    "name": "ABCD GmbH"

                },

                "proofOfDeliverySignedAvailable": false,

                "totalNumberOfPieces": 1,

                "pieceIds": [

                    "00123456789765432101"

                ],

                "weight": {

                    "value": 0.5,

                    "unitText": "kg"

                }

            },

            "events": [

                {

                    "timestamp": "2023-10-26T12:08:00",

                    "location": {

                        "address": {

                            "addressLocality": "Germany"

                        }

                    },

                    "statusCode": "delivered",

                    "status": "The shipment has been successfully delivered",

                    "description": "The shipment has been successfully delivered"

                },

                {

                    "timestamp": "2023-10-26T09:50:00",

                    "statusCode": "transit",

                    "status": "The shipment has been loaded onto the delivery vehicle",

                    "description": "The shipment has been loaded onto the delivery vehicle"

                },

                {

                    "timestamp": "2023-10-26T02:22:00",

                    "location": {

                        "address": {

                            "addressLocality": "Speyer, Germany"

                        }

                    },

                    "statusCode": "transit",

                    "status": "The shipment arrived in the region of recipient and will be transported to the delivery base in the next step.",

                    "description": "The shipment arrived in the region of recipient and will be transported to the delivery base in the next step."

                },

                {

                    "timestamp": "2023-10-25T20:06:00",

                    "location": {

                        "address": {

                            "addressLocality": "Neuwied, Germany"

                        }

                    },

                    "statusCode": "transit",

                    "status": "The shipment has been processed in the parcel center of origin",

                    "description": "The shipment has been processed in the parcel center of origin"

                },

                {

                    "timestamp": "2023-10-25T16:05:00",

                    "location": {

                        "address": {

                            "addressLocality": "Germany"

                        }

                    },

                    "statusCode": "failure"

                },

                {

                    "timestamp": "2023-10-25T16:05:00",

                    "location": {

                        "address": {

                            "addressLocality": "Germany"

                        }

                    },

                    "statusCode": "failure",

                    "status": "Unfortunately, the shipment could not be delivered. This may be for the following reasons: no name on doorbell; recipient has moved; recipient could not be found based on the address details provided on the shipment.",

                    "description": "Unfortunately, the shipment could not be delivered. This may be for the following reasons: no name on doorbell; recipient has moved; recipient could not be found based on the address details provided on the shipment."

                },

                {

                    "timestamp": "2023-10-25T09:30:00",

                    "statusCode": "transit",

                    "status": "The shipment has been loaded onto the delivery vehicle",

                    "description": "The shipment has been loaded onto the delivery vehicle"

                },

                {

                    "timestamp": "2023-10-25T03:09:00",

                    "location": {

                        "address": {

                            "addressLocality": "Neuwied, Germany"

                        }

                    },

                    "statusCode": "transit",

                    "status": "The shipment arrived in the region of recipient and will be transported to the delivery base in the next step.",

                    "description": "The shipment arrived in the region of recipient and will be transported to the delivery base in the next step."

                },

                {

                    "timestamp": "2023-10-25T03:06:00",

                    "location": {

                        "address": {

                            "addressLocality": "Neuwied, Germany"

                        }

                    },

                    "statusCode": "transit",

                    "status": "The shipment arrived in the region of recipient and will be transported to the delivery base in the next step.",

                    "description": "The shipment arrived in the region of recipient and will be transported to the delivery base in the next step."

                },

                {

                    "timestamp": "2023-10-24T18:09:00",

                    "location": {

                        "address": {

                            "addressLocality": "Speyer, Germany"

                        }

                    },

                    "statusCode": "transit",

                    "status": "The shipment has been processed in the parcel center of origin",

                    "description": "The shipment has been processed in the parcel center of origin"

                },

                {

                    "timestamp": "2023-10-23T19:56:00",

                    "location": {

                        "address": {

                            "addressLocality": "Germany"

                        }

                    },

                    "statusCode": "transit",

                    "status": "The shipment has been posted by the sender at the retail outlet",

                    "description": "The shipment has been posted by the sender at the retail outlet"

                },

                {

                    "timestamp": "2023-10-23T18:52:00",

                    "statusCode": "pre-transit",

                    "status": "The instruction data for this shipment have been provided by the sender to DHL electronically",

                    "description": "The instruction data for this shipment have been provided by the sender to DHL electronically"

                }

            ]

        }

    ],

    "possibleAdditionalShipmentsUrl": [

        "/track/shipments?trackingNumber=00123456789765432101&recipientPostalCode=12345&service=ecommerce",

    ]

}

J
Jhonathan is the author of this solution article.

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.