Skip to main content

OrderStatus

Order status entity representing a state in the order workflow system

type OrderStatus {
  id: Int!
  name: String!
  code: String!
  type: OrderStatusType!
  orderType: OrderStatusOrderType!
  description: String
  priority: Int
  isDefault: Boolean
  isPublic: Boolean
  isEditable: Boolean
  isDeletable: Boolean
  isExportable: Boolean @deprecated
  isConfirmable: Boolean @deprecated
  isArchivable: Boolean @deprecated
  createdAt: DateTime!
  lastModifiedAt: DateTime!
  statusSet: OrderStatusSet
  nextStatuses(
    input: OrderStatusesSearchInput
  ): OrderStatusesResponse!
  previousStatuses(
    input: OrderStatusesSearchInput
  ): OrderStatusesResponse!
}

Fields​

OrderStatus.id ● Int! non-null scalar​

Unique identifier for the order status.

Used for referencing this status in API calls, workflow configurations, and order assignments.

OrderStatus.name ● String! non-null scalar​

Human-readable name for the order status.

Used for display purposes in user interfaces and reports. Provides clear identification of the status for business users.

OrderStatus.code ● String! non-null scalar​

Unique code identifier for the order status.

Uppercase alphanumeric code used for system integration, API references, and programmatic status identification.

OrderStatus.type ● OrderStatusType! non-null enum​

Classification of order status origin and management level.

SYSTEM types are built-in platform statuses that cannot be modified, while CUSTOM types are user-defined statuses for specific business workflows.

OrderStatus.orderType ● OrderStatusOrderType! non-null enum​

Type of orders this status applies to.

Determines which business processes can use this status: quotations for price quotes, orders for confirmed purchases, or requests for special inquiries.

OrderStatus.description ● String scalar​

Detailed description of the order status purpose and usage.

Provides additional context about when and how this status should be used in the order workflow.

OrderStatus.priority ● Int scalar​

Priority value for workflow ordering and sequence.

Lower numbers indicate higher priority. Used to determine the order of statuses in workflow displays and processing sequences.

OrderStatus.isDefault ● Boolean scalar​

Indicates whether this status is the default for new orders.

When true, this status will be automatically assigned to new orders when no specific status is provided during creation. Only one status per order type should be marked as default.

OrderStatus.isPublic ● Boolean scalar​

Controls visibility of orders with this status to external systems and users.

OrderStatus.isEditable ● Boolean scalar​

Determines whether this status can be modified after creation.

Orders with editable statuses allow updates to their properties, while non-editable statuses are locked to prevent accidental changes to critical workflow states.

OrderStatus.isDeletable ● Boolean scalar​

Controls whether orders with this status can be permanently removed from the system.

Orders with deletable statuses can be removed when no longer needed, while non-deletable statuses are protected from deletion to maintain workflow integrity.

OrderStatus.isExportable ● Boolean deprecated scalar​

DEPRECATED

Unused. To be removed in a future version

Marks if the order is exportable

OrderStatus.isConfirmable ● Boolean deprecated scalar​

DEPRECATED

Unused. To be removed in a future version

Marks if the order is confirmable

OrderStatus.isArchivable ● Boolean deprecated scalar​

DEPRECATED

Unused. To be removed in a future version

Marks if the order can be archived

OrderStatus.createdAt ● DateTime! non-null scalar​

Timestamp when the order status was first created.

Automatically set when the status is created and never changes, useful for tracking status lifecycle and audit purposes.

OrderStatus.lastModifiedAt ● DateTime! non-null scalar​

Timestamp when the order status was last modified.

Automatically updated whenever any property of the status is changed, enabling change tracking and audit trails.

OrderStatus.statusSet ● OrderStatusSet object​

The order status set that contains this status.

Status sets group related statuses together for workflow organization and management. This relationship enables logical grouping of statuses by business process or workflow type.

OrderStatus.nextStatuses ● OrderStatusesResponse! non-null object​

Retrieve the next possible statuses in the workflow.

Returns all order statuses that can follow the current status in the workflow, enabling proper order progression and status transition validation.

OrderStatus.nextStatuses.input ● OrderStatusesSearchInput input​

Search criteria for filtering next statuses.

If not provided, returns all possible next statuses with default pagination settings.

OrderStatus.previousStatuses ● OrderStatusesResponse! non-null object​

Retrieve the previous possible statuses in the workflow.

Returns all order statuses that can precede the current status in the workflow, useful for understanding workflow history and reverse transitions.

OrderStatus.previousStatuses.input ● OrderStatusesSearchInput input​

Search criteria for filtering previous statuses.

If not provided, returns all possible previous statuses with default pagination settings.

Returned By​

orderStatus query ● orderStatusCreate mutation ● orderStatusUpdate mutation

Member Of​

OrderStatusesResponse object ● OrderStatusSet object