Skip to main content

deleteCustomer

Delete a customer account and related data.

Import​

import { deleteCustomer } from "@evershop/evershop/customer/services";

Syntax​

deleteCustomer(uuid: string, context?: Record<string, any>): Promise<Customer>

Parameters​

uuid

Type: string

Customer UUID to delete.

context (optional)

Type: Record<string, any>

Additional context for hooks.

Return Value​

Returns Promise<Customer> with deleted customer data (password excluded).

Examples​

Basic Deletion​

import { deleteCustomer } from "@evershop/evershop/customer/services";

const deletedCustomer = await deleteCustomer('customer-uuid');
console.log(`Deleted customer: ${deletedCustomer.email}`);

Hooks​

Supports hooks via registry:

  • deleteCustomerData - Hook deletion operation
  • Can intercept to delete related data

Example hook for related data:

import { hookBefore } from "@evershop/evershop/lib/util/hookable";

hookBefore('deleteCustomerData', async (uuid, connection) => {
  // Delete customer addresses
  await del('customer_address')
    .where('customer_id', '=', customer.customer_id)
    .execute(connection);
});

See Also​