Skip to main content

CreateOrderStatusInput

Input data for creating a new order status in the workflow system

input CreateOrderStatusInput {
  name: String!
  code: String!
  type: String!
  orderType: String!
  description: String
  priority: Int
  isDefault: Boolean
  isPublic: Boolean
  isEditable: Boolean
  isDeletable: Boolean
  isExportable: Boolean
  isConfirmable: Boolean
  isArchivable: Boolean
  nextStatusesIds: [Int!]
  addOrderStatusToSet: OrderStatusSetSearchByInput
}

Fields​

CreateOrderStatusInput.name ● String! non-null scalar​

Human-readable name for the order status.

Used for display purposes in user interfaces and reports. Should be descriptive and meaningful for business users. Maximum length is 64 characters.

CreateOrderStatusInput.code ● String! non-null scalar​

Unique code identifier for the order status.

Must be uppercase and contain only letters, numbers, hyphens, and underscores. Used for system integration and API references. Maximum length is 32 characters and must match pattern: ^[A-Z0-9_-]+$

CreateOrderStatusInput.type ● String! non-null scalar​

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. Defaults to CUSTOM.

CreateOrderStatusInput.orderType ● String! non-null scalar​

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. Defaults to ORDER.

CreateOrderStatusInput.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. Maximum length is 255 characters.

CreateOrderStatusInput.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. Defaults to 0.

CreateOrderStatusInput.isDefault ● Boolean scalar​

Designates this status as the default for new orders.

Default statuses are automatically assigned to new orders when no specific status is provided during creation. Defaults to false.

CreateOrderStatusInput.isPublic ● Boolean scalar​

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

CreateOrderStatusInput.isEditable ● Boolean scalar​

Determines whether orders with 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. Defaults to false.

CreateOrderStatusInput.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. Defaults to false.

CreateOrderStatusInput.isExportable ● Boolean scalar​

Marks if the order is exportable

CreateOrderStatusInput.isConfirmable ● Boolean scalar​

Marks if the order is confirmable

CreateOrderStatusInput.isArchivable ● Boolean scalar​

Marks if the order status can be archived

CreateOrderStatusInput.nextStatusesIds ● [Int!] list scalar​

List of order status IDs that can follow this status in the workflow.

Defines the possible workflow transitions from this status to other statuses, enabling controlled order progression through the business process. Each ID must represent a valid order status.

CreateOrderStatusInput.addOrderStatusToSet ● OrderStatusSetSearchByInput input​

The order status set to associate this status with during creation.

Allows immediate assignment of the new status to an existing status set for workflow organization. The status set must exist and be accessible.

Member Of​

orderStatusCreate mutation