Skip to main content

Overview

The RiderDto represents information about a delivery courier (rider) in the KDS system. It contains identification details for both the rider and the associated order, used for tracking courier assignments and managing delivery workflows.

Type Definition

export type RiderDto = {
  id: string
  name: string
  orderId: string
  displayNumber: string
  riderNumber: number
  partnerName?: string
}

Fields

id
string
required
Unique identifier for the rider in the system
name
string
required
Full name of the delivery courier/rider
orderId
string
required
Unique identifier of the order assigned to this rider
displayNumber
string
required
Human-readable order number for display purposes (e.g., “#1234”)
riderNumber
number
required
Numeric identifier or sequence number for the rider, potentially used for display or sorting
partnerName
string
Name of the restaurant or merchant partner associated with the rider’s current assignment

Usage

This DTO is typically used in:
  • Courier assignment interfaces
  • Delivery tracking screens
  • Order-to-courier matching displays
  • Rider management dashboards
  • Pickup coordination views

Common Scenarios

Rider Assignment

When a rider is assigned to pick up an order, the RiderDto links the courier to the specific order through the orderId field.

Multi-Partner Operations

The optional partnerName field allows tracking which restaurant or merchant the rider is currently serving, useful in cloud kitchen or multi-tenant scenarios.

Display Organization

The combination of displayNumber and riderNumber provides flexible options for organizing and presenting rider information in the user interface.
  • OrderListDto - Order list information including courier assignment
  • OrderDetailDto - Detailed order information with courier name

Source

dtos/Rider.dto.ts

Build docs developers (and LLMs) love