Skip to main content

orderStatusSetRemoveOrderStatuses

Remove order statuses from an existing order status set.

Disassociates specified order statuses from the status set while preserving the statuses themselves. The removed statuses will no longer be part of this set's workflow configuration.

Possible errors:

  • ORDER_STATUS_SET_NOT_FOUND_ERROR: Order status set with the specified ID does not exist
  • ORDER_STATUS_NOT_FOUND_ERROR: One or more specified order statuses do not exist

AUTH: Role=[order.OWNER]

orderStatusSetRemoveOrderStatuses(
  id: Int!
  input: RemoveOrderStatusesFromOrderStatusSetInput!
): OrderStatusSet!

Arguments​

orderStatusSetRemoveOrderStatuses.id ● Int! non-null scalar​

Unique identifier of the order status set to modify.

Must be a positive integer representing a valid order status set ID in the system.

orderStatusSetRemoveOrderStatuses.input ● RemoveOrderStatusesFromOrderStatusSetInput! non-null input​

List of order status IDs to remove from the set.

Contains the identifiers of order statuses that should be disassociated from this status set.

Type​

OrderStatusSet object​

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