Skip to main content

Class: AdminReturnsResource

Hierarchy

  • Copy to Clipboard

    Copy to Clipboard

Methods

cancel

cancel(

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

Copy to Clipboard

cancels a return

Parameters

NameTypeDescription
Copy to Clipboard
Copy to Clipboard
id of return to cancel
Copy to Clipboard
Copy to Clipboard
<
Copy to Clipboard
,
Copy to Clipboard
>

Returns

<
Copy to Clipboard
>

the order for which the return was canceled

Defined in

medusa-js/src/resources/admin/returns.ts:19


list

list(

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

Copy to Clipboard

lists returns matching a query

Parameters

NameTypeDescription
Copy to Clipboard
Copy to Clipboard
query for searching returns
Copy to Clipboard
Copy to Clipboard
<
Copy to Clipboard
,
Copy to Clipboard
>

Returns

<
Copy to Clipboard
>

a list of returns matching the query

Defined in

medusa-js/src/resources/admin/returns.ts:49


receive

receive(

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

Copy to Clipboard

receive a return

Parameters

NameTypeDescription
Copy to Clipboard
Copy to Clipboard
id of the return to receive.
Copy to Clipboard
Copy to Clipboard
items to receive and an optional refund amount
Copy to Clipboard
Copy to Clipboard
<
Copy to Clipboard
,
Copy to Clipboard
>

Returns

<
Copy to Clipboard
>

the return

Defined in

medusa-js/src/resources/admin/returns.ts:34