Method: networks.shipments.path.commit

  • Commits the shipment path, making it unchangeable except in cases of force majeure, using vehicles.makeUnavailable, hubs.makeUnavailable, or lines.makeUnavailable methods.

  • This action is final and cannot be used to tag a specific path revision.

  • The request requires specifying the shipment name and providing the complete or partial path to be committed.

  • Successful commitment results in a response containing the committed path details.

  • The path can be specified either as a complete path from source to destination using PathToCommit or as a subset of segments using IncompletePathToCommit.

Commits the path of a shipment, indicating that it cannot be changed in the future, even by the user, save for force majeure/act of God indicated by the vehicles.makeUnavailable, hubs.makeUnavailable, lines.makeUnavailable methods. This method is not used to tag a particular revision of a path.

HTTP request

POST https://middlemileoptimization.googleapis.com/v1/{name=networks/*/shipments/*}/path:commit

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The name of the shipment whose path must be committed. Format: "networks/{network}/shipments/{shipment}"

Request body

The request body contains data with the following structure:

JSON representation 
{

  // Union field path_to_commit can be only one of the following:
  "completeShipmentPath": {
    object (PathToCommit)
  },
  "segments": {
    object (IncompletePathToCommit)
  }
  // End of list of possible types for union field path_to_commit.
}
Fields
Union field path_to_commit. The path or parts of the path that should be committed. path_to_commit can be only one of the following:
completeShipmentPath

object (PathToCommit)

The segments of a path from a source to a destination.
segments

object (IncompletePathToCommit)

A subset of the segments of a path from a source to a destination.

Response body

If successful, the response body contains an instance of Path.

PathToCommit

Full path being committed, from source to destination.

JSON representation 
{
  "segments": [
    {
      object (PathSegment)
    }
  ]
}
Fields
segments[]

object (PathSegment)

Required. Segments must be in order, from a source to a destination.

IncompletePathToCommit

Part of path being committed, i.e. some segments between the source and the destination.

JSON representation 
{
  "segments": [
    {
      object (PathSegment)
    }
  ]
}
Fields
segments[]

object (PathSegment)

Required. A subset of the segments of a path from a source to a destination.