v1

latestOpenAPI 3.0.0HERE Documentation License2026-07-142162791.8 MB

Shipments

Updates a segment plan details

Updates details of a segment plan identified by the segmentPlanId.

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

Note: Updating origin and destination is prohibited to prevent breaking the chain of locations.

patch/shipments/v4/plans/{shipmentPlanId}/{segmentPlanId}

Request body

descriptionstring

Description of the segment

durationSinteger

Segment duration in seconds.

namestring

Name of the segment

trackingIdstring

ID of the tracking device that produces data for this segment

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

Transport mode of the segment

Example request

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

Response

Successful (no content)

The segment plan information was updated