Skip to main content

RoutePlanningSettings

The organization's route planning rules, with the values worked out from them.

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

Fields

`RoutePlanningSettings.daysOff` ● `[String!]!` non-null scalar

Days off, written YYYY-MM-DD, in order.

`RoutePlanningSettings.defaultVisitFrequencyDays` ● `Int!` non-null scalar

Days between visits for a customer with no visit frequency of their own.

`RoutePlanningSettings.isDefault` ● `Boolean!` non-null scalar

True when no rules have been saved yet and defaults apply.

`RoutePlanningSettings.keepManualStops` ● `Boolean!` non-null scalar

True to keep, when rebuilding, the stops an admin or rep placed by hand and any stop no planning run placed, such as one saved before route planning.

`RoutePlanningSettings.maxSameDayRadiusKm` ● `Int!` non-null scalar

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

`RoutePlanningSettings.minutesPerVisit` ● `Int!` non-null scalar

Minutes planned for each visit, 5 to 480.

`RoutePlanningSettings.missedStops` ● `RoutePlanningMissedStops!` non-null enum

How missed stops are planned again.

`RoutePlanningSettings.mode` ● `RoutePlanningMode!` non-null enum

Manual or automatic planning.

`RoutePlanningSettings.newCustomerFromRep` ● `RoutePlanningNewCustomerFromRep!` non-null enum

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

`RoutePlanningSettings.nextRunAt` ● `DateTime` scalar

When automatic planning runs next. Empty when planning is manual.

`RoutePlanningSettings.notifyReps` ● `RoutePlanningNotify!` non-null enum

When reps are told their route changed.

`RoutePlanningSettings.planAheadWorkingDays` ● `Int!` non-null scalar

How many working days ahead a run plans, 1 to 30.

`RoutePlanningSettings.planEndsOn` ● `DateTime` scalar

The last day the next automatic run plans up to. Empty when planning is manual.

`RoutePlanningSettings.plannedCustomerStatuses` ● `[String!]!` non-null scalar

The customer statuses that are planned.

`RoutePlanningSettings.reassignedCustomerStops` ● `RoutePlanningReassignedStops!` non-null enum

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

`RoutePlanningSettings.repScope` ● `RoutePlanningRepScope!` non-null enum

Which reps planning covers.

`RoutePlanningSettings.replanMode` ● `RoutePlanningReplanMode!` non-null enum

What a run does with stops already on the route.

`RoutePlanningSettings.requireRemovalReason` ● `Boolean!` non-null scalar

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

`RoutePlanningSettings.scheduleFrequency` ● `RoutePlanningScheduleFrequency!` non-null enum

How often automatic planning runs.

`RoutePlanningSettings.scheduleTime` ● `String!` non-null scalar

The run time, HH:MM in the organization's time zone.

`RoutePlanningSettings.scheduleWeekday` ● `Int!` non-null scalar

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

`RoutePlanningSettings.selectedRepIds` ● `[String!]!` non-null scalar

The reps planning covers when the scope is SELECTED.

`RoutePlanningSettings.stopsPerDay` ● `Int!` non-null scalar

Stops that fit in one working day: the workday length divided by the time per visit.

`RoutePlanningSettings.timeZone` ● `String!` non-null scalar

The organization's time zone.

`RoutePlanningSettings.unmappedCustomers` ● `RoutePlanningUnmappedCustomers!` non-null enum

How customers with no location are planned.

`RoutePlanningSettings.useCustomerTier` ● `Boolean!` non-null scalar

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

`RoutePlanningSettings.workdayEnd` ● `String!` non-null scalar

When the working day ends, HH:MM.

`RoutePlanningSettings.workdayStart` ● `String!` non-null scalar

When the working day starts, HH:MM.

`RoutePlanningSettings.workingDays` ● `[Int!]!` non-null scalar

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

Returned By

routePlanningSettings query ● updateRoutePlanningSettings mutation

Fields
Returned By