Skip to main content
PATCH
/
v1
/
fleet
/
deliveries
/
{delivery_id}
Update Delivery
curl --request PATCH \
  --url https://api.sandbox.usenash.com/v1/fleet/deliveries/{delivery_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "status": "not_assigned_driver",
  "coordinates": {
    "latitude": 0,
    "longitude": 0
  },
  "proofOfDelivery": [
    {
      "podType": "photo_proof_of_delivery",
      "imageUrl": "<string>"
    }
  ],
  "courier": {
    "name": "<string>",
    "phoneNumber": "<string>",
    "pickupPhoneNumber": "<string>",
    "dropoffPhoneNumber": "<string>",
    "profileImageUrl": "<string>",
    "vehicle": {
      "make": "<string>",
      "model": "<string>",
      "color": "<string>",
      "licensePlate": "<string>"
    },
    "externalId": "<string>"
  },
  "failure": {
    "code": "customer_unavailable",
    "reason": "<string>"
  },
  "pickupNote": "<string>",
  "dropoffNote": "<string>",
  "parkingLocation": "<string>",
  "returnParkingLocation": "<string>",
  "pickupEta": "2023-11-07T05:31:56Z",
  "dropoffEta": "2023-11-07T05:31:56Z",
  "externalDeliveryId": "<string>"
}
'
{
  "id": "dlv_01234567890",
  "status": "dropoff_complete",
  "isActive": true,
  "priceCents": 123,
  "currency": "<string>",
  "type": "<string>",
  "statusHistory": [
    {
      "created_at": "2023-08-29T19:17:46.264523",
      "status": "created"
    },
    {
      "created_at": "2023-08-29T19:17:47.509265",
      "status": "not_assigned_driver"
    }
  ],
  "pickupEta": "<string>",
  "dropoffEta": "<string>",
  "dropoffDeadline": "<string>",
  "documents": [
    {
      "createdAt": "<string>",
      "id": "<string>",
      "type": "<string>",
      "contentType": "<string>",
      "url": "<string>",
      "data": "<string>",
      "documentMetadata": {}
    }
  ],
  "nashFeeCents": 123,
  "courierName": "<string>",
  "courierPhoneNumber": "<string>",
  "courierPickupPhoneNumber": "<string>",
  "courierDropoffPhoneNumber": "<string>",
  "courierLocation": {},
  "courierVehicle": {},
  "courierProfileImage": "<string>",
  "proofOfDelivery": [
    {}
  ],
  "providerDeliveryId": "<string>",
  "providerBatchId": "<string>",
  "price": 123,
  "taxAmountCents": 123,
  "tollFeeCents": 123,
  "waitFeeCents": 123,
  "waitTimeMinutes": 123,
  "cancellationFeeCents": 123,
  "returnFeeCents": 123,
  "otherProviderFees": {},
  "insuranceFeeCents": 123,
  "totalPriceBreakdown": {},
  "totalPriceCents": 123,
  "pickedItems": [
    {
      "sku": "<string>",
      "requestedSku": "<string>",
      "id": "<string>",
      "requestedId": "<string>",
      "quantity": 123,
      "requestedQuantity": 123,
      "scannedBarcode": "<string>",
      "weight": 123,
      "priceCents": 123,
      "status": "<string>",
      "name": "<string>",
      "scans": [
        {
          "substitutionType": "<string>",
          "barcodes": [
            {
              "weight": 123,
              "priceCents": 123,
              "weightUnit": "<string>",
              "productCode": "<string>",
              "isVariableWeight": true,
              "barcode": "<string>",
              "variableValue": 123,
              "format": "<string>",
              "indicatorDigit": "<string>",
              "checkDigit": "<string>",
              "manufacturerCode": "<string>",
              "itemReference": "<string>",
              "pluCheckDigit": "<string>",
              "barcodeSansCheckDigit": "<string>",
              "expirationDate": "<string>"
            }
          ]
        }
      ]
    }
  ]
}

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.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

delivery_id
string
required

The Nash delivery id to update.

Body

application/json

Partial update for a delivery dispatched to a Nash-connected provider.

status
enum<string> | null

New lifecycle status.

Available options:
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
coordinates
Coordinates · object

Current courier coordinates.

proofOfDelivery
(ImageProof · object | BarcodeProof · object)[] | null

Proof artifacts captured at the stop. Image or barcode, discriminated by podType.

Image-based proof captured at pickup or dropoff (photo or signature).

courier
Courier · object

Identity and vehicle of the assigned courier.

failure
DeliveryFailure · object

Cause when the delivery enters failed or canceled_by_provider.

pickupNote
string | null

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

dropoffNote
string | null

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

parkingLocation
string | null

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

returnParkingLocation
string | null

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

pickupEta
string<date-time> | null

Estimated pickup arrival time. ISO 8601.

dropoffEta
string<date-time> | null

Estimated dropoff arrival time. ISO 8601.

externalDeliveryId
string | null

Provider's own identifier for this delivery.

Response

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.

id
string
required

Delivery ID

Example:

"dlv_01234567890"

status
string
required

Delivery status

Example:

"dropoff_complete"

isActive
boolean
required

Is the delivery active

priceCents
integer
required

Price in cents

currency
string
required

Currency

type
string | null
statusHistory
Statushistory · object[] | null

Delivery status history

Example:
[
{
"created_at": "2023-08-29T19:17:46.264523",
"status": "created"
},
{
"created_at": "2023-08-29T19:17:47.509265",
"status": "not_assigned_driver"
}
]
pickupEta
string | null

Pickup ETA

dropoffEta
string | null

Dropoff ETA

dropoffDeadline
string | null

Dropoff deadline

documents
DocumentSerializer · object[] | null

Documents

nashFeeCents
integer | null

Nash fee in cents

courierName
string | null

Courier name

courierPhoneNumber
string | null

Courier phone number

courierPickupPhoneNumber
string | null

Courier pickup phone number

courierDropoffPhoneNumber
string | null

Courier dropoff phone number

courierLocation
Courierlocation · object

Courier location

courierVehicle
Couriervehicle · object

Courier vehicle

courierProfileImage
string | null

Courier profile image

proofOfDelivery
Proofofdelivery · object[] | null

Proof of delivery

providerDeliveryId
string | null

Provider delivery id

providerBatchId
string | null

Provider batch id

price
number | null

Price

taxAmountCents
integer | null

Tax amount in cents

tollFeeCents
integer | null

Toll fee in cents

waitFeeCents
integer | null

Wait fee in cents

waitTimeMinutes
integer | null

Wait time in minutes

cancellationFeeCents
integer | null

Cancellation fee in cents

returnFeeCents
integer | null

Return fee in cents

otherProviderFees
Otherproviderfees · object

Other provider fees

insuranceFeeCents
integer | null

Insurance fee in cents

totalPriceBreakdown
Totalpricebreakdown · object

Total price breakdown

totalPriceCents
integer | null

Total price in cents

pickedItems
PickedItemsSerializer · object[] | null

Picked items