Skip to main content

Class: AdminCustomersResource

Hierarchy

  • Copy to Clipboard

    Copy to Clipboard

Methods

create

create(Copy to Clipboard, Copy to Clipboard): Copy to Clipboard<Copy to Clipboard>

Creates a customer

Parameters

NameTypeDescription
Copy to ClipboardCopy to Clipboardinformation of customer
Copy to ClipboardCopy to Clipboard<Copy to Clipboard, Copy to Clipboard>

Returns

Copy to Clipboard<Copy to Clipboard>

Defined in

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


list

list(Copy to Clipboard, Copy to Clipboard): Copy to Clipboard<Copy to Clipboard>

Lists customers

Parameters

NameTypeDescription
Copy to ClipboardCopy to Clipboardoptional
Copy to ClipboardCopy to Clipboard<Copy to Clipboard, Copy to Clipboard>

Returns

Copy to Clipboard<Copy to Clipboard>

Defined in

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


retrieve

retrieve(Copy to Clipboard, Copy to Clipboard): Copy to Clipboard<Copy to Clipboard>

Retrieves a customer

Parameters

NameTypeDescription
Copy to ClipboardCopy to Clipboardcustomer id
Copy to ClipboardCopy to Clipboard<Copy to Clipboard, Copy to Clipboard>

Returns

Copy to Clipboard<Copy to Clipboard>

Defined in

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


update

update(Copy to Clipboard, Copy to Clipboard, Copy to Clipboard): Copy to Clipboard<Copy to Clipboard>

Updates a customer

Parameters

NameTypeDescription
Copy to ClipboardCopy to Clipboardcustomer id
Copy to ClipboardCopy to Clipboarddata to update customer with
Copy to ClipboardCopy to Clipboard<Copy to Clipboard, Copy to Clipboard>

Returns

Copy to Clipboard<Copy to Clipboard>

Defined in

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