Courier-assigned v3 webhook update: Stacked packages

:new: What’s new?

We are pleased to announce an enhancement to the courier assigned webhook event. We’re introducing a new field, “details.packages” that includes the ID(s) of the stacked packages, when applicable.

:bulb: How does it work?

The payload now includes a new “packages” field. This new field is an array that lists the IDs of additional stacked packages, if any.

Example:

"details": {
    "account": {
        "id": 1
    },
    "courier": {
        "name": "Adriel Pfeffer"
    },
    "package": {
        "id": "10000000001",
        "reference": "1682689274",
        "tracking_url": "https://stuart.sandbox.followmy.delivery/100670892/1f25824f8d9c8999406c93406670b264"
    },
    "packages": [
        "10000000002",
        "10000000003"
    ]
}

For a more detailed explanation, including example payloads, please refer to our webhook v3 courier assigned documentation.

:sparkles: What’s the impact?

This modification offers improved visibility into packages that are transported together.

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 except London, Manchester and Paris: June 11th, 2024.
  • Paris: June 12th, 2024.
  • London and Manchester: June 13th, 2024.

:eyes: What’s next?

We’ll keep introducing enhancements to our webhooks events.

Please, subscribe to the Announcement notifications to keep up to date!