Method: networks.shipments.path.update

  • Enables users to define a custom route for a shipment, overriding the service's calculated path.

  • Requires an HTTP POST request to a specific endpoint, including the shipment identifier.

  • Utilizes the Path object within the request and response bodies to specify and return the route information.

Changes the path of a shipment: instead of using the service-computed one, the state will contain the one set by the user through this call.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
path.shipment

string

Required. Shipment whose path is being described.

Request body

The request body contains an instance of Path.

Response body

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