Sign in

v1

latestOpenAPI 3.1.02026-07-2296226496.3 KB
Optimization Strategies

Update Optimization Strategy

Update an existing optimization strategy. Only provided fields are updated. Supplying optimization_schedules replaces the existing schedules.

patch/v1/optimization-strategies/{id}

Path parameters

idstring required

Request body

contractIdsstring[] nullable

Contracts considered during optimization.

shiftContractIdstring nullable

Contract id of the provider supplying shifts for this strategy.

pickupServiceTimeSecondsinteger nullable
dropoffServiceTimeSecondsinteger nullable
incrementalServiceTimeSecondsinteger nullable
enableAutoDispatchboolean nullable
autodispatchWithinXMinutesOfPickupTimeinteger nullable

Deprecated. Use pickup_time_from_in_minutes / pickup_time_to_in_minutes.

earliestDispatchMinutesBeforePickupinteger nullable

Deprecated. Use pickup_time_from_in_minutes / pickup_time_to_in_minutes.

pickupTimeFromInMinutesinteger nullable

Lower bound (inclusive) of the pickup time window to optimize, in minutes from now.

pickupTimeToInMinutesinteger nullable

Upper bound (exclusive) of the pickup time window to optimize, in minutes from now.

unassignedOrdersOptionsGroupIdstring nullable
defaultTrafficSourcestring nullable
trafficTimeOffsetWeeksinteger nullable
zonesstring[] nullable

Zone ids assigned to this strategy.

storeLocationsstring[] nullable

Store location ids assigned to this strategy.

softCapabilitiesstring[] nullable
searchLevelinteger nullable
clusteringLevelinteger nullable
softClusterLabelboolean nullable
balanceRoutes'none' | 'same_vehicle_type' | 'all_vehicle_types'
saveOptimizedRoutesboolean nullable
labelstring nullable