Skip to main content

orderDelete

Permanently delete an order from the system.

Removes the order and all associated data including items, addresses, and shipments. This action cannot be undone and should be used with caution.

Possible errors:

  • ORDER_NOT_FOUND: Order with the specified ID does not exist
  • ORDER_DELETE_ERROR: Failed to delete the order due to system error
  • VALIDATION_ERROR: Invalid order ID provided
  • FORBIDDEN: Insufficient permissions to delete orders

AUTH: Role=[order.OWNER]

orderDelete(
  orderId: Int!
): Boolean!

Arguments​

orderDelete.orderId ● Int! non-null scalar​

Unique identifier of the order to delete.

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

Type​

Boolean scalar​

The Boolean scalar type represents true or false.