Reporting a delivery incident
Report an incident with Create delivery incident (POST /v1/jobs/{jobId}/tasks/{taskId}/delivery_incident). The incident is recorded against a specific task on a job (delivery). The request requires:
raiseIncident(boolean) — flag the delivery to be reviewed by Nash’s team (reviews aren’t real-time — don’t rely on this for urgent issues)incidentNotes(string) — details about what happened
incidentType— eitherREFUND_REQUESTorCOURIER_NOTESincidentSubtype— the refund-request type (see below)incidentFileUrl/incidentFileUrls— links to supporting file attachmentsrequestAmountDeliveryFeeCents,requestAmountOrderValueCents,requestAmountTipCents— the amounts you’re requesting back
Refund requests
A refund request captures what you asked for, what was granted, and the supporting context. Retrieve them by task or job with Get refund requests (GET /v1/refund-requests) — at least one of taskId or jobId is required — or fetch a single request by its ID with Get refund request (GET /v1/refund-request/{id}).
A refund request includes, among other fields:
- Identity and linkage:
id,jobId,taskId,organizationId,createdAt, andresolutionDate - The classification and context:
incidentSubtype,incidentNotes, and the courier’sresponse - The requested amounts:
requestAmountCentsplus the per-bucketrequestAmountDeliveryFeeCents,requestAmountOrderValueCents, andrequestAmountTipCents - The granted amounts:
refundAmountCentsplus the per-bucketrefundAmountDeliveryFeeCents,refundAmountOrderValueCents, andrefundAmountTipCents, in the givencurrency - The current
statusand anyproofOfRefund
Amounts are split into three buckets — delivery fee, order value, and tip — on both the requested and granted sides, so you can see exactly which part of a delivery was refunded.
Statuses
A refund request carries astatus that reflects where it is in review. Statuses you may see include:
The plain-language meanings are summarized here for convenience; treat the status string itself as the source of truth when reconciling a request’s state in your system.
Next steps
Create delivery incident
Report a problem with a delivery and optionally request a refund.
Get refund requests
List refund requests for a task or job.
Get refund request
Retrieve a single refund request, including its status.