Skip to main content
Skip to main content

ICustomerModuleService

Methods​

retrieve​

Parameters​

customerIdstringRequired
configFindConfig<CustomerDTO>
sharedContextContext

Returns​

PromisePromise<CustomerDTO>Required

create​

**create**(data, sharedContext?): Promise&#60;[CustomerDTO](/references/types/CustomerTypes/interfaces/types.CustomerTypes.CustomerDTO)[]&#62;

Parameters​

dataCreateCustomerDTO[]Required
sharedContextContext

Returns​

PromisePromise<CustomerDTO[]>Required

**create**(data, sharedContext?): Promise&#60;[CustomerDTO](/references/types/CustomerTypes/interfaces/types.CustomerTypes.CustomerDTO)&#62;

Parameters​

dataCreateCustomerDTORequired
sharedContextContext

Returns​

PromisePromise<CustomerDTO>Required

update​

**update**(customerId, data, sharedContext?): Promise&#60;[CustomerDTO](/references/types/CustomerTypes/interfaces/types.CustomerTypes.CustomerDTO)&#62;

Parameters​

customerIdstringRequired
dataCustomerUpdatableFieldsRequired
sharedContextContext

Returns​

PromisePromise<CustomerDTO>Required

**update**(customerIds, data, sharedContext?): Promise&#60;[CustomerDTO](/references/types/CustomerTypes/interfaces/types.CustomerTypes.CustomerDTO)[]&#62;

Parameters​

customerIdsstring[]Required
dataCustomerUpdatableFieldsRequired
sharedContextContext

Returns​

PromisePromise<CustomerDTO[]>Required

**update**(selector, data, sharedContext?): Promise&#60;[CustomerDTO](/references/types/CustomerTypes/interfaces/types.CustomerTypes.CustomerDTO)[]&#62;

Parameters​

selectorFilterableCustomerPropsRequired
dataCustomerUpdatableFieldsRequired
sharedContextContext

Returns​

PromisePromise<CustomerDTO[]>Required

delete​

**delete**(customerId, sharedContext?): Promise&#60;void&#62;

Parameters​

customerIdstringRequired
sharedContextContext

Returns​

PromisePromise<void>Required

**delete**(customerIds, sharedContext?): Promise&#60;void&#62;

Parameters​

customerIdsstring[]Required
sharedContextContext

Returns​

PromisePromise<void>Required

**delete**(selector, sharedContext?): Promise&#60;void&#62;

Parameters​

selectorFilterableCustomerPropsRequired
sharedContextContext

Returns​

PromisePromise<void>Required

createCustomerGroup​

**createCustomerGroup**(data, sharedContext?): Promise&#60;[CustomerGroupDTO](/references/types/CustomerTypes/interfaces/types.CustomerTypes.CustomerGroupDTO)[]&#62;

Parameters​

dataCreateCustomerGroupDTO[]Required
sharedContextContext

Returns​

PromisePromise<CustomerGroupDTO[]>Required

**createCustomerGroup**(data, sharedContext?): Promise&#60;[CustomerGroupDTO](/references/types/CustomerTypes/interfaces/types.CustomerTypes.CustomerGroupDTO)&#62;

Parameters​

dataCreateCustomerGroupDTORequired
sharedContextContext

Returns​

PromisePromise<CustomerGroupDTO>Required

retrieveCustomerGroup​

Parameters​

groupIdstringRequired
configFindConfig<CustomerGroupDTO>
sharedContextContext

Returns​

PromisePromise<CustomerGroupDTO>Required

updateCustomerGroups​

**updateCustomerGroups**(groupId, data, sharedContext?): Promise&#60;[CustomerGroupDTO](/references/types/CustomerTypes/interfaces/types.CustomerTypes.CustomerGroupDTO)&#62;

Parameters​

groupIdstringRequired
dataCustomerGroupUpdatableFieldsRequired
sharedContextContext

Returns​

PromisePromise<CustomerGroupDTO>Required

**updateCustomerGroups**(groupIds, data, sharedContext?): Promise&#60;[CustomerGroupDTO](/references/types/CustomerTypes/interfaces/types.CustomerTypes.CustomerGroupDTO)[]&#62;

Parameters​

groupIdsstring[]Required
dataCustomerGroupUpdatableFieldsRequired
sharedContextContext

Returns​

PromisePromise<CustomerGroupDTO[]>Required

**updateCustomerGroups**(selector, data, sharedContext?): Promise&#60;[CustomerGroupDTO](/references/types/CustomerTypes/interfaces/types.CustomerTypes.CustomerGroupDTO)[]&#62;

Parameters​

Returns​

PromisePromise<CustomerGroupDTO[]>Required

deleteCustomerGroups​

**deleteCustomerGroups**(groupId, sharedContext?): Promise&#60;void&#62;

Parameters​

groupIdstringRequired
sharedContextContext

Returns​

PromisePromise<void>Required

**deleteCustomerGroups**(groupIds, sharedContext?): Promise&#60;void&#62;

Parameters​

groupIdsstring[]Required
sharedContextContext

Returns​

PromisePromise<void>Required

**deleteCustomerGroups**(selector, sharedContext?): Promise&#60;void&#62;

Parameters​

selectorFilterableCustomerGroupPropsRequired
sharedContextContext

Returns​

PromisePromise<void>Required

addCustomerToGroup​

**addCustomerToGroup**(groupCustomerPair, sharedContext?): Promise&#60;&#123; id: string &#125;&#62;

Parameters​

groupCustomerPairGroupCustomerPairRequired
sharedContextContext

Returns​

PromisePromise<object>Required

**addCustomerToGroup**(groupCustomerPairs, sharedContext?): Promise&#60;&#123; id: string &#125;[]&#62;

Parameters​

groupCustomerPairsGroupCustomerPair[]Required
sharedContextContext

Returns​

PromisePromise<object[]>Required

removeCustomerFromGroup​

**removeCustomerFromGroup**(groupCustomerPair, sharedContext?): Promise&#60;void&#62;

Parameters​

groupCustomerPairGroupCustomerPairRequired
sharedContextContext

Returns​

PromisePromise<void>Required

**removeCustomerFromGroup**(groupCustomerPairs, sharedContext?): Promise&#60;void&#62;

Parameters​

groupCustomerPairsGroupCustomerPair[]Required
sharedContextContext

Returns​

PromisePromise<void>Required

addAddresses​

**addAddresses**(addresses, sharedContext?): Promise&#60;[CustomerAddressDTO](/references/types/CustomerTypes/interfaces/types.CustomerTypes.CustomerAddressDTO)[]&#62;

Parameters​

addressesCreateCustomerAddressDTO[]Required
sharedContextContext

Returns​

PromisePromise<CustomerAddressDTO[]>Required

**addAddresses**(address, sharedContext?): Promise&#60;[CustomerAddressDTO](/references/types/CustomerTypes/interfaces/types.CustomerTypes.CustomerAddressDTO)&#62;

Parameters​

addressCreateCustomerAddressDTORequired
sharedContextContext

Returns​

PromisePromise<CustomerAddressDTO>Required

updateAddresses​

**updateAddresses**(addressId, data, sharedContext?): Promise&#60;[CustomerAddressDTO](/references/types/CustomerTypes/interfaces/types.CustomerTypes.CustomerAddressDTO)&#62;

Parameters​

addressIdstringRequired
dataUpdateCustomerAddressDTORequired
sharedContextContext

Returns​

PromisePromise<CustomerAddressDTO>Required

**updateAddresses**(addressIds, data, sharedContext?): Promise&#60;[CustomerAddressDTO](/references/types/CustomerTypes/interfaces/types.CustomerTypes.CustomerAddressDTO)[]&#62;

Parameters​

addressIdsstring[]Required
dataUpdateCustomerAddressDTORequired
sharedContextContext

Returns​

PromisePromise<CustomerAddressDTO[]>Required

**updateAddresses**(selector, data, sharedContext?): Promise&#60;[CustomerAddressDTO](/references/types/CustomerTypes/interfaces/types.CustomerTypes.CustomerAddressDTO)[]&#62;

Parameters​

selectorFilterableCustomerAddressPropsRequired
dataUpdateCustomerAddressDTORequired
sharedContextContext

Returns​

PromisePromise<CustomerAddressDTO[]>Required

deleteAddresses​

**deleteAddresses**(addressId, sharedContext?): Promise&#60;void&#62;

Parameters​

addressIdstringRequired
sharedContextContext

Returns​

PromisePromise<void>Required

**deleteAddresses**(addressIds, sharedContext?): Promise&#60;void&#62;

Parameters​

addressIdsstring[]Required
sharedContextContext

Returns​

PromisePromise<void>Required

**deleteAddresses**(selector, sharedContext?): Promise&#60;void&#62;

Parameters​

selectorFilterableCustomerAddressPropsRequired
sharedContextContext

Returns​

PromisePromise<void>Required

listAddresses​

Parameters​

Returns​

PromisePromise<CustomerAddressDTO[]>Required

listAndCountAddresses​

Parameters​

Returns​

PromisePromise<[CustomerAddressDTO[], number]>Required

listCustomerGroupCustomers​

Parameters​

Returns​

PromisePromise<CustomerGroupCustomerDTO[]>Required

list​

Parameters​

Returns​

PromisePromise<CustomerDTO[]>Required

listAndCount​

Parameters​

Returns​

PromisePromise<[CustomerDTO[], number]>Required

listCustomerGroups​

Parameters​

Returns​

PromisePromise<CustomerGroupDTO[]>Required

listAndCountCustomerGroups​

Parameters​

Returns​

PromisePromise<[CustomerGroupDTO[], number]>Required

softDelete​

Type Parameters​

TReturnableLinkableKeysstringRequired

Parameters​

customerIdsstring[]Required
configSoftDeleteReturn<TReturnableLinkableKeys>
sharedContextContext

Returns​

PromisePromise<void | Record<TReturnableLinkableKeys, string[]>>Required

restore​

Type Parameters​

TReturnableLinkableKeysstringRequired

Parameters​

customerIdsstring[]Required
configRestoreReturn<TReturnableLinkableKeys>
sharedContextContext

Returns​

PromisePromise<void | Record<TReturnableLinkableKeys, string[]>>Required

softDeleteCustomerGroups​

Type Parameters​

TReturnableLinkableKeysstringRequired

Parameters​

groupIdsstring[]Required
configSoftDeleteReturn<TReturnableLinkableKeys>
sharedContextContext

Returns​

PromisePromise<void | Record<TReturnableLinkableKeys, string[]>>Required

restoreCustomerGroups​

Type Parameters​

TReturnableLinkableKeysstringRequired

Parameters​

groupIdsstring[]Required
configRestoreReturn<TReturnableLinkableKeys>
sharedContextContext

Returns​

PromisePromise<void | Record<TReturnableLinkableKeys, string[]>>Required
Was this section helpful?
© 2024 Medusa, Inc. All rights reserved.