Class: CustomerResource
Hierarchy
defaultCopy to Clipboard↳
CustomerResourceCopy to Clipboard
Properties
addresses
• addresses: AddressesResourceCopy to Clipboard
Defined in
medusa-js/src/resources/customers.ts:18
paymentMethods
• paymentMethods: PaymentMethodsResourceCopy to Clipboard
Defined in
medusa-js/src/resources/customers.ts:17
Methods
create
▸ create(payloadCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<StoreCustomersResCopy to Clipboard>
Creates a customer
Parameters
| Name | Type | Description |
|---|---|---|
payloadCopy to Clipboard | StorePostCustomersReqCopy to Clipboard | information of customer |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<StoreCustomersResCopy to Clipboard>
Defined in
medusa-js/src/resources/customers.ts:26
generatePasswordToken
▸ generatePasswordToken(payloadCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<anyCopy to Clipboard>
Generates a reset password token, which can be used to reset the password. The token is not returned but should be sent out to the customer in an email.
Parameters
| Name | Type | Description |
|---|---|---|
payloadCopy to Clipboard | StorePostCustomersCustomerPasswordTokenReqCopy to Clipboard | info used to generate token |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<anyCopy to Clipboard>
Defined in
medusa-js/src/resources/customers.ts:101
listOrders
▸ listOrders(params?Copy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<StoreCustomersListOrdersResCopy to Clipboard>
Retrieve customer orders
Parameters
| Name | Type | Description |
|---|---|---|
params?Copy to Clipboard | StoreGetCustomersCustomerOrdersParamsCopy to Clipboard | optional params to retrieve orders |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<StoreCustomersListOrdersResCopy to Clipboard>
Defined in
medusa-js/src/resources/customers.ts:66
resetPassword
▸ resetPassword(payloadCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<StoreCustomersResCopy to Clipboard>
Resets customer password
Parameters
| Name | Type | Description |
|---|---|---|
payloadCopy to Clipboard | StorePostCustomersResetPasswordReqCopy to Clipboard | info used to reset customer password |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<StoreCustomersResCopy to Clipboard>
Defined in
medusa-js/src/resources/customers.ts:86
retrieve
▸ retrieve(customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<StoreCustomersResCopy to Clipboard>
Retrieves the customer that is currently logged
Parameters
| Name | Type |
|---|---|
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<StoreCustomersResCopy to Clipboard>
Defined in
medusa-js/src/resources/customers.ts:39
update
▸ update(payloadCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<StoreCustomersResCopy to Clipboard>
Updates a customer
Parameters
| Name | Type | Description |
|---|---|---|
payloadCopy to Clipboard | StorePostCustomersCustomerReqCopy to Clipboard | information to update customer with |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<StoreCustomersResCopy to Clipboard>