Skip to main content

Dispatch Route Status

Dispatch route statuses define the display and lifecycle state used by daily dispatch routes.

Properties​

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

Behavior​

  • Statuses are organization-scoped.
  • A status cannot be deleted while active dispatch routes reference it.
  • RouteType can scope a status to Delivery, Pickup, or PickupDelivery; leave it null for shared statuses.