Class: AdminCustomerGroupsResource
Hierarchy
defaultCopy to Clipboard↳
AdminCustomerGroupsResourceCopy to Clipboard
Methods
addCustomers
▸ addCustomers(idCopy to Clipboard, payloadCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminCustomerGroupsResCopy to Clipboard>
Add multiple customers to a customer group.
Parameters
| Name | Type | Description |
|---|---|---|
idCopy to Clipboard | stringCopy to Clipboard | customer group id |
payloadCopy to Clipboard | AdminPostCustomerGroupsGroupCustomersBatchReqCopy to Clipboard | an object which contains an array of customer ids which will be added to the group |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminCustomerGroupsResCopy to Clipboard>
Defined in
medusa-js/src/resources/admin/customer-groups.ts:112
create
▸ create(payloadCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminCustomerGroupsResCopy to Clipboard>
Create a customer group.
Parameters
| Name | Type | Description |
|---|---|---|
payloadCopy to Clipboard | AdminPostCustomerGroupsReqCopy to Clipboard | customer group info |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminCustomerGroupsResCopy to Clipboard>
Defined in
medusa-js/src/resources/admin/customer-groups.ts:26
delete
▸ delete(idCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<DeleteResponseCopy to Clipboard>
Deletes a customer group.
Parameters
| Name | Type | Description |
|---|---|---|
idCopy to Clipboard | stringCopy to Clipboard | id of the customer group |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<DeleteResponseCopy to Clipboard>
Defined in
medusa-js/src/resources/admin/customer-groups.ts:77
list
▸ list(query?Copy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminCustomerGroupsListResCopy to Clipboard>
Lists customer groups.
Parameters
| Name | Type | Description |
|---|---|---|
query?Copy to Clipboard | AdminGetCustomerGroupsParamsCopy to Clipboard | optional |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminCustomerGroupsListResCopy to Clipboard>
Defined in
medusa-js/src/resources/admin/customer-groups.ts:91
listCustomers
▸ listCustomers(idCopy to Clipboard, query?Copy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminCustomersListResCopy to Clipboard>
List and count customers that belong to provided customer groups.
Parameters
| Name | Type | Description |
|---|---|---|
idCopy to Clipboard | stringCopy to Clipboard | customer group id |
query?Copy to Clipboard | AdminGetCustomersParamsCopy to Clipboard | params for filtering customers |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminCustomersListResCopy to Clipboard>
Defined in
medusa-js/src/resources/admin/customer-groups.ts:144
removeCustomers
▸ removeCustomers(idCopy to Clipboard, payloadCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminCustomerGroupsResCopy to Clipboard>
Remove multiple customers from a customer group.
Parameters
| Name | Type | Description |
|---|---|---|
idCopy to Clipboard | stringCopy to Clipboard | customer group id |
payloadCopy to Clipboard | AdminDeleteCustomerGroupsGroupCustomerBatchReqCopy to Clipboard | an object which contains an array of customers ids which will be removed from the group |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminCustomerGroupsResCopy to Clipboard>
Defined in
medusa-js/src/resources/admin/customer-groups.ts:128
retrieve
▸ retrieve(idCopy to Clipboard, query?Copy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminCustomerGroupsResCopy to Clipboard>
Retrieves a customer group.
Parameters
| Name | Type | Description |
|---|---|---|
idCopy to Clipboard | stringCopy to Clipboard | customer group id |
query?Copy to Clipboard | AdminGetCustomerGroupsGroupParamsCopy to Clipboard | pass query options such as "expand", "fields" etc. |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminCustomerGroupsResCopy to Clipboard>
Defined in
medusa-js/src/resources/admin/customer-groups.ts:41
update
▸ update(idCopy to Clipboard, payloadCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminCustomerGroupsResCopy to Clipboard>
Updates a customer group
Parameters
| Name | Type | Description |
|---|---|---|
idCopy to Clipboard | stringCopy to Clipboard | customer group id |
payloadCopy to Clipboard | AdminPostCustomerGroupsGroupReqCopy to Clipboard | data to update customer group with |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminCustomerGroupsResCopy to Clipboard>