Skip to main content

RoutePlanningRemovedStop

A stop removed from a rep's day.

type RoutePlanningRemovedStop {
  partnerId: String!
  partnerName: String
  reason: String
  removedAt: DateTime
  removedByName: String
  removedBySource: RoutePlanningChangeSource
  removedByUserId: String
  restorable: Boolean!
  runId: ID
  sequence: Int!
  visitId: String!
  wasUnplanned: Boolean!
}

Fields​

RoutePlanningRemovedStop.partnerId ● String! non-null scalar​

The ID of the customer.

RoutePlanningRemovedStop.partnerName ● String scalar​

The name of the customer.

RoutePlanningRemovedStop.reason ● String scalar​

Why the stop was removed.

RoutePlanningRemovedStop.removedAt ● DateTime scalar​

When it was removed.

RoutePlanningRemovedStop.removedByName ● String scalar​

The name of the person who removed it.

RoutePlanningRemovedStop.removedBySource ● RoutePlanningChangeSource enum​

Whether the planner, an admin or the rep removed it.

RoutePlanningRemovedStop.removedByUserId ● String scalar​

The ID of the person who removed it.

RoutePlanningRemovedStop.restorable ● Boolean! non-null scalar​

True when restoreVisit would accept it: the day is today or later, it was never visited, the customer is still the rep's and is not already on that day's route.

RoutePlanningRemovedStop.runId ● ID scalar​

The planning run that removed it, or whose undo removed it. Empty when a person removed it.

RoutePlanningRemovedStop.sequence ● Int! non-null scalar​

The stop's position when it was removed.

RoutePlanningRemovedStop.visitId ● String! non-null scalar​

The ID of the removed visit.

RoutePlanningRemovedStop.wasUnplanned ● Boolean! non-null scalar​

True when the stop was an unplanned visit.

Member Of​

RoutePlanningRepDay object