Skip to main content

OrderStatusSet

Order status set entity for organizing related order statuses into logical workflow groups and business process containers

type OrderStatusSet {
  id: Int!
  name: String!
  description: String
  priority: Int
  orderStatuses: [OrderStatus!]
}

Fields​

OrderStatusSet.id ● Int! non-null scalar​

Unique identifier for the order status set.

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

OrderStatusSet.name ● String! non-null scalar​

Human-readable name for the order status set.

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

OrderStatusSet.description ● String scalar​

Detailed description of the order status set purpose and usage.

Provides additional context about the workflow this set represents and when it should be used for order management.

OrderStatusSet.priority ● Int scalar​

Priority value for ordering status sets.

Lower numbers indicate higher priority. Used to determine the order of status sets in listings and grouped displays.

OrderStatusSet.orderStatuses ● [OrderStatus!] list object​

Collection of order statuses contained within this set.

Represents all the possible statuses that orders can have when using this workflow configuration. The order and relationships between these statuses define the complete workflow process.

Returned By​

orderStatusSet query ● orderStatusSetAddOrderStatuses mutation ● orderStatusSetCreate mutation ● orderStatusSetRemoveOrderStatuses mutation ● orderStatusSetUpdate mutation

Member Of​

OrderStatus object ● OrderStatusSetsResponse object