Skip to main content

Class: AdminReturnReasonsResource

Hierarchy

  • Copy to Clipboard

    Copy to Clipboard

Methods

create

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

Copy to Clipboard

Creates a return reason.

Parameters

NameType
Copy to ClipboardCopy to Clipboard
Copy to ClipboardCopy to Clipboard<Copy to Clipboard, Copy to Clipboard>

Returns

Copy to Clipboard<Copy to Clipboard>

Created return reason.

Defined in

medusa-js/src/resources/admin/return-reasons.ts:18


delete

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

Copy to Clipboard

deletes a return reason

Parameters

NameTypeDescription
Copy to ClipboardCopy to Clipboardid of return reason to delete.
Copy to ClipboardCopy to Clipboard<Copy to Clipboard, Copy to Clipboard>

Returns

Copy to Clipboard<Copy to Clipboard>

Deleted response

Defined in

medusa-js/src/resources/admin/return-reasons.ts:48


list

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

Copy to Clipboard

Lists return reasons matching a query

Parameters

NameType
Copy to ClipboardCopy to Clipboard<Copy to Clipboard, Copy to Clipboard>

Returns

Copy to Clipboard<Copy to Clipboard>

a list of return reasons matching the query.

Defined in

medusa-js/src/resources/admin/return-reasons.ts:75


retrieve

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

Copy to Clipboard

retrieves a return reason

Parameters

NameTypeDescription
Copy to ClipboardCopy to Clipboardid of the return reason to retrieve.
Copy to ClipboardCopy to Clipboard<Copy to Clipboard, Copy to Clipboard>

Returns

Copy to Clipboard<Copy to Clipboard>

the return reason with the given id

Defined in

medusa-js/src/resources/admin/return-reasons.ts:62


update

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

Copy to Clipboard

Updates a return reason

Parameters

NameTypeDescription
Copy to ClipboardCopy to Clipboardid of the return reason to update.
Copy to ClipboardCopy to Clipboardupdate to apply to return reason.
Copy to ClipboardCopy to Clipboard<Copy to Clipboard, Copy to Clipboard>

Returns

Copy to Clipboard<Copy to Clipboard>

the updated return reason.

Defined in

medusa-js/src/resources/admin/return-reasons.ts:33