Skip to main content

Dispatch Route Stop Status

Dispatch route stop statuses define the display and lifecycle state used by individual stops on daily dispatch routes.

Properties

PropertyTypeRequiredDescription
DispatchRouteStopStatusIdintYesPrimary key
OrganizationIdintYesTenant scope
StatusNamestringYesStatus label shown to dispatchers
StatusDescriptionstring?NoOptional status description
StatusStageStatusStageYesLifecycle stage: Pending, InProgress, or Completed
StopTypeDispatchRouteType?NoOptional stop type scope; null applies to any stop type
PriorityintYesDisplay sort order
Colorstring?NoOptional display color, usually hex
CustomValuesDictionaryNoExtensible custom properties

Behavior

  • Statuses are organization-scoped.
  • StatusName is unique per organization for active stop statuses.
  • StopType can scope a status to Delivery, Pickup, or PickupDelivery; leave it null for shared stop statuses.
  • Stops reference statuses through DispatchRouteStop.DispatchRouteStopStatusId.
  • A status cannot be deleted while any active dispatch route stop references it.