Skip to main content
PATCH
Update Optimization Strategy

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Body

application/json
optimizationSchedules
OptimizationScheduleInputSerializer · object[] | null
contractIds
string[] | null

Contracts considered during optimization.

shiftContractId
string | null

Contract id of the provider supplying shifts for this strategy.

pickupServiceTimeSeconds
integer | null
dropoffServiceTimeSeconds
integer | null
incrementalServiceTimeSeconds
integer | null
enableAutoDispatch
boolean | null
autodispatchWithinXMinutesOfPickupTime
integer | null

Deprecated. Use pickup_time_from_in_minutes / pickup_time_to_in_minutes.

earliestDispatchMinutesBeforePickup
integer | null

Deprecated. Use pickup_time_from_in_minutes / pickup_time_to_in_minutes.

pickupTimeFromInMinutes
integer | null

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

pickupTimeToInMinutes
integer | null

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

contractOptimizationOverrideParameters
ContractOverrideParametersSerializer · object[] | null
unassignedOrdersOptionsGroupId
string | null
defaultTrafficSource
string | null
trafficTimeOffsetWeeks
integer | null
zones
string[] | null

Zone ids assigned to this strategy.

storeLocations
string[] | null

Store location ids assigned to this strategy.

softCapabilities
string[] | null
searchLevel
integer | null
clusteringLevel
integer | null
softClusterLabel
boolean | null
balanceRoutes
enum<string> | null
Available options:
none,
same_vehicle_type,
all_vehicle_types
saveOptimizedRoutes
boolean | null
dynamicCadenceConfig
DynamicCadenceConfigInputSerializer · object | null
label
string | null

Response

422 - application/json

Unprocessable Content

error
NashErrorDetails · object
required
response_status
string
required
RequestID
string
required