UpdateRoutePlanningSettingsInput

Changes to the route planning rules. Send only the rules to change; the rest keep their values.

input UpdateRoutePlanningSettingsInput {
  daysOff: [String!]
  defaultVisitFrequencyDays: Int
  keepManualStops: Boolean
  maxSameDayRadiusKm: Int
  minutesPerVisit: Int
  missedStops: RoutePlanningMissedStops
  mode: RoutePlanningMode
  newCustomerFromRep: RoutePlanningNewCustomerFromRep
  notifyReps: RoutePlanningNotify
  planAheadWorkingDays: Int
  plannedCustomerStatuses: [String!]
  reassignedCustomerStops: RoutePlanningReassignedStops
  repScope: RoutePlanningRepScope
  replanMode: RoutePlanningReplanMode
  requireRemovalReason: Boolean
  scheduleFrequency: RoutePlanningScheduleFrequency
  scheduleTime: String
  scheduleWeekday: Int
  selectedRepIds: [String!]
  unmappedCustomers: RoutePlanningUnmappedCustomers
  useCustomerTier: Boolean
  workdayEnd: String
  workdayStart: String
  workingDays: [Int!]
}

Fields

UpdateRoutePlanningSettingsInput.daysOff ● [String!] list scalar

Days off, written YYYY-MM-DD; at most 200.

UpdateRoutePlanningSettingsInput.defaultVisitFrequencyDays ● Int scalar

Days between visits for a customer with no frequency of their own, 1 to 365.

UpdateRoutePlanningSettingsInput.keepManualStops ● Boolean scalar

True to keep, when rebuilding, the stops an admin or rep placed by hand and any stop no planning run placed.

UpdateRoutePlanningSettingsInput.maxSameDayRadiusKm ● Int scalar

The farthest, in kilometres, a stop may be from the rest of its day, 1 to 500.

UpdateRoutePlanningSettingsInput.minutesPerVisit ● Int scalar

Minutes planned for each visit, 5 to 480.

UpdateRoutePlanningSettingsInput.missedStops ● RoutePlanningMissedStops enum

How missed stops are planned again.

UpdateRoutePlanningSettingsInput.mode ● RoutePlanningMode enum

Manual or automatic planning.

UpdateRoutePlanningSettingsInput.newCustomerFromRep ● RoutePlanningNewCustomerFromRep enum

What happens when a rep adds a new customer in the field.

UpdateRoutePlanningSettingsInput.notifyReps ● RoutePlanningNotify enum

When reps are told their route changed.

UpdateRoutePlanningSettingsInput.planAheadWorkingDays ● Int scalar

Working days a run plans ahead, 1 to 30.

UpdateRoutePlanningSettingsInput.plannedCustomerStatuses ● [String!] list scalar

The customer statuses to plan. Inactive customers are never planned.

UpdateRoutePlanningSettingsInput.reassignedCustomerStops ● RoutePlanningReassignedStops enum

What happens to future stops of a customer moved to another rep.

UpdateRoutePlanningSettingsInput.repScope ● RoutePlanningRepScope enum

Which reps planning covers.

UpdateRoutePlanningSettingsInput.replanMode ● RoutePlanningReplanMode enum

What a run does with stops already on the route.

UpdateRoutePlanningSettingsInput.requireRemovalReason ● Boolean scalar

True to ask for a reason when a stop is removed.

UpdateRoutePlanningSettingsInput.scheduleFrequency ● RoutePlanningScheduleFrequency enum

How often automatic planning runs.

UpdateRoutePlanningSettingsInput.scheduleTime ● String scalar

The run time, HH:MM.

UpdateRoutePlanningSettingsInput.scheduleWeekday ● Int scalar

The weekday of a weekly run, 1 (Monday) to 7 (Sunday).

UpdateRoutePlanningSettingsInput.selectedRepIds ● [String!] list scalar

The reps planning covers when the scope is SELECTED.

UpdateRoutePlanningSettingsInput.unmappedCustomers ● RoutePlanningUnmappedCustomers enum

How customers with no location are planned.

UpdateRoutePlanningSettingsInput.useCustomerTier ● Boolean scalar

True to plan higher-tier customers first when days are full.

UpdateRoutePlanningSettingsInput.workdayEnd ● String scalar

When the working day ends, HH:MM.

UpdateRoutePlanningSettingsInput.workdayStart ● String scalar

When the working day starts, HH:MM.

UpdateRoutePlanningSettingsInput.workingDays ● [Int!] list scalar

The working weekdays, 1 (Monday) to 7 (Sunday), each once.

Member Of

updateRoutePlanningSettings mutation