Skip to main content

Class: AdminCustomersResource

Hierarchy

  • default

    AdminCustomersResource

Methods

create

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

Creates a customer

Parameters

NameTypeDescription
payloadAdminPostCustomersReqinformation of customer
customHeadersRecord<string, any>

Returns

ResponsePromise<AdminCustomersRes>

Defined in

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


list

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

Lists customers

Parameters

NameTypeDescription
query?AdminGetCustomersParamsoptional
customHeadersRecord<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

NameTypeDescription
idstringcustomer id
customHeadersRecord<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

NameTypeDescription
idstringcustomer id
payloadAdminPostCustomersCustomerReqdata to update customer with
customHeadersRecord<string, any>

Returns

ResponsePromise<AdminCustomersRes>

Defined in

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

Was this page helpful?