Skip to main content
POST
/
v1
/
jobs
/
{jobId}
/
tasks
/
{taskId}
/
delivery_incident
Create delivery incident
curl --request POST \
  --url https://api.sandbox.usenash.com/v1/jobs/{jobId}/tasks/{taskId}/delivery_incident \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "raiseIncident": true,
  "incidentNotes": "<string>",
  "incidentType": "COURIER_NOTES",
  "incidentFileUrl": "<string>",
  "incidentFileUrls": [
    "<string>"
  ],
  "requestAmountDeliveryFeeCents": 123,
  "requestAmountOrderValueCents": 123,
  "requestAmountTipCents": 123
}
'
{
  "jobId": "<string>",
  "taskId": "<string>",
  "raiseIncident": true,
  "incidentNotes": "<string>",
  "incidentType": "<string>",
  "incidentSubtype": "<string>",
  "incidentFileUrl": "<string>",
  "incidentFileUrls": [
    "<string>"
  ],
  "refundRequestId": "<string>",
  "requestAmountDeliveryFeeCents": 123,
  "requestAmountOrderValueCents": 123,
  "requestAmountTipCents": 123
}

​
Requirements

At least one of the following fields must be provided:
  • requestAmountDeliveryFeeCents
  • requestAmountOrderValueCents
  • requestAmountTipCents
All provided values must be non-negative integers (≥ 0), and at least one must be greater than zero.

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
jobId
string
required

job id

​
taskId
string
required

task id

Body

application/json
​
raiseIncident
boolean
required

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

​
incidentNotes
string
required

Details about incident

Maximum string length: 512
​
incidentType
enum<string>
default:COURIER_NOTES

Courier Notes or Refund Request

Available options:
REFUND_REQUEST,
COURIER_NOTES
​
incidentSubtype
enum<string> | null

Refund Request type

Available options:
arrived_late,
delivered_early,
delivered_to_wrong_address,
missing_or_incorrect_items,
never_delivered,
poor_delivery_experience,
other
​
incidentFileUrl
string | null

Url to file attachment for refund request

​
incidentFileUrls
string[] | null

Urls to file attachments for refund request

​
requestAmountDeliveryFeeCents
integer | null

The request amount for the delivery fee in cents.

​
requestAmountOrderValueCents
integer | null

The request amount for the order value in cents.

​
requestAmountTipCents
integer | null

The request amount for the tip in cents.

Response

OK

​
jobId
string
required
​
taskId
string
required
​
raiseIncident
boolean
required
​
incidentNotes
string
required
​
incidentType
string | null
required
​
incidentSubtype
string | null
required
​
incidentFileUrl
string | null
required
​
incidentFileUrls
string[] | null
required
​
refundRequestId
string | null

The ID of the refund request.

​
requestAmountDeliveryFeeCents
integer | null

The request amount for the delivery fee in cents.

​
requestAmountOrderValueCents
integer | null

The request amount for the order value in cents.

​
requestAmountTipCents
integer | null

The request amount for the tip in cents.