v1

latestOpenAPI 3.0.0HERE Documentation License2026-07-142162791.8 MB
Shipments

Updates a shipment plan details

Updates details of a shipment plan identified by the shipmentPlanId. This is a partial update, meaning that only the provided fields will be updated. If ruleIds field is specified, it will replace the existing rules currently associated with the shipment plan.

Note: segments cannot be edited through this API. Changing the order of the segments in a plan would cause shipments created from earlier versions of the plan diverge from a shipment instantiated from the new plan with different segment structure. Individual segments can still be updated via the shipments/v4/plans/{shipmentPlanId}/{segmentPlanId} endpoint.

patch/shipments/v4/plans/{shipmentPlanId}

Request body

autoStartboolean

A boolean parameter defining whether the shipment starts upon exiting the first origin location.

descriptionstring

Description of the shipment

namestring

Name of the shipment

ruleIdsstring[]

Array of ruleIds to associate with the shipment

subShipmentboolean

Flag telling if shipment is a subShipment.

Response

Successful (no content)

The shipment plan information was updated