Display Name: SolveLastMileDelivery

Description: The Last Mile Delivery service is a use case specific Vehicle Routing Problem (VRP) algorithm designed for a fleet of vehicles that are delivering packages to the final customers. For example, this can be used for a single distribution center or store delivering to the final customer location and can be quite dense delivering to a few customers on most streets, but is not intended to visit every house on every street., Delivery companies need to determine which orders (package delivery location) should be serviced by each route (delivery vehicle and driver) and in what sequence the orders should be visited. The primary goal is to best service the orders by producing geographically clustered routes so the drivers can easily deliver to everyone and minimize the overall operating cost for the fleet of vehicles., The Route service finds the best route for a single vehicle to visit many stops where as the Last Mile Delivery service and the Vehicle Routing Problem service both find the best routes for a fleet of vehicles to service many orders. The Vehicle Routing Problem service has lots of flexibility and can model many different constraints but the algorithm is also limited by this flexibility. The Last Mile Delivery service supports a subset of the constraints but for the ones it does support is able to provide a better quality and performant algorithm.

Category:

Help URL: https://portal.henrico.gov/hosting/rest/directories/arcgisoutput/Routing/NetworkAnalysis_GPServer/Routing_NetworkAnalysis/SolveLastMileDelivery.htm

Execution Type: esriExecutionTypeAsynchronous

Parameters:

Parameter: orders

Data Type: GPFeatureRecordSetLayer
Display Name Orders
Description: Specifies one or more locations that the routes of the Last Mile Delivery analysis will visit. An order can represent a delivery (for example, furniture delivery), a pickup (such as an airport shuttle bus picking up a passenger), or some type of service or inspection (a tree trimming job or building inspection, for instance). When specifying the orders, you can set properties for each—such as its name or service time—using attributes. Please consult the API Reference for a list of supported attributes.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Geometry Type: esriGeometryPoint
HasZ: false
HasM: false
Spatial Reference: 4326  (4326)  LatestVCSWkid(0)
Fields:
• OBJECTID ( type: esriFieldTypeOID, alias: ObjectID )
• Name ( type: esriFieldTypeString, alias: Name, length: 500 )
• ServiceTime ( type: esriFieldTypeDouble, alias: ServiceTime )
• TimeWindowStart ( type: esriFieldTypeDate, alias: TimeWindowStart, length: 8 )
• TimeWindowEnd ( type: esriFieldTypeDate, alias: TimeWindowEnd, length: 8 )
• MaxViolationTime ( type: esriFieldTypeDouble, alias: MaxViolationTime )
• InboundArriveTime ( type: esriFieldTypeDate, alias: InboundArriveTime, length: 8 )
• OutboundDepartTime ( type: esriFieldTypeDate, alias: OutboundDepartTime, length: 8 )
• DeliveryQuantity_1 ( type: esriFieldTypeDouble, alias: DeliveryQuantity_1 )
• DeliveryQuantity_2 ( type: esriFieldTypeDouble, alias: DeliveryQuantity_2 )
• DeliveryQuantity_3 ( type: esriFieldTypeDouble, alias: DeliveryQuantity_3 )
• DeliveryQuantity_4 ( type: esriFieldTypeDouble, alias: DeliveryQuantity_4 )
• DeliveryQuantity_5 ( type: esriFieldTypeDouble, alias: DeliveryQuantity_5 )
• DeliveryQuantity_6 ( type: esriFieldTypeDouble, alias: DeliveryQuantity_6 )
• DeliveryQuantity_7 ( type: esriFieldTypeDouble, alias: DeliveryQuantity_7 )
• DeliveryQuantity_8 ( type: esriFieldTypeDouble, alias: DeliveryQuantity_8 )
• DeliveryQuantity_9 ( type: esriFieldTypeDouble, alias: DeliveryQuantity_9 )
• PickupQuantity_1 ( type: esriFieldTypeDouble, alias: PickupQuantity_1 )
• PickupQuantity_2 ( type: esriFieldTypeDouble, alias: PickupQuantity_2 )
• PickupQuantity_3 ( type: esriFieldTypeDouble, alias: PickupQuantity_3 )
• PickupQuantity_4 ( type: esriFieldTypeDouble, alias: PickupQuantity_4 )
• PickupQuantity_5 ( type: esriFieldTypeDouble, alias: PickupQuantity_5 )
• PickupQuantity_6 ( type: esriFieldTypeDouble, alias: PickupQuantity_6 )
• PickupQuantity_7 ( type: esriFieldTypeDouble, alias: PickupQuantity_7 )
• PickupQuantity_8 ( type: esriFieldTypeDouble, alias: PickupQuantity_8 )
• PickupQuantity_9 ( type: esriFieldTypeDouble, alias: PickupQuantity_9 )
• AnchorRule ( type: esriFieldTypeInteger, alias: AnchorRule )
• AssignmentRule ( type: esriFieldTypeInteger, alias: AssignmentRule )
• RouteName ( type: esriFieldTypeString, alias: RouteName, length: 500 )
• Sequence ( type: esriFieldTypeInteger, alias: Sequence )
• SourceID ( type: esriFieldTypeInteger, alias: SourceID )
• SourceOID ( type: esriFieldTypeInteger, alias: SourceOID )
• PosAlong ( type: esriFieldTypeDouble, alias: PosAlong )
• SideOfEdge ( type: esriFieldTypeInteger, alias: SideOfEdge )
• CurbApproach ( type: esriFieldTypeInteger, alias: CurbApproach )
Features: None.


Parameter Type: esriGPParameterTypeRequired
Category:


Parameter: depots

Data Type: GPFeatureRecordSetLayer
Display Name Depots
Description: Specifies one or more depots for the given last mile delivery problem. A depot is a location that a vehicle departs from at the beginning of its workday and returns to at the end of the workday. Vehicles are loaded (for deliveries) or unloaded (for pickups) at depots. In some cases, a depot can also act as a renewal location whereby the vehicle can unload or reload and continue performing deliveries and pickups. A depot has open and close times, as specified by a hard time window. Vehicles can't arrive at a depot outside of this time window. When specifying the depots, you can set properties for each—such as its name or service time—using attributes. Please consult the API Reference for a list of supported attributes.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Geometry Type: esriGeometryPoint
HasZ: false
HasM: false
Spatial Reference: 4326  (4326)  LatestVCSWkid(0)
Fields:
• OBJECTID ( type: esriFieldTypeOID, alias: ObjectID )
• Name ( type: esriFieldTypeString, alias: Name, length: 500 )
• SourceID ( type: esriFieldTypeInteger, alias: SourceID )
• SourceOID ( type: esriFieldTypeInteger, alias: SourceOID )
• PosAlong ( type: esriFieldTypeDouble, alias: PosAlong )
• SideOfEdge ( type: esriFieldTypeInteger, alias: SideOfEdge )
• CurbApproach ( type: esriFieldTypeInteger, alias: CurbApproach )
Features: None.


Parameter Type: esriGPParameterTypeRequired
Category:


Parameter: routes

Data Type: GPRecordSet
Display Name Routes
Description: Specifies one or more routes that describe vehicle and driver characteristics. A route can have start and end depot service times, a fixed or flexible starting time, time-based operating costs, distance-based operating costs, multiple capacities, various constraints on a driver's workday, and so on. The routes can be specified with attributes. Please consult the API Reference for a list of supported attributes.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Fields:
• OBJECTID ( type: esriFieldTypeOID, alias: ObjectID )
• Name ( type: esriFieldTypeString, alias: Name, length: 500 )
• StartDepotName ( type: esriFieldTypeString, alias: StartDepotName, length: 500 )
• EndDepotName ( type: esriFieldTypeString, alias: EndDepotName, length: 500 )
• StartDepotServiceTime ( type: esriFieldTypeDouble, alias: StartDepotServiceTime )
• EndDepotServiceTime ( type: esriFieldTypeDouble, alias: EndDepotServiceTime )
• EarliestStartDate ( type: esriFieldTypeDateOnly, alias: EarliestStartDate, length: 8 )
• EarliestStartTime ( type: esriFieldTypeTimeOnly, alias: EarliestStartTime, length: 8 )
• StartFlexibility ( type: esriFieldTypeDouble, alias: StartFlexibility )
• ArriveDepartDelay ( type: esriFieldTypeDouble, alias: ArriveDepartDelay )
• Capacity_1 ( type: esriFieldTypeDouble, alias: Capacity_1 )
• Capacity_2 ( type: esriFieldTypeDouble, alias: Capacity_2 )
• Capacity_3 ( type: esriFieldTypeDouble, alias: Capacity_3 )
• Capacity_4 ( type: esriFieldTypeDouble, alias: Capacity_4 )
• Capacity_5 ( type: esriFieldTypeDouble, alias: Capacity_5 )
• Capacity_6 ( type: esriFieldTypeDouble, alias: Capacity_6 )
• Capacity_7 ( type: esriFieldTypeDouble, alias: Capacity_7 )
• Capacity_8 ( type: esriFieldTypeDouble, alias: Capacity_8 )
• Capacity_9 ( type: esriFieldTypeDouble, alias: Capacity_9 )
• FixedCost ( type: esriFieldTypeDouble, alias: FixedCost )
• CostPerUnitTime ( type: esriFieldTypeDouble, alias: CostPerUnitTime )
• CostPerUnitDistance ( type: esriFieldTypeDouble, alias: CostPerUnitDistance )
• OvertimeStartTime ( type: esriFieldTypeDouble, alias: OvertimeStartTime )
• CostPerUnitOvertime ( type: esriFieldTypeDouble, alias: CostPerUnitOvertime )
• MaxOrderCount ( type: esriFieldTypeInteger, alias: MaxOrderCount )
• MaxTotalTime ( type: esriFieldTypeDouble, alias: MaxTotalTime )
• MaxTotalTravelTime ( type: esriFieldTypeDouble, alias: MaxTotalTravelTime )
• MaxTotalDistance ( type: esriFieldTypeDouble, alias: MaxTotalDistance )
• ZoneName ( type: esriFieldTypeString, alias: ZoneName, length: 500 )
• IsHardZone ( type: esriFieldTypeInteger, alias: IsHardZone )
• AssignmentRule ( type: esriFieldTypeInteger, alias: AssignmentRule )
Features: None.


Parameter Type: esriGPParameterTypeRequired
Category:


Parameter: travel_mode

Data Type: GPString
Display Name Travel Mode
Description: Choose the mode of transportation, such as driving or walking for the analysis. Travel modes are essentially templates consisting of a long list of travel settings that are used by the service when finding best routes, calculating travel times, or travel distances. The value for the travel_mode parameter should be a JSON object representing travel mode settings. For example, {"attributeParameterValues":[{"parameterName":"Restriction Usage","attributeName":"Walking","value":"PROHIBITED"},{"parameterName":"Restriction Usage","attributeName":"Preferred for Pedestrians","value":"PREFER_LOW"},{"parameterName":"Walking Speed (km/h)","attributeName":"WalkTime","value":5}],"description":"Follows paths and roads that allow pedestrian traffic and finds solutions that optimize travel time. The walking speed is set to 5 kilometers per hour.","impedanceAttributeName":"WalkTime","simplificationToleranceUnits":"esriMeters","uturnAtJunctions":"esriNFSBAllowBacktrack","restrictionAttributeNames":["Preferred for Pedestrians","Walking"],"useHierarchy":false,"simplificationTolerance":2,"timeAttributeName":"WalkTime","distanceAttributeName":"Miles","type":"WALK","id":"caFAgoThrvUpkFBW","name":"Walking Time"}
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: {"name":"Driving Time","type":"AUTOMOBILE","description":"Collection of network dataset settings that define actions that are allowed on the network and how the actions can be performed.","impedanceAttributeName":"Minutes","timeAttributeName":"Minutes","distanceAttributeName":"Length","restrictionAttributeNames":[],"attributeParameterValues":[],"useHierarchy":false,"uturnAtJunctions":"esriNFSBAllowBacktrack","simplificationTolerance":null,"simplificationToleranceUnits":"esriMeters"}
Parameter Type: esriGPParameterTypeOptional
Category: Analysis Settings


Parameter: earliest_route_start_date

Data Type: GPString
Display Name Earliest Route Start Date
Description: Specifies the default earliest start date for routes. This date is used for all routes for which the EarliestStartDate field in the Route parameter is null. When this property is not specified, all rows in the Routes parameter must specify a value in the EarliestStartDate field. The value is specified as a string in YYYY-MM-DD format. For example, 2024-06-15.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeOptional
Category: Analysis Settings


Parameter: earliest_route_start_time

Data Type: GPString
Display Name Earliest Route Start Time
Description: Specifies the default earliest start time for routes. This time of day is used for all routes for which the EarliestStartTime field in the Route parameter is null. When this property is not specified, all rows in the Routes parameter must specify a value in the EarliestStartTime field. The value is specified as a string in HH:MM:SS format. For example, 17:30:00.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeOptional
Category: Analysis Settings


Parameter: max_route_total_time

Data Type: GPDouble
Display Name Max Route Total Time
Description: Specifies the maximum allowed total time for each route. The value can be any positive number. The value is used for all routes for which the MaxTotalTime field in the Routes parameter is null. When Max Route Total Time is not specified, all rows in the Routes parameter must specify a value in the MaxTotalTime field. The value is interpreted in the units specified in the Time_Units parameter.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeOptional
Category: Analysis Settings


Parameter: sequence_gap

Data Type: GPLong
Display Name Sequence Gap
Description: Specifies the gap in numerical values to leave in the Sequence field in the Orders parameter between adjacent orders when the analysis is solved. The value acts as a multiplier for the actual sequence of orders on each route. For instance, if the gap is 5, the first order on the route would have a field value of 5, the second order on the route would have a Sequence field value of 10, the third 15, and so on. This parameter helps support inserting orders after the initial route plan has been created because the new orders can be inserted into the sequence gaps. The value must be a positive integer. The default is 1. The first time the analysis is solved, the Sequence field values will be populated with sequential values using the designated sequence gap. On subsequent solves of the same analysis, the Sequence field values of existing orders will be maintained, and new orders will be inserted into the gaps using available integer values for the Sequence field that are not in use by other orders. If the sequence gap is set to 1, the sequence values will always be updated to contiguous values for every solve.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: 1
Parameter Type: esriGPParameterTypeOptional
Category: Analysis Settings


Parameter: time_units

Data Type: GPString
Display Name Time Units
Description: The time units for all time-based field values in the analysis. Many features and records in a VRP analysis have fields for storing time values, such as ServiceTime for orders and CostPerUnitTime for routes. To minimize data entry requirements, these field values don't include units. Instead, all distance-based field values must be entered in the same units, and this parameter is used to specify the units of those values. Note that output time-based fields use the same units specified by this parameter.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: Minutes
Parameter Type: esriGPParameterTypeOptional
Category: Analysis Settings
Choice List: [ Seconds, Minutes, Hours, Days ]


Parameter: distance_units

Data Type: GPString
Display Name Distance Units
Description: The distance units for all distance-based field values in the analysis. Many features and records in a VRP analysis have fields for storing distance values, such as MaxTotalDistance and CostPerUnitDistance for routes. To minimize data entry requirements, these field values don't include units. Instead, all distance-based field values must be entered in the same units, and this parameter is used to specify the units of those values. Note that output distance-based fields use the same units specified by this parameter.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: Miles
Parameter Type: esriGPParameterTypeOptional
Category: Analysis Settings
Choice List: [ Meters, Kilometers, Feet, Yards, Miles, NauticalMiles ]


Parameter: time_zone_usage_for_time_fields

Data Type: GPString
Display Name Time Zone Usage For Time Fields
Description: Specifies the time zone for the input date-time fields supported by the tool. This parameter specifies the time zone for the following fields: TimeWindowStart, TimeWindowEnd, InboundArriveTime, and OutboundDepartTime on Orders. StartTime, EndTime, EarliestStartDate and EarliestestStartTime on Routes. Arrivetime and DepartTime on DepotVisits. GEO_LOCAL—The date-time values associated with the orders or depots are in the time zone in which the orders and depots are located. For routes, the date-time values are based on the time zone in which the starting depot for the route is located. If a route does not have a starting depot, all orders and depots across all the routes must be in a single time zone. For breaks, the date-time values are based on the time zone of the routes. For example, if your depot is located in an area that follows eastern standard time and has the first time window values (specified as TimeWindowStart1 and TimeWindowEnd1) of 8 AM and 5 PM, the time window values will be treated as 8:00 a.m. and 5:00 p.m. eastern standard time. UTC—The date-time values associated with the orders or depots are in coordinated universal time (UTC) and are not based on the time zone in which the orders or depots are located. For example, if your depot is located in an area that follows eastern standard time and has the first time window values (specified as TimeWindowStart1 and TimeWindowEnd1) of 8 AM and 5 PM, the time window values will be treated as 12:00 p.m. and 9:00 p.m. eastern standard time, assuming eastern standard time is obeying daylight saving time.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: GEO_LOCAL
Parameter Type: esriGPParameterTypeOptional
Category: Analysis Settings
Choice List: [ GEO_LOCAL, UTC ]


Parameter: order_specialties

Data Type: GPRecordSet
Display Name Order Specialties
Description: Order Specialties and Route Specialties lists the specialties that can be required by orders and supported by routes. A route can service an order only if it supports all the specialties required for that order. When specifying the order specialities, you can set properties using attributes. Please consult the API Reference for a list of supported attributes.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Fields:
• OBJECTID ( type: esriFieldTypeOID, alias: ObjectID )
• OrderName ( type: esriFieldTypeString, alias: OrderName, length: 500 )
• SpecialtyName ( type: esriFieldTypeString, alias: SpecialtyName, length: 500 )
Features: None.


Parameter Type: esriGPParameterTypeOptional
Category:


Parameter: route_specialties

Data Type: GPRecordSet
Display Name Route Specialties
Description: Order Specialties and Route Specialties lists the specialties that can be required by orders and supported by routes. A route can service an order only if it supports all the specialties required for that order. When specifying the route specialities, you can set properties using attributes. Please consult the API Reference for a list of supported attributes.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Fields:
• OBJECTID ( type: esriFieldTypeOID, alias: ObjectID )
• RouteName ( type: esriFieldTypeString, alias: RouteName, length: 500 )
• SpecialtyName ( type: esriFieldTypeString, alias: SpecialtyName, length: 500 )
Features: None.


Parameter Type: esriGPParameterTypeOptional
Category:


Parameter: zones

Data Type: GPFeatureRecordSetLayer
Display Name Zones
Description: Zones specify a work territory. It is a polygon feature and is used to constrain servicing only those orders that fall within or near an area. When specifying the zones, you can set properties using attributes. Please consult the API Reference for a list of supported attributes.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Geometry Type: esriGeometryPolygon
HasZ: false
HasM: false
Spatial Reference: 4326  (4326)  LatestVCSWkid(0)
Fields:
• OBJECTID ( type: esriFieldTypeOID, alias: ObjectID )
• Name ( type: esriFieldTypeString, alias: Name, length: 500 )
• Shape_Length ( type: esriFieldTypeDouble, alias: Shape_Length )
• Shape_Area ( type: esriFieldTypeDouble, alias: Shape_Area )
Features: None.


Parameter Type: esriGPParameterTypeOptional
Category:


Parameter: point_barriers

Data Type: GPFeatureRecordSetLayer
Display Name Point Barriers
Description: Specify one or more points that will act as temporary restrictions or represent additional time or distance that may be required to travel on the underlying streets. For example, a point barrier can be used to represent a fallen tree along a street or a time delay spent at a railroad crossing. When specifying point barriers, you can set properties for each, such as its name or barrier type, using attributes. Please consult the API Reference for a list of supported attributes.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Geometry Type: esriGeometryPoint
HasZ: false
HasM: false
Spatial Reference: 4326  (4326)  LatestVCSWkid(0)
Fields:
• OBJECTID ( type: esriFieldTypeOID, alias: OBJECTID )
• Name ( type: esriFieldTypeString, alias: Name, length: 500 )
• BarrierType ( type: esriFieldTypeInteger, alias: Barrier Type )
• Additional_Time ( type: esriFieldTypeDouble, alias: Additional Time )
• Additional_Distance ( type: esriFieldTypeDouble, alias: Additional Distance )
• AdditionalCost ( type: esriFieldTypeDouble, alias: Additional Cost )
• CurbApproach ( type: esriFieldTypeSmallInteger, alias: Curb Approach )
• FullEdge ( type: esriFieldTypeInteger, alias: Full Edge )
Features: None.


Parameter Type: esriGPParameterTypeOptional
Category: Barriers


Parameter: line_barriers

Data Type: GPFeatureRecordSetLayer
Display Name Line Barriers
Description: Specify one or more lines that prohibit travel anywhere the lines intersect the streets. For example, a parade or protest that blocks traffic across several street segments can be modeled with a line barrier. A line barrier can also quickly fence off several roads from being traversed, thereby channeling possible routes away from undesirable parts of the street network. When specifying the line barriers, you can set name and barrier type properties for each using attributes. Please consult the API Reference for a list of supported attributes.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Geometry Type: esriGeometryPolyline
HasZ: false
HasM: false
Spatial Reference: 4326  (4326)  LatestVCSWkid(0)
Fields:
• OBJECTID ( type: esriFieldTypeOID, alias: OBJECTID )
• Name ( type: esriFieldTypeString, alias: Name, length: 500 )
• SHAPE_Length ( type: esriFieldTypeDouble, alias: SHAPE_Length )
Features: None.


Parameter Type: esriGPParameterTypeOptional
Category: Barriers


Parameter: polygon_barriers

Data Type: GPFeatureRecordSetLayer
Display Name Polygon Barriers
Description: Specify polygons that either completely restrict travel or proportionately scale the time or distance required to travel on the streets intersected by the polygons. When specifying the polygon barriers, you can set properties for each, such as its name or barrier type, using attributes. Please consult the API Reference for a list of supported attributes.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Geometry Type: esriGeometryPolygon
HasZ: false
HasM: false
Spatial Reference: 4326  (4326)  LatestVCSWkid(0)
Fields:
• OBJECTID ( type: esriFieldTypeOID, alias: OBJECTID )
• Name ( type: esriFieldTypeString, alias: Name, length: 500 )
• BarrierType ( type: esriFieldTypeInteger, alias: Barrier Type )
• ScaledTimeFactor ( type: esriFieldTypeDouble, alias: Scaled Time Factor )
• ScaledDistanceFactor ( type: esriFieldTypeDouble, alias: Scaled Distance Factor )
• ScaledCostFactor ( type: esriFieldTypeDouble, alias: Scaled Cost Factor )
• SHAPE_Length ( type: esriFieldTypeDouble, alias: SHAPE_Length )
• SHAPE_Area ( type: esriFieldTypeDouble, alias: SHAPE_Area )
Features: None.


Parameter Type: esriGPParameterTypeOptional
Category: Barriers


Parameter: locate_settings

Data Type: GPString
Display Name Locate Settings
Description: The settings that affect how inputs will be located. Examples are the maximum search distance to use when locating the inputs on the network, the network sources being used for locating, or specifying a where clause for a source to restrict locating on a portion of the source. The parameter value is specified as a JSON object.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: {"default":{"allowAutoRelocate":true,"tolerance":20000,"toleranceUnits":"esriMeters","sources":[{"name":"VA_CENTERLINE"}]}}
Parameter Type: esriGPParameterTypeOptional
Category: Network Locations


Parameter: ignore_invalid_order_locations

Data Type: GPBoolean
Display Name Ignore Invalid Order Locations
Description: Specifies whether invalid orders will be ignored when solving the last mile delivery problem. True—The solve operation will ignore any invalid orders and return a solution, as long as it didn't encounter any other errors. If you need to generate routes and deliver them to drivers immediately, you may be able to ignore invalid orders, solve, and distribute the routes to your drivers. Then resolve any invalid orders from the last solve and include them in the VRP analysis for the next workday or work shift. False—The solve operation will fail when any invalid orders are encountered. An invalid order is an order that the VRP solver can't reach. An order may be unreachable for a variety of reasons, including when the order is located on a prohibited network element, isn't on the network at all, or is on a disconnected part of the network.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: true
Parameter Type: esriGPParameterTypeOptional
Category: Network Locations


Parameter: route_shape

Data Type: GPString
Display Name Route Shape
Description: Specifies the type of route features that will be output by the tool. True Shape with Measures—Return the exact shape of the resulting route that is based on the underlying streets. Additionally, construct measures so the shape can be used in linear referencing. The measurements increase from the first stop and record the cumulative travel time or travel distance in the units specified by the Time Units or Distance Units parameters. Straight Line—Return a straight line between two stops. None—Do not return any shapes for the routes. This value can be useful, and return results quickly, in cases where you only want to determine the total travel time or travel distance of a route. When the Route Shape parameter is set to True Shape with Measures, the generalization of the route shape can be further controlled using the appropriate value for the simplificationTolerance setting in the travel_mode parameter. No matter which value you choose for the Route Shape parameter, the best route is always determined by minimizing the travel time or the travel distance, never using the straight-line distance between stops. This means that only the route shapes are different, not the underlying streets that are searched when finding the route.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: Straight Line
Parameter Type: esriGPParameterTypeOptional
Category: Output Settings
Choice List: [ True Shape with Measures, Straight Line, None ]


Parameter: populate_directions

Data Type: GPBoolean
Display Name Populate Directions
Description: Specifies whether the tool will generate driving directions for each route. True—Directions will be generated and configured based on the value of the directions_language parameter False—Directions will not be generated.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: false
Parameter Type: esriGPParameterTypeOptional
Category: Output Settings


Parameter: directions_language

Data Type: GPString
Display Name Directions Language
Description: The language that will be used when generating travel directions. This parameter is used only when the Populate_Directions parameter is True. The parameter value can be specified using one of the following two- or five-character language codes: ar — Arabic bg — Bulgarian bs — Bosnian ca — Catalan cs — Czech da — Danish de — German el — Greek en — English es — Spanish et — Estonian fi — Finnish fr — French he — Hebrew hr — Croatian hu — Hungarian id — Indonesian it — Italian ja — Japanese ko — Korean lt — Lithuanian lv — Latvian nb — Norwegian nl — Dutch pl — Polish pt-BR — Portuguese (Brazil) pt-PT — Portuguese (Portugal) ro — Romanian ru — Russian sk — Slovak sl — Slovenian sr — Serbian sv — Swedish th — Thai tr — Turkish uk — Ukrainian vi — Vietnamese zh-CN — Chinese (China) zh-HK — Chinese (Hong Kong) zh-TW — Chinese (Taiwan) The tool first searches for an exact match for the specified language including any language localization. If an exact match is not found, it tries to match the language family. If a match is still not found, the tool returns the directions using the default language, English. For example, if the directions language is specified as es-MX (Mexican Spanish), the tool will return the directions in Spanish, as it supports the es language code but not es-MX. If a language supports localization, such as Brazilian Portuguese (pt-BR) and European Portuguese (pt-PT), specify the language family and the localization. If you only specify the language family, the tool will not match the language family and instead return directions in the default language, English. For example, if the directions language specified is pt, the tool will return the directions in English since it cannot determine whether the directions should be returned in pt-BR or pt-PT.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: en
Parameter Type: esriGPParameterTypeOptional
Category: Output Settings


Parameter: save_route_data

Data Type: GPBoolean
Display Name Save Route Data
Description: Specifies whether the output includes a .zip file that contains a file geodatabase with the inputs and outputs of the analysis in a format that can be used to share route layers with ArcGIS Online or ArcGIS Enterprise portals. True—The route data will be saved as a .zip file. The file can be downloaded from the URL provided by the output_route_data output parameter. False—The route data will not be saved.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: false
Parameter Type: esriGPParameterTypeOptional
Category: Output Settings


Parameter: save_output_network_analysis_layer

Data Type: GPBoolean
Display Name Save Output Network Analysis Layer
Description: Specifies whether the analysis settings will be saved as a network analysis layer package file. You cannot directly work with this file even when you open the file in an ArcGIS Desktop application such as ArcGIS Pro. It is meant to be sent to Esri Technical Support to diagnose the quality of results returned from the tool. True—The network analysis layer package file will be saved. The file can be downloaded from the URL provided by the output_network_analysis_layer_package output parameter. False—The network analysis layer package file will not be saved.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: false
Parameter Type: esriGPParameterTypeOptional
Category: Output Settings


Parameter: output_format

Data Type: GPString
Display Name Output Format
Description: Specifies the format in which the output features will be returned. Feature Set—The output features will be returned as JSON representation of feature classes and tables. JSON File—The output features will be returned as a compressed file containing the JSON representation of the outputs. When this option is specified, the output is a single file (with a .zip extension) that contains one or more JSON files (with a .json extension) for each of the outputs created by the service. GeoJSON File—The output features will be returned as a compressed file containing the GeoJSON representation of the outputs. When this option is specified, the output is a single file (with a .zip extension) that contains one or more GeoJSON files (with a .geojson extension) for each of the outputs created by the service. When a file-based output format, such as JSON File or GeoJSON File, is specified, the file can be downloaded from the URL provided by the output_result_file output parameter.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: Feature Set
Parameter Type: esriGPParameterTypeOptional
Category: Output Settings
Choice List: [ Feature Set, JSON File, GeoJSON File ]


Parameter: overrides

Data Type: GPString
Display Name Overrides
Description: This parameter is for internal use only.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeOptional
Category: Analysis Settings


Parameter: analysis_region

Data Type: GPString
Display Name Analysis Region
Description: This parameter is ignored by the service and specifying a value does not have any effect on the analysis.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeOptional
Category: Analysis Settings
Choice List: [ NDS_ND ]


Parameter: output_orders

Data Type: GPFeatureRecordSetLayer
Display Name Output Orders
Description:
Direction: esriGPParameterDirectionOutput
Filter:
Dependency:
Default Value:
Geometry Type: esriGeometryPoint
HasZ: false
HasM: false
Spatial Reference: 102100  (3857)  LatestVCSWkid(0)
Fields:
• ObjectID ( type: esriFieldTypeOID, alias: ObjectID )
• Name ( type: esriFieldTypeString, alias: Name, length: 500 )
• ServiceTime ( type: esriFieldTypeDouble, alias: ServiceTime )
• TimeWindowStart ( type: esriFieldTypeDate, alias: TimeWindowStart, length: 8 )
• TimeWindowEnd ( type: esriFieldTypeDate, alias: TimeWindowEnd, length: 8 )
• MaxViolationTime ( type: esriFieldTypeDouble, alias: MaxViolationTime )
• InboundArriveTime ( type: esriFieldTypeDate, alias: InboundArriveTime, length: 8 )
• OutboundDepartTime ( type: esriFieldTypeDate, alias: OutboundDepartTime, length: 8 )
• DeliveryQuantity_1 ( type: esriFieldTypeDouble, alias: DeliveryQuantity_1 )
• DeliveryQuantity_2 ( type: esriFieldTypeDouble, alias: DeliveryQuantity_2 )
• DeliveryQuantity_3 ( type: esriFieldTypeDouble, alias: DeliveryQuantity_3 )
• DeliveryQuantity_4 ( type: esriFieldTypeDouble, alias: DeliveryQuantity_4 )
• DeliveryQuantity_5 ( type: esriFieldTypeDouble, alias: DeliveryQuantity_5 )
• DeliveryQuantity_6 ( type: esriFieldTypeDouble, alias: DeliveryQuantity_6 )
• DeliveryQuantity_7 ( type: esriFieldTypeDouble, alias: DeliveryQuantity_7 )
• DeliveryQuantity_8 ( type: esriFieldTypeDouble, alias: DeliveryQuantity_8 )
• DeliveryQuantity_9 ( type: esriFieldTypeDouble, alias: DeliveryQuantity_9 )
• PickupQuantity_1 ( type: esriFieldTypeDouble, alias: PickupQuantity_1 )
• PickupQuantity_2 ( type: esriFieldTypeDouble, alias: PickupQuantity_2 )
• PickupQuantity_3 ( type: esriFieldTypeDouble, alias: PickupQuantity_3 )
• PickupQuantity_4 ( type: esriFieldTypeDouble, alias: PickupQuantity_4 )
• PickupQuantity_5 ( type: esriFieldTypeDouble, alias: PickupQuantity_5 )
• PickupQuantity_6 ( type: esriFieldTypeDouble, alias: PickupQuantity_6 )
• PickupQuantity_7 ( type: esriFieldTypeDouble, alias: PickupQuantity_7 )
• PickupQuantity_8 ( type: esriFieldTypeDouble, alias: PickupQuantity_8 )
• PickupQuantity_9 ( type: esriFieldTypeDouble, alias: PickupQuantity_9 )
• AnchorRule ( type: esriFieldTypeInteger, alias: AnchorRule )
• AssignmentRule ( type: esriFieldTypeInteger, alias: AssignmentRule )
• RouteName ( type: esriFieldTypeString, alias: RouteName, length: 500 )
• Sequence ( type: esriFieldTypeInteger, alias: Sequence )
• ViolatedConstraint_1 ( type: esriFieldTypeInteger, alias: ViolatedConstraint_1 )
• ViolatedConstraint_2 ( type: esriFieldTypeInteger, alias: ViolatedConstraint_2 )
• ViolatedConstraint_3 ( type: esriFieldTypeInteger, alias: ViolatedConstraint_3 )
• ViolatedConstraint_4 ( type: esriFieldTypeInteger, alias: ViolatedConstraint_4 )
• FromPrevTravelTime ( type: esriFieldTypeDouble, alias: FromPrevTravelTime )
• FromPrevDistance ( type: esriFieldTypeDouble, alias: FromPrevDistance )
• ArriveCurbApproach ( type: esriFieldTypeInteger, alias: ArriveCurbApproach )
• DepartCurbApproach ( type: esriFieldTypeInteger, alias: DepartCurbApproach )
• ArriveTime ( type: esriFieldTypeTimestampOffset, alias: ArriveTime )
• DepartTime ( type: esriFieldTypeTimestampOffset, alias: DepartTime )
• WaitTime ( type: esriFieldTypeDouble, alias: WaitTime )
• ViolationTime ( type: esriFieldTypeDouble, alias: ViolationTime )
• SourceID ( type: esriFieldTypeInteger, alias: SourceID )
• SourceOID ( type: esriFieldTypeInteger, alias: SourceOID )
• PosAlong ( type: esriFieldTypeDouble, alias: PosAlong )
• SideOfEdge ( type: esriFieldTypeInteger, alias: SideOfEdge )
• CurbApproach ( type: esriFieldTypeInteger, alias: CurbApproach )
• Status ( type: esriFieldTypeInteger, alias: Status )
• SnapX ( type: esriFieldTypeDouble, alias: SnapX )
• SnapY ( type: esriFieldTypeDouble, alias: SnapY )
• SnapZ ( type: esriFieldTypeDouble, alias: SnapZ )
• DistanceToNetworkInMeters ( type: esriFieldTypeDouble, alias: DistanceToNetworkInMeters )
• Bearing ( type: esriFieldTypeDouble, alias: Bearing )
• BearingTol ( type: esriFieldTypeDouble, alias: BearingTol )
• NavLatency ( type: esriFieldTypeDouble, alias: NavLatency )
Features: None.


Parameter Type: esriGPParameterTypeDerived
Category:


Parameter: output_routes

Data Type: GPFeatureRecordSetLayer
Display Name Output Routes
Description:
Direction: esriGPParameterDirectionOutput
Filter:
Dependency:
Default Value:
Geometry Type: esriGeometryPolyline
HasZ: false
HasM: true
Spatial Reference: 102100  (3857)  LatestVCSWkid(0)
Fields:
• ObjectID ( type: esriFieldTypeOID, alias: ObjectID )
• Name ( type: esriFieldTypeString, alias: Name, length: 500 )
• StartDepotName ( type: esriFieldTypeString, alias: StartDepotName, length: 500 )
• EndDepotName ( type: esriFieldTypeString, alias: EndDepotName, length: 500 )
• StartDepotServiceTime ( type: esriFieldTypeDouble, alias: StartDepotServiceTime )
• EndDepotServiceTime ( type: esriFieldTypeDouble, alias: EndDepotServiceTime )
• EarliestStartDate ( type: esriFieldTypeDateOnly, alias: EarliestStartDate, length: 8 )
• EarliestStartTime ( type: esriFieldTypeTimeOnly, alias: EarliestStartTime, length: 8 )
• StartFlexibility ( type: esriFieldTypeDouble, alias: StartFlexibility )
• ArriveDepartDelay ( type: esriFieldTypeDouble, alias: ArriveDepartDelay )
• Capacity_1 ( type: esriFieldTypeDouble, alias: Capacity_1 )
• Capacity_2 ( type: esriFieldTypeDouble, alias: Capacity_2 )
• Capacity_3 ( type: esriFieldTypeDouble, alias: Capacity_3 )
• Capacity_4 ( type: esriFieldTypeDouble, alias: Capacity_4 )
• Capacity_5 ( type: esriFieldTypeDouble, alias: Capacity_5 )
• Capacity_6 ( type: esriFieldTypeDouble, alias: Capacity_6 )
• Capacity_7 ( type: esriFieldTypeDouble, alias: Capacity_7 )
• Capacity_8 ( type: esriFieldTypeDouble, alias: Capacity_8 )
• Capacity_9 ( type: esriFieldTypeDouble, alias: Capacity_9 )
• FixedCost ( type: esriFieldTypeDouble, alias: FixedCost )
• CostPerUnitTime ( type: esriFieldTypeDouble, alias: CostPerUnitTime )
• CostPerUnitDistance ( type: esriFieldTypeDouble, alias: CostPerUnitDistance )
• OvertimeStartTime ( type: esriFieldTypeDouble, alias: OvertimeStartTime )
• CostPerUnitOvertime ( type: esriFieldTypeDouble, alias: CostPerUnitOvertime )
• MaxOrderCount ( type: esriFieldTypeInteger, alias: MaxOrderCount )
• MaxTotalTime ( type: esriFieldTypeDouble, alias: MaxTotalTime )
• MaxTotalTravelTime ( type: esriFieldTypeDouble, alias: MaxTotalTravelTime )
• MaxTotalDistance ( type: esriFieldTypeDouble, alias: MaxTotalDistance )
• ZoneName ( type: esriFieldTypeString, alias: ZoneName, length: 500 )
• IsHardZone ( type: esriFieldTypeInteger, alias: IsHardZone )
• AssignmentRule ( type: esriFieldTypeInteger, alias: AssignmentRule )
• ViolatedConstraint_1 ( type: esriFieldTypeInteger, alias: ViolatedConstraint_1 )
• ViolatedConstraint_2 ( type: esriFieldTypeInteger, alias: ViolatedConstraint_2 )
• ViolatedConstraint_3 ( type: esriFieldTypeInteger, alias: ViolatedConstraint_3 )
• ViolatedConstraint_4 ( type: esriFieldTypeInteger, alias: ViolatedConstraint_4 )
• OrderCount ( type: esriFieldTypeInteger, alias: OrderCount )
• TotalCost ( type: esriFieldTypeDouble, alias: TotalCost )
• RegularTimeCost ( type: esriFieldTypeDouble, alias: RegularTimeCost )
• OvertimeCost ( type: esriFieldTypeDouble, alias: OvertimeCost )
• DistanceCost ( type: esriFieldTypeDouble, alias: DistanceCost )
• TotalTime ( type: esriFieldTypeDouble, alias: TotalTime )
• TotalOrderServiceTime ( type: esriFieldTypeDouble, alias: TotalOrderServiceTime )
• TotalTravelTime ( type: esriFieldTypeDouble, alias: TotalTravelTime )
• TotalDistance ( type: esriFieldTypeDouble, alias: TotalDistance )
• StartTime ( type: esriFieldTypeTimestampOffset, alias: StartTime )
• EndTime ( type: esriFieldTypeTimestampOffset, alias: EndTime )
• TotalWaitTime ( type: esriFieldTypeDouble, alias: TotalWaitTime )
• TotalViolationTime ( type: esriFieldTypeDouble, alias: TotalViolationTime )
• Shape_Length ( type: esriFieldTypeDouble, alias: Shape_Length )
Features: None.


Parameter Type: esriGPParameterTypeDerived
Category:


Parameter: output_depots

Data Type: GPFeatureRecordSetLayer
Display Name Output Depots
Description:
Direction: esriGPParameterDirectionOutput
Filter:
Dependency:
Default Value:
Geometry Type: esriGeometryPoint
HasZ: false
HasM: false
Spatial Reference: 102100  (3857)  LatestVCSWkid(0)
Fields:
• ObjectID ( type: esriFieldTypeOID, alias: ObjectID )
• Name ( type: esriFieldTypeString, alias: Name, length: 500 )
• SourceID ( type: esriFieldTypeInteger, alias: SourceID )
• SourceOID ( type: esriFieldTypeInteger, alias: SourceOID )
• PosAlong ( type: esriFieldTypeDouble, alias: PosAlong )
• SideOfEdge ( type: esriFieldTypeInteger, alias: SideOfEdge )
• CurbApproach ( type: esriFieldTypeInteger, alias: CurbApproach )
• Status ( type: esriFieldTypeInteger, alias: Status )
• SnapX ( type: esriFieldTypeDouble, alias: SnapX )
• SnapY ( type: esriFieldTypeDouble, alias: SnapY )
• SnapZ ( type: esriFieldTypeDouble, alias: SnapZ )
• DistanceToNetworkInMeters ( type: esriFieldTypeDouble, alias: DistanceToNetworkInMeters )
• Bearing ( type: esriFieldTypeDouble, alias: Bearing )
• BearingTol ( type: esriFieldTypeDouble, alias: BearingTol )
• NavLatency ( type: esriFieldTypeDouble, alias: NavLatency )
Features: None.


Parameter Type: esriGPParameterTypeDerived
Category:


Parameter: output_depot_visits

Data Type: GPFeatureRecordSetLayer
Display Name Output Depot Visits
Description:
Direction: esriGPParameterDirectionOutput
Filter:
Dependency:
Default Value:
Geometry Type: esriGeometryPoint
HasZ: false
HasM: false
Spatial Reference: 102100  (3857)  LatestVCSWkid(0)
Fields:
• ObjectID ( type: esriFieldTypeOID, alias: ObjectID )
• DepotName ( type: esriFieldTypeString, alias: DepotName, length: 500 )
• VisitType ( type: esriFieldTypeInteger, alias: VisitType )
• RouteName ( type: esriFieldTypeString, alias: RouteName, length: 500 )
• Sequence ( type: esriFieldTypeInteger, alias: Sequence )
• ServiceTime ( type: esriFieldTypeDouble, alias: ServiceTime )
• FromPrevTravelTime ( type: esriFieldTypeDouble, alias: FromPrevTravelTime )
• FromPrevDistance ( type: esriFieldTypeDouble, alias: FromPrevDistance )
• ArriveTime ( type: esriFieldTypeTimestampOffset, alias: ArriveTime )
• DepartTime ( type: esriFieldTypeTimestampOffset, alias: DepartTime )
• LoadedQuantity_1 ( type: esriFieldTypeDouble, alias: LoadedQuantity_1 )
• LoadedQuantity_2 ( type: esriFieldTypeDouble, alias: LoadedQuantity_2 )
• LoadedQuantity_3 ( type: esriFieldTypeDouble, alias: LoadedQuantity_3 )
• LoadedQuantity_4 ( type: esriFieldTypeDouble, alias: LoadedQuantity_4 )
• LoadedQuantity_5 ( type: esriFieldTypeDouble, alias: LoadedQuantity_5 )
• LoadedQuantity_6 ( type: esriFieldTypeDouble, alias: LoadedQuantity_6 )
• LoadedQuantity_7 ( type: esriFieldTypeDouble, alias: LoadedQuantity_7 )
• LoadedQuantity_8 ( type: esriFieldTypeDouble, alias: LoadedQuantity_8 )
• LoadedQuantity_9 ( type: esriFieldTypeDouble, alias: LoadedQuantity_9 )
• UnloadedQuantity_1 ( type: esriFieldTypeDouble, alias: UnloadedQuantity_1 )
• UnloadedQuantity_2 ( type: esriFieldTypeDouble, alias: UnloadedQuantity_2 )
• UnloadedQuantity_3 ( type: esriFieldTypeDouble, alias: UnloadedQuantity_3 )
• UnloadedQuantity_4 ( type: esriFieldTypeDouble, alias: UnloadedQuantity_4 )
• UnloadedQuantity_5 ( type: esriFieldTypeDouble, alias: UnloadedQuantity_5 )
• UnloadedQuantity_6 ( type: esriFieldTypeDouble, alias: UnloadedQuantity_6 )
• UnloadedQuantity_7 ( type: esriFieldTypeDouble, alias: UnloadedQuantity_7 )
• UnloadedQuantity_8 ( type: esriFieldTypeDouble, alias: UnloadedQuantity_8 )
• UnloadedQuantity_9 ( type: esriFieldTypeDouble, alias: UnloadedQuantity_9 )
Features: None.


Parameter Type: esriGPParameterTypeDerived
Category:


Parameter: output_direction_points

Data Type: GPFeatureRecordSetLayer
Display Name Output Direction Points
Description:
Direction: esriGPParameterDirectionOutput
Filter:
Dependency:
Default Value:
Geometry Type:
HasZ: false
HasM: false
Spatial Reference: N/A
Fields: None

Features: None.


Parameter Type: esriGPParameterTypeDerived
Category:


Parameter: output_direction_lines

Data Type: GPFeatureRecordSetLayer
Display Name Output Direction Lines
Description:
Direction: esriGPParameterDirectionOutput
Filter:
Dependency:
Default Value:
Geometry Type:
HasZ: false
HasM: false
Spatial Reference: N/A
Fields: None

Features: None.


Parameter Type: esriGPParameterTypeDerived
Category:


Parameter: output_route_data

Data Type: GPDataFile
Display Name Output Route Data
Description:
Direction: esriGPParameterDirectionOutput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeDerived
Category:


Parameter: output_result_file

Data Type: GPDataFile
Display Name Output Result File
Description:
Direction: esriGPParameterDirectionOutput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeDerived
Category:


Parameter: output_network_analysis_layer_package

Data Type: GPDataFile
Display Name Output Network Analysis Layer Package
Description:
Direction: esriGPParameterDirectionOutput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeDerived
Category:


Parameter: usage_cost

Data Type: GPString
Display Name Usage Cost
Description:
Direction: esriGPParameterDirectionOutput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeDerived
Category:

Supported Operations:   Submit Job

Child Resources:   Metadata