Skip to main content
POST
/
v1
/
deliveries
/
{delivery_id}
/
simulate
Simulate Delivery Status Transition
curl --request POST \
  --url https://api.sandbox.usenash.com/v1/deliveries/{delivery_id}/simulate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "status": "assigned_driver"
}
'
[
  {
    "error": {
      "code": "<string>",
      "message": "<string>"
    },
    "response_status": "<string>",
    "RequestID": "<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.

This endpoint is intended to simulate delivery status transitions in sandbox only. It is available in dev and sandbox environments, and only for deliveries dispatched to the Nash sandbox test provider. Use it to test how your integration reacts to delivery status changes without needing a real courier.

​
Supported statuses

Pass one of the following values as the status field in the request body:
StatusDescription
assigned_driverA driver has been assigned to the delivery
pickup_enrouteDriver is en route to the pickup location
pickup_arrivedDriver has arrived at the pickup location
pickup_completeDriver has picked up the order
dropoff_enrouteDriver is en route to the dropoff location
dropoff_arrivedDriver has arrived at the dropoff location
dropoff_completeOrder has been delivered to the customer
return_in_progressDriver is returning the order
return_arrivedDriver has arrived back at the return location
returnedOrder has been returned
canceled_by_providerProvider canceled the delivery
failedDelivery failed

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
deliveryId
string
required

Body

application/json
​
status
enum<string>
required

New delivery status to transition the delivery to.

Available options:
assigned_driver,
pickup_enroute,
pickup_arrived,
pickup_complete,
dropoff_enroute,
dropoff_arrived,
dropoff_complete,
return_in_progress,
return_arrived,
returned,
canceled_by_provider,
failed

Response

400 - application/json

Bad Request

​
error
NashErrorDetails · object
required
​
response_status
string
required
​
RequestID
string
required