CustomerResource

customers.CustomerResource

Properties

addressesAddressesResourceRequired

paymentMethodsPaymentMethodsResourceRequired

Methods

create

create(payload, customHeaders?): ResponsePromise<StoreCustomersRes>

Creates a customer

Parameters

payloadStorePostCustomersReqRequired

information of customer

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<StoreCustomersRes>

ResponsePromiseResponsePromise<StoreCustomersRes>Required

---

generatePasswordToken

generatePasswordToken(payload, customHeaders?): ResponsePromise

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

payloadStorePostCustomersCustomerPasswordTokenReqRequired

info used to generate token

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise

ResponsePromiseResponsePromiseRequired

---

listOrders

listOrders(params?, customHeaders?): ResponsePromise<StoreCustomersListOrdersRes>

Retrieve customer orders

Parameters

paramsStoreGetCustomersCustomerOrdersParams

optional params to retrieve orders

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<StoreCustomersListOrdersRes>

ResponsePromiseResponsePromise<StoreCustomersListOrdersRes>Required

---

resetPassword

resetPassword(payload, customHeaders?): ResponsePromise<StoreCustomersRes>

Resets customer password

Parameters

payloadStorePostCustomersResetPasswordReqRequired

info used to reset customer password

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<StoreCustomersRes>

ResponsePromiseResponsePromise<StoreCustomersRes>Required

---

retrieve

retrieve(customHeaders?): ResponsePromise<StoreCustomersRes>

Retrieves the customer that is currently logged

Parameters

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<StoreCustomersRes>

ResponsePromiseResponsePromise<StoreCustomersRes>Required

---

update

update(payload, customHeaders?): ResponsePromise<StoreCustomersRes>

Updates a customer

Parameters

payloadStorePostCustomersCustomerReqRequired

information to update customer with

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<StoreCustomersRes>

ResponsePromiseResponsePromise<StoreCustomersRes>Required