| Name | Description | Type | Additional information |
|---|---|---|---|
| RouteId |
The number that identifies the route. |
integer |
Required |
| Distance |
Either the total distance or the longest distance of the route. If this is the total distance, then do NOT set the ExtraDistance value. The default UOM is km (kilometre). |
decimal number |
Required |
| DistanceUOM |
The unit of measurement for the distance. The default UOM is km (kilometre). |
string |
None. |
| DrivingTime |
The driving time of the route, in hours. |
decimal number |
Required |
| ExtraDistance |
The extra distance to reach the stops outside the longest distance. The default UOM is km (kilometre). For example: If route 01 includes stops A, B, C and D, and the longest distance is from A to B, then the extra distance are the extra kilometers required to reach C and D. |
decimal number |
None. |
| ExtraStopCount |
The number of stops outside the longest distance. |
integer |
None. |
| ExtraPickupStopCount |
The number of pickup stops outside the longest distance. |
integer |
None. |
| ExtraDeliveryStopCount |
The number of delivery stops outside the longest distance. |
integer |
None. |
| Shipments |
The list of shipments in the route. |
Collection of Shipment |
Required |
| Stops |
The list of stops in the route. |
Collection of RouteStop |
Required |