Skip to main content

GenerateRoutePlanInput

Generates the full route plan of one cycle for one rep. It covers the customers whose visit frequency equals the cycle length.

input GenerateRoutePlanInput {
  cycleLengthDays: Int!
  cycleStartDate: DateTime!
  includeSundays: Boolean
  salesRepId: String!
}

Fields​

GenerateRoutePlanInput.cycleLengthDays ● Int! non-null scalar​

The visit frequency group to generate, and the number of working days the cycle spans.

GenerateRoutePlanInput.cycleStartDate ● DateTime! non-null scalar​

The first day of the cycle. The plan starts on the rep's first working day on or after it.

GenerateRoutePlanInput.includeSundays ● Boolean scalar​

True to treat this cycle as a seven-day week with Sunday included, for this call only. The organization's setting is not changed.

GenerateRoutePlanInput.salesRepId ● String! non-null scalar​

The ID of the rep.

Member Of​

generateRoutePlan mutation