Skip to main content
Skip to main content

CustomerGroupService

Properties​

__configModule__Record<string, unknown>
__container__anyRequired
__moduleDeclaration__Record<string, unknown>
customerGroupRepository_Repository<CustomerGroup> & { addCustomers: Method addCustomers ; findWithRelationsAndCount: Method findWithRelationsAndCount ; removeCustomers: Method removeCustomers }Required
customerService_CustomerServiceRequired
handleCreationFailanyRequired
manager_EntityManagerRequired
transactionManager_undefined | EntityManagerRequired

Accessors​

activeManager_​

Inherited from​

TransactionBaseService.activeManager_

Methods​

addCustomers​

Add a batch of customers to a customer group at once

Parameters​
idstringRequired
id of the customer group to add customers to
customerIdsstring | string[]Required
customer id's to add to the group
Returns​
PromisePromise<CustomerGroup>Required
the customer group after insertion

atomicPhase_​

Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created.

Parameters​
work(transactionManager: EntityManager) => Promise<TResult>Required
the transactional work to be done
isolationOrErrorHandlerIsolationLevel | (error: TError) => Promise<void | TResult>
the isolation level to be used for the work.
maybeErrorHandlerOrDontFail(error: TError) => Promise<void | TResult>
Potential error handler
Returns​
PromisePromise<TResult>Required
the result of the transactional work

create​

Creates a customer group with the provided data.

Parameters​
groupDeepPartial<CustomerGroup>Required
the customer group to create
Returns​
PromisePromise<CustomerGroup>Required
the result of the create operation

delete​

Remove customer group

Parameters​
groupIdstringRequired
id of the customer group to delete
Returns​
PromisePromise<void>Required
a promise

list​

List customer groups.

Parameters​
selectorundefined | Selector<CustomerGroup> & { discount_condition_id?: string ; q?: string }Required
the query object for find
configFindConfig<CustomerGroup>Required
the config to be used for find
Returns​
PromisePromise<CustomerGroup[]>Required
the result of the find operation

listAndCount​

Retrieve a list of customer groups and total count of records that match the query.

Parameters​
selectorundefined | Selector<CustomerGroup> & { discount_condition_id?: string ; q?: string }Required
the query object for find
configFindConfig<CustomerGroup>Required
the config to be used for find
Returns​
PromisePromise<[CustomerGroup[], number]>Required
the result of the find operation

removeCustomer​

Remove list of customers from a customergroup

Parameters​
idstringRequired
id of the customer group from which the customers are removed
customerIdsstring | string[]Required
id's of the customer to remove from group
Returns​
PromisePromise<CustomerGroup>Required
the customergroup with the provided id

retrieve​

Parameters​
customerGroupIdstringRequired
configobject
Returns​
PromisePromise<CustomerGroup>Required

shouldRetryTransaction_​

Parameters​
errRecord<string, unknown> | { code: string }Required
Returns​
booleanboolean

update​

Update a customer group.

Parameters​
customerGroupIdstringRequired
id of the customer group
updateCustomerGroupUpdateRequired
customer group partial data
Returns​
PromisePromise<CustomerGroup>Required
resulting customer group

withTransaction​

Parameters​
transactionManagerEntityManager
Returns​
CustomerGroupServiceCustomerGroupServiceRequired
Was this section helpful?
© 2023 Medusa, Inc. All rights reserved.