OrderStatus

OrderStatus type definition

Properties

• id (string): Unique identifier.
• order ([[Order]]): The order this status belongs to.
• status (string): Current status code (pending, confirmed, processing, shipped, delivered, cancelled).
• label (string): Human-readable status label.
• description (string): Detailed description of the current status.
• category (string): Status category (order, payment, fulfillment, shipping).
• progress (number): Completion percentage (0-100).
• isComplete (boolean): Whether this is a terminal status.
• isSuccess (boolean): Whether status indicates successful completion.
• isError (boolean): Whether status indicates an error state.
• metadata (object): Additional status information.
• previousStatus (string): Previous status code.
• changedAt (string): Timestamp when status changed.
• changedBy ([[User]]): User or system that changed the status.
• reason (string): Reason for status change.
• notes (string): Additional notes about the status.
• createdAt (string): Creation timestamp.

Actions

create

Create new status.

Input: [[OrderStatus]]
Output: [[OrderStatus]]

read

Retrieve status by ID.

Input: string
Output: [[OrderStatus]]

update

Update status.

Input: [[OrderStatus]]
Output: [[OrderStatus]]

delete

Delete status.

Input: string
Output: boolean

list

List status history for order.

Input: string
Output: [[OrderStatus]][]

transition

Transition to new status.

Input: object
Output: [[OrderStatus]]

validate

Validate status transition is allowed.

Input: object
Output: boolean

Events

• created: Fired when created.
• updated: Fired when updated.
• deleted: Fired when deleted.
• changed: Fired when status changes.
• completed: Fired when order reaches complete status.
• error: Fired when status indicates error.