Skip to main content

​
Overview

The OrderListDto represents a condensed view of an order optimized for list displays in the Kitchen Display System. It contains essential information needed to display orders in the queue, including status, priority, and basic identification details.

​
Type Definition

import { OrderStatus } from "@/domain/order/order-status";

export type OrderPriority = "NORMAL" | "HIGH";

export type OrderListDto = {
  id: string;
  partnerName?: string;
  partnerImage?: string;
  displayNumber: string;
  status: OrderStatus;
  priority: OrderPriority;
  activeTimer?: string;
  courierName?: string;
};

​
Fields

​
id
string
required
Unique identifier for the order
​
partnerName
string
Name of the restaurant or merchant partner associated with this order
​
partnerImage
string
URL or path to the partner’s logo/image for display purposes
​
displayNumber
string
required
Human-readable order number shown to kitchen staff (e.g., “#1234”)
​
status
OrderStatus
required
Current status of the order in the fulfillment workflow
​
priority
OrderPriority
required
Priority level of the order affecting display and sorting
  • NORMAL - Standard priority order
  • HIGH - High priority order requiring immediate attention
​
activeTimer
string
ISO 8601 duration string or timestamp representing active timer for the order (e.g., time since received or time until ready)
​
courierName
string
Name of the delivery courier assigned to this order

​
Usage

This DTO is typically used in:
  • Order queue list views
  • Real-time order status displays
  • Dashboard overview screens
  • Order filtering and sorting operations
  • OrderDetailDto - Full order details with customer information and items
  • RiderDto - Courier/rider information

​
Source

dtos/OrderList.dto.ts

Build docs developers (and LLMs) love

Get started for freeTalk to us