Class: AdminCustomersResource

Hierarchy

• default

  ↳ AdminCustomersResource

Methods

create

▸ create(payload, customHeaders?): ResponsePromise<AdminCustomersRes>

Creates a customer

Parameters

Name	Type	Description
payload	AdminPostCustomersReq	information of customer
customHeaders	Record<string, any>

Returns

ResponsePromise<AdminCustomersRes>

Defined in

medusa-js/src/resources/admin/customers.ts:18

---

list

▸ list(query?, customHeaders?): ResponsePromise<AdminCustomersListRes>

Lists customers

Parameters

Name	Type	Description
query?	AdminGetCustomersParams	optional
customHeaders	Record<string, any>

Returns

ResponsePromise<AdminCustomersListRes>

Defined in

medusa-js/src/resources/admin/customers.ts:59

---

retrieve

▸ retrieve(id, customHeaders?): ResponsePromise<AdminCustomersRes>

Retrieves a customer

Parameters

Name	Type	Description
id	string	customer id
customHeaders	Record<string, any>

Returns

ResponsePromise<AdminCustomersRes>

Defined in

medusa-js/src/resources/admin/customers.ts:46

---

update

▸ update(id, payload, customHeaders?): ResponsePromise<AdminCustomersRes>

Updates a customer

Parameters

Name	Type	Description
id	string	customer id
payload	AdminPostCustomersCustomerReq	data to update customer with
customHeaders	Record<string, any>

Returns

ResponsePromise<AdminCustomersRes>

Defined in

medusa-js/src/resources/admin/customers.ts:32