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

# Get Route

> Retrieve a route by ID, including its stops, travel metrics, and associated orders.

A `Route` object represents a planned sequence of stops for a vehicle or delivery agent.

The core of the `Route` is the `stops` array, which lists the specific locations to visit in order. Each stop within this array details:

* The actions to be performed (like `stopType`).
* Associated items (`objectIds`).
* Timing estimates (`arrivalTime`, `departTime`, `serviceTime`).
* Travel details from the prior stop (`distanceFromPrevious`, `durationFromPrevious`).
* The physical coordinates (`location`).


## OpenAPI

````yaml get /v1/routes/{id}
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/routes/{id}:
    get:
      tags:
        - Route
      summary: Get Route
      description: >-
        Retrieve a route by ID, including its stops, travel metrics, and
        associated orders.
      operationId: get_route_v1_routes__string_id__get
      parameters:
        - name: id
          in: path
          description: Route ID
          required: true
          schema:
            title: Id
            type: string
            description: Route ID
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RouteSerializer'
        '422':
          description: Unprocessable Content
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/NashValidationError'
components:
  schemas:
    RouteSerializer:
      title: RouteSerializer
      required:
        - id
        - portalUrl
        - type
        - stops
      type: object
      properties:
        id:
          title: Id
          type: string
          description: Unique identifier for the route.
          example: rte_JphRWDiEosGpXuxwgaYfY3
        externalId:
          title: Externalid
          anyOf:
            - type: string
            - type: 'null'
          description: External Route ID.
          default: null
          example: rte_JphRWDiEosGpXuxwgaYfY3
        portalUrl:
          title: Portalurl
          type: string
          description: Portal URL of the route.
          example: https://portal.usenash.com/routes/rte_JphRWDiEosGpXuxwgaYfY3
        name:
          title: Name
          anyOf:
            - type: string
            - type: 'null'
          description: Name of the route.
          default: null
          example: Route 1
        type:
          title: Type
          type: string
          description: Type of the route, indicating the pickup/dropoff structure.
          example: SINGLE_PICKUP_MULTIPLE_DROPOFFS
        courierId:
          title: Courierid
          anyOf:
            - type: string
            - type: 'null'
          description: Courier ID of the driver assigned to the route.
          default: null
          example: cou_1234567890abcdef12345678
        vehicleId:
          title: Vehicleid
          anyOf:
            - type: string
            - type: 'null'
          description: Vehicle ID of the vehicle assigned to the route.
          default: null
          example: vhc_1234567890abcdef12345678
        courier:
          anyOf:
            - $ref: '#/components/schemas/CourierSerializer'
            - type: 'null'
          description: Courier/driver details for the route.
          default: null
        driverGroup:
          anyOf:
            - $ref: '#/components/schemas/DriverGroupSerializer'
            - type: 'null'
          description: Driver group assigned to the route.
          default: null
        courierPosition:
          anyOf:
            - $ref: '#/components/schemas/CourierPositionSerializer'
            - type: 'null'
          description: Current GPS position of the assigned courier.
          default: null
        vehicle:
          anyOf:
            - $ref: '#/components/schemas/VehicleSerializer'
            - type: 'null'
          description: Vehicle details for the route.
          default: null
        providerName:
          title: Providername
          anyOf:
            - type: string
            - type: 'null'
          description: Name of the delivery provider assigned to this route.
          default: null
        shiftId:
          title: Shiftid
          anyOf:
            - type: string
            - type: 'null'
          description: Shift ID of the shift assigned to the route.
          default: null
          example: shf_1234567890abcdef12345678
        stops:
          title: Stops
          type: array
          items:
            $ref: '#/components/schemas/RouteStopSerializer'
          description: Ordered list of stops included in the route.
        isDispatched:
          title: Isdispatched
          type: boolean
          description: Whether the route is dispatched.
          default: false
        jobId:
          title: Jobid
          anyOf:
            - type: string
            - type: 'null'
          description: Dispatched Job ID of this route
          default: null
          example: job_1234567890abcdef12345678
        routeMetadata:
          title: Routemetadata
          anyOf:
            - type: object
              additionalProperties: true
            - type: 'null'
          description: Additional metadata for the route.
          default: null
          example:
            priority: high
            source: optimization_engine
        validationErrors:
          title: Validationerrors
          anyOf:
            - type: object
              additionalProperties:
                type: string
            - type: 'null'
          description: Validation errors for the route.
          default: null
          example:
            order_123: Order 123 has pickup but no dropoff
        encodedPolyline:
          title: Encodedpolyline
          anyOf:
            - type: string
            - type: 'null'
          description: Encoded polyline representing the route geometry.
          default: null
        status:
          title: Status
          anyOf:
            - type: string
            - type: 'null'
          description: Current status of the route.
          default: null
          example: CREATED
        statusHistory:
          title: Statushistory
          anyOf:
            - type: array
              items:
                type: object
                additionalProperties:
                  type: string
            - type: 'null'
          description: History of status changes for the route.
          default: null
          example:
            - created_at: '2025-04-25T03:00:00Z'
              status: CREATED
            - created_at: '2025-04-25T03:10:00Z'
              status: ASSIGNED
            - created_at: '2025-04-25T03:15:00Z'
              status: STARTED
      description: Represents a planned sequence of stops for a delivery or batch.
    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
    CourierSerializer:
      title: CourierSerializer
      type: object
      properties:
        id:
          title: Id
          anyOf:
            - type: string
            - type: 'null'
          default: null
        firstName:
          title: Firstname
          anyOf:
            - type: string
            - type: 'null'
          default: null
        lastName:
          title: Lastname
          anyOf:
            - type: string
            - type: 'null'
          default: null
        phoneNumber:
          title: Phonenumber
          anyOf:
            - type: string
            - type: 'null'
          default: null
      description: Courier details for a route.
    DriverGroupSerializer:
      title: DriverGroupSerializer
      type: object
      properties:
        id:
          title: Id
          anyOf:
            - type: string
            - type: 'null'
          default: null
        externalId:
          title: Externalid
          anyOf:
            - type: string
            - type: 'null'
          default: null
      description: Driver group details for a route.
    CourierPositionSerializer:
      title: CourierPositionSerializer
      required:
        - lat
        - lng
      type: object
      properties:
        lat:
          title: Lat
          type: number
          description: Latitude coordinate.
        lng:
          title: Lng
          type: number
          description: Longitude coordinate.
        updatedAt:
          title: Updatedat
          anyOf:
            - type: string
            - type: 'null'
          description: Timestamp when the position was last updated on the server.
          default: null
        capturedAt:
          title: Capturedat
          anyOf:
            - type: string
            - type: 'null'
          description: Timestamp when the GPS position was captured on driver's device.
          default: null
        accuracy:
          title: Accuracy
          anyOf:
            - type: number
            - type: 'null'
          description: Estimated horizontal accuracy radius in meters.
          default: null
        heading:
          title: Heading
          anyOf:
            - type: number
            - type: 'null'
          description: Heading in degrees relative to true north.
          default: null
        speed:
          title: Speed
          anyOf:
            - type: number
            - type: 'null'
          description: Speed in meters per second.
          default: null
        altitude:
          title: Altitude
          anyOf:
            - type: number
            - type: 'null'
          description: Altitude in meters above sea level.
          default: null
        altitudeAccuracy:
          title: Altitudeaccuracy
          anyOf:
            - type: number
            - type: 'null'
          description: Estimated altitude accuracy in meters.
          default: null
        batteryLevel:
          title: Batterylevel
          anyOf:
            - type: number
            - type: 'null'
          description: Battery level from 0.0 to 1.0, if provided by device.
          default: null
        batteryIsCharging:
          title: Batteryischarging
          anyOf:
            - type: boolean
            - type: 'null'
          description: Whether the device is currently charging.
          default: null
        isMoving:
          title: Ismoving
          anyOf:
            - type: boolean
            - type: 'null'
          description: Whether the device is currently detected as moving.
          default: null
      description: Current GPS position of a courier.
    VehicleSerializer:
      title: VehicleSerializer
      type: object
      properties:
        licensePlate:
          title: Licenseplate
          anyOf:
            - type: string
            - type: 'null'
          default: null
        make:
          title: Make
          anyOf:
            - type: string
            - type: 'null'
          default: null
        model:
          title: Model
          anyOf:
            - type: string
            - type: 'null'
          default: null
        color:
          title: Color
          anyOf:
            - type: string
            - type: 'null'
          default: null
        year:
          title: Year
          anyOf:
            - type: integer
            - type: 'null'
          default: null
        type:
          title: Type
          anyOf:
            - type: string
            - type: 'null'
          default: null
      description: Vehicle details for a route.
    RouteStopSerializer:
      title: RouteStopSerializer
      required:
        - stopType
        - objectIds
        - location
      type: object
      properties:
        stopType:
          title: Stoptype
          type: string
          description: Type of the stop.
          example: PICKUP
        objectIds:
          title: Objectids
          type: array
          items:
            type: string
          description: >-
            List of object IDs (e.g., order IDs, store location IDs) associated
            with this stop.
          example:
            - ord_Qr5bVt8WiByGh66z2g7xEu
            - ord_WJFuooSiRvFCaceGZjpbqs
        arrivalTime:
          title: Arrivaltime
          anyOf:
            - type: string
            - type: 'null'
          description: Estimated arrival time at the stop (UTC).
          default: null
          example: '2025-04-25T03:27:00'
        departTime:
          title: Departtime
          anyOf:
            - type: string
            - type: 'null'
          description: Estimated departure time from the stop (UTC).
          default: null
          example: '2025-04-25T03:30:00'
        serviceTime:
          title: Servicetime
          anyOf:
            - type: number
            - type: 'null'
          description: Estimated service time spent at the stop (in seconds).
          default: null
          example: 360
        distanceFromPrevious:
          title: Distancefromprevious
          anyOf:
            - type: number
            - type: 'null'
          description: Distance traveled from the previous stop (in meters).
          default: null
          example: 3376
        durationFromPrevious:
          title: Durationfromprevious
          anyOf:
            - type: number
            - type: 'null'
          description: Travel duration from the previous stop (in seconds).
          default: null
          example: 420
        location:
          anyOf:
            - $ref: '#/components/schemas/LatLngSerializer'
            - type: 'null'
          description: >-
            Geographic location of the stop. Can be null for non-location based
            stops like breaks.
        status:
          title: Status
          anyOf:
            - type: string
            - type: 'null'
          description: Current status of the stop.
          default: null
          example: PENDING
        statusDescription:
          title: Statusdescription
          anyOf:
            - type: string
            - type: 'null'
          description: Detailed description of the current status of the stop.
          default: null
          example: leave_unattended
        statusHistory:
          title: Statushistory
          anyOf:
            - type: array
              items:
                type: object
                additionalProperties:
                  anyOf:
                    - type: string
                    - type: 'null'
            - type: 'null'
          description: History of status changes for the stop.
          default: null
          example:
            - created_at: '2025-04-25T03:00:00Z'
              status: PENDING
            - created_at: '2025-04-25T03:15:00Z'
              status: ENROUTE
            - created_at: '2025-04-25T03:20:00Z'
              status: COMPLETED
              status_description: leave_unattended
        metadata:
          title: Metadata
          anyOf:
            - type: object
              additionalProperties: true
            - type: 'null'
          description: Additional metadata for this stop.
          default: null
        startedAt:
          title: Startedat
          anyOf:
            - type: string
            - type: 'null'
          description: Timestamp when the stop entered IN_PROGRESS status (UTC).
          default: null
          example: '2025-04-25T03:27:00Z'
        breakDuration:
          title: Breakduration
          anyOf:
            - type: integer
            - type: 'null'
          description: >-
            Duration in seconds of the break at this stop (for DRIVER_BREAK
            stops).
          default: null
        orders:
          title: Orders
          anyOf:
            - type: array
              items:
                $ref: '#/components/schemas/StopOrderSerializer'
            - type: 'null'
          description: >-
            Orders associated with this stop, including tracking URLs and
            delivery details.
          default: null
      description: Represents a single stop within a planned route.
    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
    LatLngSerializer:
      title: LatLngSerializer
      required:
        - lat
        - lng
      type: object
      properties:
        lat:
          title: Lat
          type: number
          description: Latitude coordinate.
          example: 45.558214
        lng:
          title: Lng
          type: number
          description: Longitude coordinate.
          example: -122.587074
      description: Latitude/longitude coordinates.
    StopOrderSerializer:
      title: StopOrderSerializer
      required:
        - id
      type: object
      properties:
        id:
          title: Id
          type: string
          description: Order ID.
          example: ord_Qr5bVt8WiByGh66z2g7xEu
        externalId:
          title: Externalid
          anyOf:
            - type: string
            - type: 'null'
          description: External identifier for the order.
          default: null
        publicTrackingUrl:
          title: Publictrackingurl
          anyOf:
            - type: string
            - type: 'null'
          description: Public tracking URL for the order.
          default: null
        pod:
          title: Pod
          anyOf:
            - type: array
              items:
                $ref: '#/components/schemas/ProofOfDeliverySerializer'
            - type: 'null'
          description: Proof of delivery data (photos, signature, etc.) if captured.
          default: null
        orderItems:
          title: Orderitems
          anyOf:
            - type: array
              items:
                $ref: '#/components/schemas/OrderItemSerializer'
            - type: 'null'
          description: >-
            Items with lifecycle status tracking (picked, delivered, failed,
            etc.).
          default: null
      description: Order information associated with a route stop.
    ProofOfDeliverySerializer:
      title: ProofOfDeliverySerializer
      required:
        - type
      type: object
      properties:
        type:
          title: Type
          type: string
          description: Type of proof of delivery, e.g., 'photo', 'signature', etc.
        url:
          title: Url
          anyOf:
            - type: string
            - type: 'null'
          description: URL of the proof of delivery document.
          default: null
        uploadedAt:
          title: Uploadedat
          anyOf:
            - type: string
            - type: 'null'
          description: Timestamp when the proof of delivery was uploaded.
          default: null
      description: Delivery tracking details for an order at a route stop.
    OrderItemSerializer:
      title: OrderItemSerializer
      type: object
      properties:
        id:
          title: Id
          anyOf:
            - type: string
            - type: 'null'
          description: The merchant ID of the item
          default: null
          example: item-001
        description:
          title: Description
          anyOf:
            - type: string
            - type: 'null'
          description: The description of the item
          default: null
        count:
          title: Count
          anyOf:
            - type: integer
            - type: 'null'
          description: The quantity of the item
          default: null
        valueCents:
          title: Valuecents
          anyOf:
            - type: integer
            - type: 'null'
          description: The value of the item in cents
          default: null
        barcode:
          title: Barcode
          anyOf:
            - type: string
            - type: 'null'
          description: Barcode associated with the item
          default: null
        sku:
          title: Sku
          anyOf:
            - type: string
            - type: 'null'
          description: SKU of the item
          default: null
        category:
          title: Category
          anyOf:
            - type: string
            - type: 'null'
          description: The category of the item
          default: null
        status:
          title: Status
          anyOf:
            - type: string
            - type: 'null'
          description: Current lifecycle status of the item.
          default: null
          example: delivered
        availableQuantity:
          title: Availablequantity
          anyOf:
            - type: integer
            - type: 'null'
          description: Quantity available after pickup (may differ from count)
          default: null
        statusMetadata:
          anyOf:
            - $ref: '#/components/schemas/ItemStatusMetadataSerializer'
            - type: 'null'
          description: Operational metadata tracked during the item's lifecycle.
          default: null
        statusHistory:
          title: Statushistory
          anyOf:
            - type: array
              items:
                $ref: '#/components/schemas/ItemStatusHistoryEntrySerializer'
            - type: 'null'
          description: History of status changes for this item.
          default: null
        subItems:
          title: Subitems
          anyOf:
            - type: array
              items:
                $ref: '#/components/schemas/OrderItemSerializer'
            - type: 'null'
          description: Nested sub-items with their own status tracking.
          default: null
      description: >-
        Item with status tracking for route stop webhook payloads.


        Combines item definition with lifecycle status from the route state
        machine.
    ItemStatusMetadataSerializer:
      title: ItemStatusMetadataSerializer
      type: object
      properties:
        pickedAt:
          title: Pickedat
          anyOf:
            - type: string
            - type: 'null'
          description: Timestamp when the item was picked up
          default: null
        deliveredAt:
          title: Deliveredat
          anyOf:
            - type: string
            - type: 'null'
          description: Timestamp when the item was delivered
          default: null
        failedAt:
          title: Failedat
          anyOf:
            - type: string
            - type: 'null'
          description: Timestamp when the item delivery failed
          default: null
        returnedAt:
          title: Returnedat
          anyOf:
            - type: string
            - type: 'null'
          description: Timestamp when the item was returned
          default: null
        failureReason:
          title: Failurereason
          anyOf:
            - type: string
            - type: 'null'
          description: Reason for delivery failure
          default: null
        failureLocation:
          title: Failurelocation
          anyOf:
            - type: string
            - type: 'null'
          description: 'Where the failure occurred: ''pickup'' or ''dropoff'''
          default: null
          example: dropoff
      description: Operational metadata tracked during item lifecycle in route delivery.
    ItemStatusHistoryEntrySerializer:
      title: ItemStatusHistoryEntrySerializer
      required:
        - status
        - createdAt
      type: object
      properties:
        status:
          title: Status
          type: string
          description: Item status at this point in time
          example: picked
        createdAt:
          title: Createdat
          type: string
          description: Timestamp of the status change
          example: '2025-04-25T03:20:00'
      description: A single status change entry in an item's status history.

````