---
title: "Get Dispatch Plan"
method: GET
path: "/v1/plans/{planId}"
tags: ["Dispatch plans"]
---

# Get Dispatch Plan

`GET /v1/plans/{planId}`

## Request

- Base URL: `https://api.sandbox.usenash.com`
- URL: `https://api.sandbox.usenash.com/v1/plans/{planId}`
- Auth: none declared

A dispatch plan's draft as a summary: totals, issues, one line per route and the first unplanned order ids. Read a route's stops with Get Dispatch Plan Route. `isClean` is false while someone has unsaved changes.

## Path parameters

- `planId` string, required

## Response `200`

OK

- PlanDigest
  - `planId` string, required
  - `revision` integer, required
  - `contentHash` string, required
  - `isClean` boolean, required
  - `name` string, required
  - `source` 'orders' | 'routes' | 'snapshot', required
  - `startDate` string, date, nullable, required
  - `endDate` string, date, nullable, required
  - `timezoneId` string, nullable, required
  - `zoneIds` string[], required
  - `totals` PlanDigestTotals, required
    - `routes` integer, required
    - `stops` integer, required
    - `orders` integer, required
    - `unplanned` integer, required
    - `distanceMeters` number, nullable, required
    - `durationSeconds` number, nullable, required
  - `issues` PlanDigestIssue[], required
    - `code` 'ROUTE_NOT_CALCULATED' | 'ORDER_INPUTS_NOT_CAPTURED', required
    - `routeId` string, nullable
    - `orderId` string, nullable
    - `message` string, required
  - `issueCount` integer, required
  - `routes` PlanDigestRoute[], required
    - `routeId` string, required
    - `label` string, nullable, required
    - `vehicleId` string, nullable, required
    - `stops` integer, required
    - `orders` integer, required
    - `start` string, date-time, nullable, required
    - `end` string, date-time, nullable, required
    - `warnings` string[], required
  - `unplannedOrderIds` string[], required
  - `unplannedCount` integer, required

## Other responses

- `422`: Unprocessable Content

---

[API](https://skmtc.dev/nash/apis/nash-api.md) - [All operations](https://skmtc.dev/nash/apis/nash-api/llms.txt) - [OpenAPI document](https://skmtc.dev/nash/apis/nash-api/revisions/e3713837c5c9?raw)