New field in the GET Job endpoint - return reason

Announcements
1

:new: What’s new?

We’re pleased to announce an enhancement of the ‘GET job’ endpoint. We’re introducing a new field, “return_reason”, that provides the reason for a package return, when applicable.

:bulb: How does it work?

The payload now includes a new “return_reason” field. This new field is a string that explains the reason for the package return.

Example:

"deliveries": [
    {
        "id": 100790428,
        ...
        "return_reason": "Incorrect package"
    }
]

For a more detailed explanation, including example payloads, please refer to ‘GET job’ endpoint documentation.

:sparkles: What’s the impact?

This modification offers improved visibility into packages that were returned.

Note: Adding a new field is not considered a breaking change. However, we encourage you to review your integration to ensure compatibility and if you encounter any issues, please let us know.

:date: When will this change take place?

  • All cities: 17 October 2024

:eyes: What’s next?

We’ll keep introducing enhancements to our API.

Kindly, subscribe to Announcement notifications to keep up to date! :face_with_monocle: