Skip to main content

Class: AdminCustomerGroupsResource

Hierarchy

  • Copy to Clipboard

    Copy to Clipboard

Methods

addCustomers

addCustomers(

Copy to Clipboard
,
Copy to Clipboard
,
Copy to Clipboard
):
Copy to Clipboard
<
Copy to Clipboard
>

Add multiple customers to a customer group.

Parameters

NameTypeDescription
Copy to Clipboard
Copy to Clipboard
customer group id
Copy to Clipboard
Copy to Clipboard
an object which contains an array of customer ids which will be added to the group
Copy to Clipboard
Copy to Clipboard
<
Copy to Clipboard
,
Copy to Clipboard
>

Returns

<
Copy to Clipboard
>

Defined in

medusa-js/src/resources/admin/customer-groups.ts:112


create

create(

Copy to Clipboard
,
Copy to Clipboard
):
Copy to Clipboard
<
Copy to Clipboard
>

Create a customer group.

Parameters

NameTypeDescription
Copy to Clipboard
Copy to Clipboard
customer group info
Copy to Clipboard
Copy to Clipboard
<
Copy to Clipboard
,
Copy to Clipboard
>

Returns

<
Copy to Clipboard
>

Defined in

medusa-js/src/resources/admin/customer-groups.ts:26


delete

delete(

Copy to Clipboard
,
Copy to Clipboard
):
Copy to Clipboard
<
Copy to Clipboard
>

Deletes a customer group.

Parameters

NameTypeDescription
Copy to Clipboard
Copy to Clipboard
id of the customer group
Copy to Clipboard
Copy to Clipboard
<
Copy to Clipboard
,
Copy to Clipboard
>

Returns

<
Copy to Clipboard
>

Defined in

medusa-js/src/resources/admin/customer-groups.ts:77


list

list(

Copy to Clipboard
,
Copy to Clipboard
):
Copy to Clipboard
<
Copy to Clipboard
>

Lists customer groups.

Parameters

NameTypeDescription
Copy to Clipboard
Copy to Clipboard
optional
Copy to Clipboard
Copy to Clipboard
<
Copy to Clipboard
,
Copy to Clipboard
>

Returns

<
Copy to Clipboard
>

Defined in

medusa-js/src/resources/admin/customer-groups.ts:91


listCustomers

listCustomers(

Copy to Clipboard
,
Copy to Clipboard
,
Copy to Clipboard
):
Copy to Clipboard
<
Copy to Clipboard
>

List and count customers that belong to provided customer groups.

Parameters

NameTypeDescription
Copy to Clipboard
Copy to Clipboard
customer group id
Copy to Clipboard
Copy to Clipboard
params for filtering customers
Copy to Clipboard
Copy to Clipboard
<
Copy to Clipboard
,
Copy to Clipboard
>

Returns

<
Copy to Clipboard
>

Defined in

medusa-js/src/resources/admin/customer-groups.ts:144


removeCustomers

removeCustomers(

Copy to Clipboard
,
Copy to Clipboard
,
Copy to Clipboard
):
Copy to Clipboard
<
Copy to Clipboard
>

Remove multiple customers from a customer group.

Parameters

NameTypeDescription
Copy to Clipboard
Copy to Clipboard
customer group id
Copy to Clipboard
Copy to Clipboard
an object which contains an array of customers ids which will be removed from the group
Copy to Clipboard
Copy to Clipboard
<
Copy to Clipboard
,
Copy to Clipboard
>

Returns

<
Copy to Clipboard
>

Defined in

medusa-js/src/resources/admin/customer-groups.ts:128


retrieve

retrieve(

Copy to Clipboard
,
Copy to Clipboard
,
Copy to Clipboard
):
Copy to Clipboard
<
Copy to Clipboard
>

Retrieves a customer group.

Parameters

NameTypeDescription
Copy to Clipboard
Copy to Clipboard
customer group id
Copy to Clipboard
Copy to Clipboard
pass query options such as "expand", "fields" etc.
Copy to Clipboard
Copy to Clipboard
<
Copy to Clipboard
,
Copy to Clipboard
>

Returns

<
Copy to Clipboard
>

Defined in

medusa-js/src/resources/admin/customer-groups.ts:41


update

update(

Copy to Clipboard
,
Copy to Clipboard
,
Copy to Clipboard
):
Copy to Clipboard
<
Copy to Clipboard
>

Updates a customer group

Parameters

NameTypeDescription
Copy to Clipboard
Copy to Clipboard
customer group id
Copy to Clipboard
Copy to Clipboard
data to update customer group with
Copy to Clipboard
Copy to Clipboard
<
Copy to Clipboard
,
Copy to Clipboard
>

Returns

<
Copy to Clipboard
>

Defined in

medusa-js/src/resources/admin/customer-groups.ts:62