Modules§

Structs§

  • The BatchCreateTask request message.
  • The BatchCreateTask response message.
  • The CreateDeliveryVehicle request message.
  • The CreateTask request message.
  • A RequestHeader contains fields common to all Delivery RPC requests.
  • The DeliveryVehicle message. A delivery vehicle transports shipments from a depot to a delivery location, and from a pickup location to the depot. In some cases, delivery vehicles also transport shipments directly from the pickup location to the delivery location.
  • Describes a vehicle attribute as a key-value pair. The “key:value” string length cannot exceed 256 characters.
  • The location, speed, and heading of a vehicle at a point in time.
  • The GetDeliveryVehicle request message.
  • The GetTask request message.
  • The GetTaskTrackingInfoRequest request message.
  • The ListDeliveryVehicles request message.
  • The ListDeliveryVehicles response message.
  • The ListTasks request message.
  • The ListTasks response that contains the set of Tasks that meet the filter criteria in the ListTasksRequest.
  • A location with any additional identifiers.
  • A Task in the Delivery API represents a single action to track. In general, there is a distinction between shipment-related Tasks and break Tasks. A shipment can have multiple Tasks associated with it. For example, there could be one Task for the pickup, and one for the drop-off or transfer. Also, different Tasks for a given shipment can be handled by different vehicles. For example, one vehicle could handle the pickup, driving the shipment to the hub, while another vehicle drives the same shipment from the hub to the drop-off location.
  • Describes a task attribute as a key-value pair. The “key:value” string length cannot exceed 256 characters.
  • The TaskTrackingInfo message. The message contains task tracking information which will be used for display. If a tracking ID is associated with multiple Tasks, Fleet Engine uses a heuristic to decide which Task’s TaskTrackingInfo to select.
  • The configuration message that defines when a data element of a Task should be visible to the end users.
  • A time range.
  • The UpdateDeliveryVehicle request message.
  • The UpdateTask request message.
  • Represents a Vehicle’s travel segment - from its previous stop to the current stop. If it is the first active stop, then it is from the Vehicle’s current location to this stop.
  • Describes a point where a Vehicle stops to perform one or more Tasks.

Enums§