Class: AdminCustomersResource
Hierarchy
defaultCopy to Clipboard↳
AdminCustomersResourceCopy to Clipboard
Methods
create
▸ create(payloadCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminCustomersResCopy to Clipboard>
Creates a customer
Parameters
| Name | Type | Description |
|---|---|---|
payloadCopy to Clipboard | AdminPostCustomersReqCopy to Clipboard | information of customer |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminCustomersResCopy to Clipboard>
Defined in
medusa-js/src/resources/admin/customers.ts:18
list
▸ list(query?Copy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminCustomersListResCopy to Clipboard>
Lists customers
Parameters
| Name | Type | Description |
|---|---|---|
query?Copy to Clipboard | AdminGetCustomersParamsCopy to Clipboard | optional |
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/customers.ts:59
retrieve
▸ retrieve(idCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminCustomersResCopy to Clipboard>
Retrieves a customer
Parameters
| Name | Type | Description |
|---|---|---|
idCopy to Clipboard | stringCopy to Clipboard | customer id |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminCustomersResCopy to Clipboard>
Defined in
medusa-js/src/resources/admin/customers.ts:46
update
▸ update(idCopy to Clipboard, payloadCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminCustomersResCopy to Clipboard>
Updates a customer
Parameters
| Name | Type | Description |
|---|---|---|
idCopy to Clipboard | stringCopy to Clipboard | customer id |
payloadCopy to Clipboard | AdminPostCustomersCustomerReqCopy to Clipboard | data to update customer with |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminCustomersResCopy to Clipboard>