Skip to main content

customerDelete

Permanently delete a customer and all associated data from the system.

Key Features​

  • **Complete Removal**: Deletes customer record and all associated data
  • **Cascade Operations**: Removes related addresses, sources, and attributes
  • **Account Cleanup**: Removes associated login account if it exists
  • **Data Integrity**: Ensures clean removal without orphaned records

Business Rules​

  • Customer must exist before deletion
  • Deletion is permanent and cannot be undone
  • All associated addresses are removed
  • Login account is deleted if it exists
  • Related data in other systems may be affected

Error Scenarios​

  • **CUSTOMER_NOT_FOUND_ERROR**: Customer with the specified ID does not exist
  • **CUSTOMER_DELETE_ERROR**: System error occurred during customer deletion
  • **CUSTOMER_DELETE_ACCOUNT_ERROR**: Error occurred while deleting associated login account

Use Cases​

  • Customer data cleanup and maintenance
  • GDPR compliance and data removal requests
  • Customer account closure
  • Data migration and system cleanup

Warning: This operation is irreversible and will permanently remove all customer data.

AUTH: Role=[user.OWNER]

customerDelete(
  id: Int!
): Boolean!

Arguments​

customerDelete.id ● Int! non-null scalar​

Unique internal identifier for the customer used for system operations and data relationships

Type​

Boolean scalar​

The Boolean scalar type represents true or false.