Sign in

v1

latestOpenAPI 3.0.0HERE Documentation License2026-07-142162791.8 MB
Shipments

Updates a segment details

Updates details of a segment identified by the segmentId.

This is a partial update, meaning that only the provided fields will be updated.

Changing the status of a segment affects the statuses of other segments in the shipment. The following status changes are allowed:

  • pending → ongoing
    • changes previous pending segments to cancelled
    • changes previous ongoing segment to completed (only for the immediate predecessor of this segment)
    • changes previous ongoing segment to cancelled (for segments that are not immediate predecessors of this segment)
    • previous segments in cancelled or completed states are not affected
  • pending || ongoing → cancelled
    • no changes for other segments
  • ongoing → completed
    • next segment with status pending is changed to ongoing

Note: trackingId can be updated through this API call only if the segment is in pending state.

patch/shipments/v4/{shipmentId}/{segmentId}

Request body

descriptionstring

Description of the segment

namestring

Name of the segment

providedEtastring date-time

ETA for the segment

providedEtdstring date-time

ETD for the segment

status'pending' | 'ongoing' | 'completed' | 'cancelled'

Status of the segment

trackingIdstring

ID of the tracking device that produces data for the segment

transportMode'car' | 'truck' | 'sea' | 'air' | 'undefined'

Transport mode of the segment

Example request

{
  "description": "From factory to port",
  "name": "Truck transport",
  "trackingId": "HERE-540bb24b-0d57-4f8c-aeaf-6c91cd0aff8d",
  "transportMode": "truck"
}

Response

Successful (no content)

The segment information was updated