Lastmile API
Create and manage delivery bookings.
The Lastmile API allows partners to create and manage delivery bookings. You can place bookings, track their progress through the delivery lifecycle, and retrieve booking details.
Authentication
Include your API key in the X-DELIVEREASY-API-KEY header with every request.
curl -H "X-DELIVEREASY-API-KEY: your_api_key_here" \
https://api.delivereasy.co.nz/api/2025-04-01/lastmile/bookingsBase URLs
| Environment | URL |
|---|---|
| Staging | https://api.staging.delivereasy.co.nz/api/2025-04-01/lastmile |
| Production | https://api.delivereasy.co.nz/api/2025-04-01/lastmile |
Booking lifecycle
A booking moves through these statuses during delivery:
not_assigned → assigned → pickup_enroute → pickup_nearby → pickup_arriving → pickup_arrived → pickup_complete → dropoff_enroute → dropoff_arrived → dropoff_complete
A booking can also be cancelled, or enter return_in_progress and returned states if the delivery cannot be completed.