Method: providers.deliveryVehicles.patch

  • Updates DeliveryVehicle data and assigns Tasks in Fleet Engine, requiring all VehicleJourneySegments for persistence.

  • Supports updating remainingVehicleJourneySegments and assigns corresponding Tasks retrieved from it.

  • Uses the PATCH method with a URL containing the DeliveryVehicle name for identification.

  • Requires a header for Delivery API requests and updateMask specifying fields to update.

  • Provides a response containing the updated DeliveryVehicle instance upon successful completion.

Writes updated DeliveryVehicle data to Fleet Engine, and assigns Tasks to the DeliveryVehicle. You cannot update the name of the DeliveryVehicle. You can update remainingVehicleJourneySegments, but it must contain all of the VehicleJourneySegments to be persisted on the DeliveryVehicle. The taskIds are retrieved from remainingVehicleJourneySegments, and their corresponding Tasks are assigned to the DeliveryVehicle if they have not yet been assigned.

HTTP request

PATCH https://fleetengine.googleapis.com/v1/{deliveryVehicle.name=providers/*/deliveryVehicles/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
deliveryVehicle.name

string

The unique name of this Delivery Vehicle. The format is providers/{provider}/deliveryVehicles/{vehicle}.

Query parameters

Parameters
header

object (DeliveryRequestHeader)

Optional. The standard Delivery API request header.
updateMask

string (FieldMask format)

Required. A field mask that indicates which DeliveryVehicle fields to update. Note that the updateMask must contain at least one field.

This is a comma-separated list of fully qualified names of fields. Example: "remainingVehicleJourneySegments".

Request body

The request body contains an instance of DeliveryVehicle.

Response body

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