Skip to main content

orderStatusDelete

Permanently delete an order status from the workflow system.

Removes the order status and all associated configuration. This action cannot be undone and will affect any orders or workflows that depend on this status.

Possible errors:

  • ORDER_STATUS_NOT_FOUND_ERROR: Order status with the specified ID does not exist

AUTH: Role=[order.OWNER]

orderStatusDelete(
  id: Int!
): Boolean!

Arguments​

orderStatusDelete.id ● Int! non-null scalar​

Unique identifier of the order status to delete.

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

Type​

Boolean scalar​

The Boolean scalar type represents true or false.