Apply a partial update — such as status, courier location, proof of delivery, courier identity, or ETAs — to a delivery your organization owns. Only available for deliveries fulfilled by your own fleet (not by a third-party courier integration). Returns the updated delivery.
Documentation Index
Fetch the complete documentation index at: https://docs.usenash.com/llms.txt
Use this file to discover all available pages before exploring further.
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
The Nash delivery id to update.
Partial update for a delivery dispatched to a Nash-connected provider.
New lifecycle status.
not_assigned_driver, assigned_driver, pickup_enroute, pickup_arrived, pickup_complete, dropoff_enroute, dropoff_arrived, dropoff_complete, failed, canceled_by_provider, return_in_progress, return_arrived, returned_to_store Current courier coordinates.
Proof artifacts captured at the stop. Image or barcode, discriminated by podType.
Image-based proof captured at pickup or dropoff (photo or signature).
Identity and vehicle of the assigned courier.
Cause when the delivery enters failed or canceled_by_provider.
Note from the courier at pickup. E.g. 'used the side door'.
Note from the courier at dropoff. E.g. 'left with concierge'.
Where the courier parked at the stop. E.g. 'loading bay 4'.
Where the courier parked when returning the package to the pickup location.
Estimated pickup arrival time. ISO 8601.
Estimated dropoff arrival time. ISO 8601.
Provider's own identifier for this delivery.
OK
Generic serializer for deliveries used in many endpoints.
Some endpoints won't return all fields, so they are optional. This means that they will return field names with null values.
Delivery ID
"dlv_01234567890"
Delivery status
"dropoff_complete"
Is the delivery active
Price in cents
Currency
Delivery status history
[
{
"created_at": "2023-08-29T19:17:46.264523",
"status": "created"
},
{
"created_at": "2023-08-29T19:17:47.509265",
"status": "not_assigned_driver"
}
]Pickup ETA
Dropoff ETA
Dropoff deadline
Documents
Nash fee in cents
Courier name
Courier phone number
Courier pickup phone number
Courier dropoff phone number
Courier location
Courier vehicle
Courier profile image
Proof of delivery
Provider delivery id
Provider batch id
Price
Tax amount in cents
Toll fee in cents
Wait fee in cents
Wait time in minutes
Cancellation fee in cents
Return fee in cents
Other provider fees
Insurance fee in cents
Total price breakdown
Total price in cents
Picked items