> ## 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.

# Simulate Delivery Status Transition

> Advance a delivery to a given status for testing in sandbox.

<Note>
  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.
</Note>

## Supported statuses

Pass one of the following values as the `status` field in the request body:

| Status                 | Description                                    |
| ---------------------- | ---------------------------------------------- |
| `assigned_driver`      | A driver has been assigned to the delivery     |
| `pickup_enroute`       | Driver is en route to the pickup location      |
| `pickup_arrived`       | Driver has arrived at the pickup location      |
| `pickup_complete`      | Driver has picked up the order                 |
| `dropoff_enroute`      | Driver is en route to the dropoff location     |
| `dropoff_arrived`      | Driver has arrived at the dropoff location     |
| `dropoff_complete`     | Order has been delivered to the customer       |
| `return_in_progress`   | Driver is returning the order                  |
| `return_arrived`       | Driver has arrived back at the return location |
| `returned`             | Order has been returned                        |
| `canceled_by_provider` | Provider canceled the delivery                 |
| `failed`               | Delivery failed                                |


## OpenAPI

````yaml post /v1/deliveries/{delivery_id}/simulate
openapi: 3.1.0
info:
  title: Nash API
  version: 1.0.0
servers:
  - url: https://api.sandbox.usenash.com
    description: Sandbox API
  - url: https://api.sandbox.ap-southeast-2.usenash.com
    description: Sandbox API (Australia)
  - url: https://api.usenash.com
    description: Production API
  - url: https://api.ap-southeast-2.usenash.com
    description: Production API (Australia)
security: []
tags:
  - name: Notifications
    description: Notifications
    x-nash-topic: config
  - name: Annotate
    description: Annotate
    x-nash-topic: wismo
  - name: Notifications — Send
    description: One-off notification send without a NotificationTrigger.
    x-nash-topic: notifications
  - name: Shipping
    description: Shipping operations
    x-nash-topic: shipping
  - name: Workflow
    description: Workflow automation management
    x-nash-topic: scheduling
  - name: Workflow Execution
    description: Workflow execution history and monitoring
    x-nash-topic: scheduling
  - name: Optimization Strategies
    description: Create, read, update, and delete route optimization strategies.
    x-nash-topic: scheduling
  - name: AI Agents
    description: AI agent management — create, read, update, and delete agents
    x-nash-topic: config
  - name: AI Functions
    description: LLM-backed domain tools
    x-nash-topic: ai
  - name: Webhooks
    description: Webhook delivery inspection
    x-nash-topic: webhooks
  - name: Fleet Simulator
    description: Simulate delivery status transitions in dev and sandbox environments.
    x-nash-topic: testing
  - name: Miscellaneous
    description: Miscellaneous
  - name: Job
    description: Job
    x-nash-topic: wismo
  - name: Batch Job
    description: Batch Job
    x-nash-topic: wismo
  - name: Order
    description: Order
    x-nash-topic: wismo
  - name: Route
    description: Route
    x-nash-topic: scheduling
  - name: Provider
    description: Provider
    x-nash-topic: provider
  - name: Dispatch Strategies
    description: Dispatch Strategies
    x-nash-topic: scheduling
  - name: Store Locations
    description: Store Locations
    x-nash-topic: config
  - name: Vehicles
    description: Vehicles
    x-nash-topic: provider
  - name: Couriers
    description: Couriers
    x-nash-topic: provider
  - name: Shifts
    description: Shifts
    x-nash-topic: provider
  - name: Delivery Windows
    description: Delivery Windows
    x-nash-topic: config
  - name: Templates
    description: Templates
    x-nash-topic: config
  - name: Zones
    description: Zones
    x-nash-topic: config
  - name: Feedback
    description: Feedback
    x-nash-topic: reporting
  - name: Organizations
    description: Organizations
    x-nash-topic: config
  - name: Store Catalog
    description: Store Catalog
    x-nash-topic: config
  - name: Messaging
    description: Messaging
    x-nash-topic: config
  - name: Contracts
    description: Provider contract pricing and version listings
    x-nash-topic: provider
  - name: Event Timeline
    description: Entity-scoped event timeline + outbound provider traffic for one entity.
    x-nash-topic: internal
  - name: Fleet
    description: Inbound endpoints fleets call to update in-flight deliveries.
    x-nash-topic: delivery
  - name: Route Restrictions
    description: Org-scoped geographic areas the route optimizer must avoid traversing.
    x-nash-topic: config
  - name: Users
    description: User, role, and organization-membership management.
    x-nash-topic: config
paths:
  /v1/deliveries/{delivery_id}/simulate:
    post:
      tags:
        - Fleet Simulator
      summary: Simulate Delivery Status Transition
      description: >-
        Advance a delivery to the given status. Only available in dev and
        sandbox, and only for deliveries whose provider is the manual fleet
        simulator.
      operationId: >-
        simulate_delivery_status_v1_deliveries__string_delivery_id__simulate_post
      parameters:
        - name: deliveryId
          in: path
          required: true
          schema:
            title: Deliveryid
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateFleetSimulatorDeliveryStatusInput'
        required: true
      responses:
        '422':
          description: Unprocessable Content
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/NashValidationError'
components:
  schemas:
    UpdateFleetSimulatorDeliveryStatusInput:
      title: UpdateFleetSimulatorDeliveryStatusInput
      required:
        - status
      type: object
      properties:
        status:
          title: Status
          type: string
          description: New delivery status (e.g. 'pickup_complete', 'dropoff_complete').
    NashValidationError:
      title: NashValidationError
      required:
        - error
        - response_status
        - RequestID
      type: object
      properties:
        error:
          $ref: '#/components/schemas/NashErrorDetails'
        response_status:
          title: Response Status
          type: string
        RequestID:
          title: Requestid
          type: string
    NashErrorDetails:
      title: NashErrorDetails
      required:
        - code
        - message
      type: object
      properties:
        code:
          title: Code
          type: string
        message:
          title: Message
          type: string
        details:
          title: Details
          anyOf:
            - type: object
              additionalProperties: true
            - type: 'null'
          default: null

````