www/apps/resources/references/customer/ICustomerModuleService/methods/customer.ICustomerModuleService.deleteCustomers/page.mdx
import { TypeList } from "docs-ui"
This documentation provides a reference to the deleteCustomers method. This belongs to the Customer Module.
You should only use this methods when implementing complex customizations. For common cases, check out available workflows instead.
</Note>This method deletes a customer by its ID.
await customerModuleService.deleteCustomers("cus_123")
<TypeList types={[{"name":"customerId","type":"string","description":"The customer's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sharedContext","type":"Context","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"transactionManager","type":"TManager","description":"An instance of a transaction manager of type TManager, which is a typed parameter passed to the context to specify the type of the transactionManager.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"manager","type":"TManager","description":"An instance of a manager, typically an entity manager, of type TManager, which is a typed parameter passed to the context to specify the type of the manager.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationLevel","type":"string","description":"A string indicating the isolation level of the context. Possible values are READ UNCOMMITTED, READ COMMITTED, REPEATABLE READ, or SERIALIZABLE.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"enableNestedTransactions","type":"boolean","description":"A boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"eventGroupId","type":"string","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionId","type":"string","description":"A string indicating the ID of the current transaction.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"runId","type":"string","description":"A string indicating the ID of the current run.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"messageAggregator","type":"IMessageAggregator","description":"An instance of a message aggregator, which is used to aggregate messages to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"string","description":"A string indicating the ID of the current request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotencyKey","type":"string","description":"A string indicating the idempotencyKey of the current workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parentStepIdempotencyKey","type":"string","description":"A string indicating the idempotencyKey of the parent workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"preventReleaseEvents","type":"boolean","description":"preventReleaseEvents","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isCancelling","type":"boolean","description":"A boolean value indicating whether the current workflow execution is being cancelled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"cancelingFromParentStep","type":"boolean","description":"Weither or not a sub workflow cancellation is being triggered from a parent step.\nIf true, the parent step will not be triggered by the sub workflow.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="deleteCustomers"/>
<TypeList types={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"Resolves when the customer is deleted successfully.","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="deleteCustomers"/>
This method deletes customers by their IDs.
await customerModuleService.deleteCustomers(["cus_123", "cus_321"])
<TypeList types={[{"name":"customerIds","type":"string[]","description":"The IDs of customers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sharedContext","type":"Context","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"transactionManager","type":"TManager","description":"An instance of a transaction manager of type TManager, which is a typed parameter passed to the context to specify the type of the transactionManager.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"manager","type":"TManager","description":"An instance of a manager, typically an entity manager, of type TManager, which is a typed parameter passed to the context to specify the type of the manager.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationLevel","type":"string","description":"A string indicating the isolation level of the context. Possible values are READ UNCOMMITTED, READ COMMITTED, REPEATABLE READ, or SERIALIZABLE.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"enableNestedTransactions","type":"boolean","description":"A boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"eventGroupId","type":"string","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionId","type":"string","description":"A string indicating the ID of the current transaction.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"runId","type":"string","description":"A string indicating the ID of the current run.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"messageAggregator","type":"IMessageAggregator","description":"An instance of a message aggregator, which is used to aggregate messages to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"string","description":"A string indicating the ID of the current request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotencyKey","type":"string","description":"A string indicating the idempotencyKey of the current workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parentStepIdempotencyKey","type":"string","description":"A string indicating the idempotencyKey of the parent workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"preventReleaseEvents","type":"boolean","description":"preventReleaseEvents","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isCancelling","type":"boolean","description":"A boolean value indicating whether the current workflow execution is being cancelled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"cancelingFromParentStep","type":"boolean","description":"Weither or not a sub workflow cancellation is being triggered from a parent step.\nIf true, the parent step will not be triggered by the sub workflow.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="deleteCustomers"/>
<TypeList types={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"Resolves when the customers are deleted successfully.","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="deleteCustomers"/>
This method deletes a customer matching the specified filters.
await customerModuleService.deleteCustomers({
id: ["cus_123"],
})
<TypeList types={[{"name":"selector","type":"FilterableCustomerProps","description":"The filters that specify which customers should be deleted.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"q","type":"string","description":"Searches for customers by properties such as name and email using this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"string \| string[]","description":"The IDs to filter the customer by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"string \| string[] \| OperatorMap<string>","description":"Filter by email.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"Query<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"Query<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$eq","type":"ExpandScalar<T> \| ExpandScalar<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ne","type":"ExpandScalar<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$in","type":"ExpandScalar<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$nin","type":"ExpandScalar<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$not","type":"Query<T>","description":"API wrapper around the remoteQuery","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gt","type":"ExpandScalar<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gte","type":"ExpandScalar<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lt","type":"ExpandScalar<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lte","type":"ExpandScalar<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$like","type":"string","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$re","type":"string","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ilike","type":"string","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$fulltext","type":"string","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$overlap","type":"string[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contains","type":"string[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contained","type":"string[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$exists","type":"boolean","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"groups","type":"string \| string[] \| FilterableCustomerGroupProps","description":"Filter by associated customer group.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"q","type":"string","description":"Searches for customer groups by name using this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"string \| string[]","description":"The IDs to filter the customer group by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"string \| OperatorMap<string>","description":"Filter customer groups by name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customers","type":"string \| string[] \| FilterableCustomerProps","description":"Filter customer groups by associated customers.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"null \| string \| string[]","description":"Filter customer groups by their created_by attribute.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"OperatorMap<string>","description":"Filter customer groups by created date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"OperatorMap<string>","description":"Filter customer groups by updated date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"(FilterableCustomerGroupProps \| BaseFilterable<FilterableCustomerGroupProps>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an "and" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"(FilterableCustomerGroupProps \| BaseFilterable<FilterableCustomerGroupProps>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an "or" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"default_billing_address_id","type":"null \| string \| string[]","description":"Filter by the associated default billing address's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"default_shipping_address_id","type":"null \| string \| string[]","description":"Filter by the associated default shipping address's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company_name","type":"null \| string \| string[] \| OperatorMap<string>","description":"Filter by company name.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"Query<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"Query<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$eq","type":"ExpandScalar<T> \| ExpandScalar<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ne","type":"ExpandScalar<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$in","type":"ExpandScalar<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$nin","type":"ExpandScalar<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$not","type":"Query<T>","description":"API wrapper around the remoteQuery","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gt","type":"ExpandScalar<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gte","type":"ExpandScalar<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lt","type":"ExpandScalar<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lte","type":"ExpandScalar<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$like","type":"string","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$re","type":"string","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ilike","type":"string","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$fulltext","type":"string","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$overlap","type":"string[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contains","type":"string[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contained","type":"string[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$exists","type":"boolean","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"first_name","type":"null \| string \| string[] \| OperatorMap<string>","description":"Filter by first name.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"Query<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"Query<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$eq","type":"ExpandScalar<T> \| ExpandScalar<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ne","type":"ExpandScalar<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$in","type":"ExpandScalar<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$nin","type":"ExpandScalar<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$not","type":"Query<T>","description":"API wrapper around the remoteQuery","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gt","type":"ExpandScalar<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gte","type":"ExpandScalar<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lt","type":"ExpandScalar<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lte","type":"ExpandScalar<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$like","type":"string","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$re","type":"string","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ilike","type":"string","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$fulltext","type":"string","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$overlap","type":"string[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contains","type":"string[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contained","type":"string[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$exists","type":"boolean","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"last_name","type":"null \| string \| string[] \| OperatorMap<string>","description":"Filter by last name.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"Query<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"Query<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$eq","type":"ExpandScalar<T> \| ExpandScalar<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ne","type":"ExpandScalar<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$in","type":"ExpandScalar<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$nin","type":"ExpandScalar<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$not","type":"Query<T>","description":"API wrapper around the remoteQuery","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gt","type":"ExpandScalar<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gte","type":"ExpandScalar<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lt","type":"ExpandScalar<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lte","type":"ExpandScalar<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$like","type":"string","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$re","type":"string","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ilike","type":"string","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$fulltext","type":"string","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$overlap","type":"string[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contains","type":"string[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contained","type":"string[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$exists","type":"boolean","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"has_account","type":"boolean \| OperatorMap<boolean>","description":"Filter by whether the customer has an account.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"Query<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"Query<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$eq","type":"ExpandScalar<T> \| ExpandScalar<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ne","type":"ExpandScalar<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$in","type":"ExpandScalar<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$nin","type":"ExpandScalar<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$not","type":"Query<T>","description":"API wrapper around the remoteQuery","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gt","type":"ExpandScalar<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gte","type":"ExpandScalar<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lt","type":"ExpandScalar<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lte","type":"ExpandScalar<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$like","type":"string","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$re","type":"string","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ilike","type":"string","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$fulltext","type":"string","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$overlap","type":"string[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contains","type":"string[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contained","type":"string[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$exists","type":"boolean","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"created_by","type":"null \| string \| string[]","description":"Filter by the created_by attribute.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"OperatorMap<string>","description":"Filter by created date.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"Query<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"Query<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$eq","type":"ExpandScalar<T> \| ExpandScalar<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ne","type":"ExpandScalar<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$in","type":"ExpandScalar<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$nin","type":"ExpandScalar<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$not","type":"Query<T>","description":"API wrapper around the remoteQuery","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gt","type":"ExpandScalar<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gte","type":"ExpandScalar<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lt","type":"ExpandScalar<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lte","type":"ExpandScalar<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$like","type":"string","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$re","type":"string","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ilike","type":"string","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$fulltext","type":"string","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$overlap","type":"string[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contains","type":"string[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contained","type":"string[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$exists","type":"boolean","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"updated_at","type":"OperatorMap<string>","description":"Filter by updated date.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"Query<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"Query<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$eq","type":"ExpandScalar<T> \| ExpandScalar<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ne","type":"ExpandScalar<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$in","type":"ExpandScalar<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$nin","type":"ExpandScalar<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$not","type":"Query<T>","description":"API wrapper around the remoteQuery","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gt","type":"ExpandScalar<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gte","type":"ExpandScalar<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lt","type":"ExpandScalar<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lte","type":"ExpandScalar<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$like","type":"string","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$re","type":"string","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ilike","type":"string","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$fulltext","type":"string","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$overlap","type":"string[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contains","type":"string[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contained","type":"string[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$exists","type":"boolean","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$and","type":"(FilterableCustomerProps \| BaseFilterable<FilterableCustomerProps>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an "and" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"q","type":"string","description":"Searches for customers by properties such as name and email using this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"string \| string[]","description":"The IDs to filter the customer by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"string \| string[] \| OperatorMap<string>","description":"Filter by email.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"groups","type":"string \| string[] \| FilterableCustomerGroupProps","description":"Filter by associated customer group.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"default_billing_address_id","type":"null \| string \| string[]","description":"Filter by the associated default billing address's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"default_shipping_address_id","type":"null \| string \| string[]","description":"Filter by the associated default shipping address's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company_name","type":"null \| string \| string[] \| OperatorMap<string>","description":"Filter by company name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"null \| string \| string[] \| OperatorMap<string>","description":"Filter by first name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"null \| string \| string[] \| OperatorMap<string>","description":"Filter by last name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"has_account","type":"boolean \| OperatorMap<boolean>","description":"Filter by whether the customer has an account.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"null \| string \| string[]","description":"Filter by the created_by attribute.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"OperatorMap<string>","description":"Filter by created date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"OperatorMap<string>","description":"Filter by updated date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"(FilterableCustomerProps \| BaseFilterable<FilterableCustomerProps>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an "and" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"(FilterableCustomerProps \| BaseFilterable<FilterableCustomerProps>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an "or" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"(FilterableCustomerProps \| BaseFilterable<FilterableCustomerProps>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an "or" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"q","type":"string","description":"Searches for customers by properties such as name and email using this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"string \| string[]","description":"The IDs to filter the customer by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"string \| string[] \| OperatorMap<string>","description":"Filter by email.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"groups","type":"string \| string[] \| FilterableCustomerGroupProps","description":"Filter by associated customer group.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"default_billing_address_id","type":"null \| string \| string[]","description":"Filter by the associated default billing address's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"default_shipping_address_id","type":"null \| string \| string[]","description":"Filter by the associated default shipping address's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company_name","type":"null \| string \| string[] \| OperatorMap<string>","description":"Filter by company name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"null \| string \| string[] \| OperatorMap<string>","description":"Filter by first name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"null \| string \| string[] \| OperatorMap<string>","description":"Filter by last name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"has_account","type":"boolean \| OperatorMap<boolean>","description":"Filter by whether the customer has an account.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"null \| string \| string[]","description":"Filter by the created_by attribute.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"OperatorMap<string>","description":"Filter by created date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"OperatorMap<string>","description":"Filter by updated date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"(FilterableCustomerProps \| BaseFilterable<FilterableCustomerProps>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an "and" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"(FilterableCustomerProps \| BaseFilterable<FilterableCustomerProps>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an "or" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"sharedContext","type":"Context","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"transactionManager","type":"TManager","description":"An instance of a transaction manager of type TManager, which is a typed parameter passed to the context to specify the type of the transactionManager.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"manager","type":"TManager","description":"An instance of a manager, typically an entity manager, of type TManager, which is a typed parameter passed to the context to specify the type of the manager.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationLevel","type":"string","description":"A string indicating the isolation level of the context. Possible values are READ UNCOMMITTED, READ COMMITTED, REPEATABLE READ, or SERIALIZABLE.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"enableNestedTransactions","type":"boolean","description":"A boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"eventGroupId","type":"string","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionId","type":"string","description":"A string indicating the ID of the current transaction.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"runId","type":"string","description":"A string indicating the ID of the current run.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"messageAggregator","type":"IMessageAggregator","description":"An instance of a message aggregator, which is used to aggregate messages to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"string","description":"A string indicating the ID of the current request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotencyKey","type":"string","description":"A string indicating the idempotencyKey of the current workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parentStepIdempotencyKey","type":"string","description":"A string indicating the idempotencyKey of the parent workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"preventReleaseEvents","type":"boolean","description":"preventReleaseEvents","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isCancelling","type":"boolean","description":"A boolean value indicating whether the current workflow execution is being cancelled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"cancelingFromParentStep","type":"boolean","description":"Weither or not a sub workflow cancellation is being triggered from a parent step.\nIf true, the parent step will not be triggered by the sub workflow.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="deleteCustomers"/>
<TypeList types={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"Resolves when the customers are deleted successfully.","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="deleteCustomers"/>