Sign in

v1

latestOpenAPI 3.1.02026-07-2296226496.3 KB
Fleet

Update Delivery

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.

patch/v1/fleet/deliveries/{delivery_id}

Path parameters

delivery_idstring required

The Nash delivery id to update.

The Nash delivery id to update.

Request body

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'

Lifecycle states a fleet can report for a delivery.

Ordered roughly chronologically:

  • not_assigned_driver — provider received the dispatch but hasn't found a driver.
  • assigned_driver — a driver has accepted the dispatch but hasn't departed.
  • pickup_enroute — driver is on the way to the pickup location.
  • pickup_arrived — driver is at the pickup location.
  • pickup_complete — package has been picked up.
  • dropoff_enroute — driver is on the way to the customer.
  • dropoff_arrived — driver is at the customer.
  • dropoff_complete — package delivered (terminal success).
  • failed — delivery aborted; pair with failure block (terminal).
  • canceled_by_provider — provider canceled the dispatch (terminal).
  • return_in_progress — package is being returned to the pickup location.
  • return_arrived — driver is at the pickup location to return.
  • returned_to_store — package returned (terminal).
pickupNotestring nullable

Note from the courier at pickup. E.g. 'used the side door'.

dropoffNotestring nullable

Note from the courier at dropoff. E.g. 'left with concierge'.

parkingLocationstring nullable

Where the courier parked at the stop. E.g. 'loading bay 4'.

returnParkingLocationstring nullable

Where the courier parked when returning the package to the pickup location.

pickupEtastring date-time nullable

Estimated pickup arrival time. ISO 8601.

dropoffEtastring date-time nullable

Estimated dropoff arrival time. ISO 8601.

externalDeliveryIdstring nullable

Provider's own identifier for this delivery.

Response

OK

idstring required

Delivery ID

typestring nullable
statusstring required

Delivery status

statusHistoryobject[] nullable

Delivery status history

isActiveboolean required

Is the delivery active

pickupEtastring nullable

Pickup ETA

dropoffEtastring nullable

Dropoff ETA

dropoffDeadlinestring nullable

Dropoff deadline

priceCentsinteger required

Price in cents

currencystring required

Currency

nashFeeCentsinteger nullable

Nash fee in cents

courierNamestring nullable

Courier name

courierPhoneNumberstring nullable

Courier phone number

courierPickupPhoneNumberstring nullable

Courier pickup phone number

courierDropoffPhoneNumberstring nullable

Courier dropoff phone number

courierLocationobject nullable

Courier location

courierVehicleobject nullable

Courier vehicle

courierProfileImagestring nullable

Courier profile image

proofOfDeliveryobject[] nullable

Proof of delivery

providerDeliveryIdstring nullable

Provider delivery id

providerBatchIdstring nullable

Provider batch id

pricenumber nullable

Price

taxAmountCentsinteger nullable

Tax amount in cents

tollFeeCentsinteger nullable

Toll fee in cents

waitFeeCentsinteger nullable

Wait fee in cents

waitTimeMinutesinteger nullable

Wait time in minutes

cancellationFeeCentsinteger nullable

Cancellation fee in cents

returnFeeCentsinteger nullable

Return fee in cents

otherProviderFeesobject nullable

Other provider fees

insuranceFeeCentsinteger nullable

Insurance fee in cents

totalPriceBreakdownobject nullable

Total price breakdown

totalPriceCentsinteger nullable

Total price in cents

Example response

{
  "id": "dlv_01234567890",
  "status": "dropoff_complete",
  "statusHistory": [
    {
      "created_at": "2023-08-29T19:17:46.264523",
      "status": "created"
    },
    {
      "created_at": "2023-08-29T19:17:47.509265",
      "status": "not_assigned_driver"
    }
  ]
}