Skip to main content

UpdateOrderStatusInput

Input data for updating an existing order status with partial field updates

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

Fields

UpdateOrderStatusInput.name ● String 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.

UpdateOrderStatusInput.code ● String 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_-]+$

UpdateOrderStatusInput.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.

UpdateOrderStatusInput.orderType ● OrderStatusOrderType 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.

UpdateOrderStatusInput.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. Must be a non-negative integer.

UpdateOrderStatusInput.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.

UpdateOrderStatusInput.isPublic ● Boolean scalar

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

UpdateOrderStatusInput.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.

UpdateOrderStatusInput.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.

UpdateOrderStatusInput.isExportable ● Boolean scalar

Marks if the order is exportable

UpdateOrderStatusInput.isConfirmable ● Boolean scalar

Marks if the order is confirmable

UpdateOrderStatusInput.isArchivable ● Boolean scalar

Marks if the order can be archived

UpdateOrderStatusInput.nextStatusesIds ● [Int!] list scalar

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

Updates the possible workflow transitions from this status to other statuses. Each ID must represent a valid order status. Array must contain unique values.

UpdateOrderStatusInput.addOrderStatusToSet ● OrderStatusSetSearchByInput input

The order status set to associate this status with.

Updates the status set assignment for workflow organization. The status set must exist and be accessible.

Member Of

orderStatusUpdate mutation