---
title: "Gets a shipment plan details"
method: GET
path: "/shipments/v4/plans/{shipmentPlanId}"
tags: ["Shipments"]
---

# Gets a shipment plan details

`GET /shipments/v4/plans/{shipmentPlanId}`

Gets details of a shipment plan identified by the `shipmentPlanId`.

## Response `200`

Success.

The shipment plan information was returned

- object
  - `autoStart` boolean — A boolean parameter defining whether the shipment starts upon exiting the first origin location.
  - `createdAt` string, date-time — Timestamp indicating when the shipment plan has been created
  - `description` string — Description of the shipment
  - `name` string — Name of the shipment
  - `ruleIds` string[] — Array of `ruleId`s to associate with the shipment
  - `segments` object[], required — Array of objects each defining the origin and destination of the segment
    - `description` string — Description of the segment
    - `destination` string — Destination location of this segment
    - `durationS` integer — Segment duration in seconds.
    - `name` string — Name of the segment
    - `origin` string — Origin location of this segment
    - `segmentPlanId` string — Segment plan ID
    - `trackingId` string — This is a unique ID associated with the device data in HERE Tracking. For physical devices the `trackingId` gets assigned to a device when the device is claimed by a user, and for virtual devices it is an external device ID along with the device project `appId`.
    - `transportMode` 'car' | 'truck' | 'sea' | 'air' | 'undefined' — Transport mode of the segment
  - `shipmentPlanId` string, required — Shipment plan ID
  - `subShipment` boolean — Flag telling if shipment is a subShipment.

## Other responses

- `400` — Bad request The request object is in an incorrect format or has values that are invalid or out of range. If available, further error details are provided in the response body.
- `401` — Unauthorized The request did not provide correct authentication details
- `403` — Forbidden The account does not have the correct privileges
- `404` — Not Found The specified resource was not found

---

[API](https://skmtc.net/here/apis/tracking.md) · [All operations](https://skmtc.net/here/apis/tracking/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/here/tracking/revisions/efa162f7023c/schema)