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

# Gets a shipment details

`GET /shipments/v4/{shipmentId}`

Gets details of a specific shipment identified by the `shipmentId`.

## Response `200`

Success.

The shipment information was returned

- object — Shipment details
  - `autoStart` boolean, required — A boolean parameter defining whether the shipment starts upon exiting the first origin location.
  - `calculatedEta` string, date-time — Calculated ETA for the shipment
  - `calculatedEtd` string, date-time — Calculated ETD for the shipment
  - `createdAt` string, date-time — Timestamp indicating when the shipment has been created
  - `description` string — Description of the shipment
  - `endedAt` string, date-time — Timestamp indicating when the shipment ended
  - `name` string — Name of the shipment
  - `providedEta` string, date-time — User provided ETA for the shipment
  - `providedEtd` string, date-time — User provided ETD for the shipment
  - `ruleIds` string[] — Array of `ruleId`s to associate with the shipment
  - `segments` object[], required — Array containing the segment details
    - `calculatedEta` string, date-time — Calculated ETA for the segment
    - `calculatedEtd` string, date-time — Calculated ETD for the segment
    - `createdAt` string, date-time — Timestamp indicating when this segment created
    - `description` string — Description of the segment
    - `destination` string — Destination location of this segment
    - `endedAt` string, date-time — Timestamp indicating when this segment ended
    - `name` string — Name of the segment
    - `origin` string — Origin location of this segment
    - `providedEta` string, date-time — User provided ETA for the segment
    - `providedEtd` string, date-time — User provided ETD for the segment
    - `segmentId` string — Segment ID
    - `startedAt` string, date-time — Timestamp indicating when this segment started
    - `status` 'pending' | 'ongoing' | 'completed' | 'cancelled' — Status of the segment
    - `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`. Alternatively, a valid `shipmentId` may be used.
    - `transportMode` 'car' | 'truck' | 'sea' | 'air' | 'undefined' — Transport mode of the segment
  - `shipmentId` string, required — Shipment ID
  - `shipmentPlanId` string — A shipment plan's id that the shipment was generated from.
  - `startedAt` string, date-time — Timestamp indicating when the shipment started
  - `status` 'pending' | 'ongoing' | 'completed' | 'cancelled', required — Status of the shipment
  - `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/versions/efa162f7023c/schema)