Sign in

v1

latestOpenAPI 3.1.02026-07-2296226496.3 KB
Job

Create delivery incident

Report a delivery incident such as a damaged package, missing items, or late delivery. Creates an incident record linked to the specified task.

post/v1/jobs/{jobId}/tasks/{taskId}/delivery_incident

Path parameters

jobIdstring required

job id

job id

taskIdstring required

task id

task id

Request body

raiseIncidentboolean required

Flag delivery to be reviewed by Nash's team (not for urgent cases). Set to False to indicate issue has been resolved

incidentNotesstring required

Details about incident

incidentType'REFUND_REQUEST' | 'COURIER_NOTES'

Courier Notes or Refund Request

incidentSubtype'arrived_late' | 'delivered_early' | 'delivered_to_wrong_address' | 'missing_or_incorrect_items' | 'never_delivered' | 'poor_delivery_experience' | 'other'
incidentFileUrlstring nullable

Url to file attachment for refund request

incidentFileUrlsstring[] nullable

Urls to file attachments for refund request

requestAmountDeliveryFeeCentsinteger nullable

The request amount for the delivery fee in cents.

requestAmountOrderValueCentsinteger nullable

The request amount for the order value in cents.

requestAmountTipCentsinteger nullable

The request amount for the tip in cents.

Response

OK

jobIdstring required
taskIdstring required
raiseIncidentboolean required
incidentNotesstring required
incidentTypestring nullable required
incidentSubtypestring nullable required
incidentFileUrlstring nullable required
incidentFileUrlsstring[] nullable required
refundRequestIdstring nullable

The ID of the refund request.

requestAmountDeliveryFeeCentsinteger nullable

The request amount for the delivery fee in cents.

requestAmountOrderValueCentsinteger nullable

The request amount for the order value in cents.

requestAmountTipCentsinteger nullable

The request amount for the tip in cents.