Class: AdminReturnsResource

Hierarchy

• default

  ↳ AdminReturnsResource

Methods

cancel

▸ cancel(id, customHeaders?): ResponsePromise<AdminReturnsCancelRes>

Description

cancels a return

Parameters

Name	Type	Description
id	string	id of return to cancel
customHeaders	Record<string, any>

Returns

ResponsePromise<AdminReturnsCancelRes>

the order for which the return was canceled

Defined in

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

---

list

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

Description

lists returns matching a query

Parameters

Name	Type	Description
query?	AdminGetReturnsParams	query for searching returns
customHeaders	Record<string, any>

Returns

ResponsePromise<AdminReturnsListRes>

a list of returns matching the query

Defined in

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

---

receive

▸ receive(id, payload, customHeaders?): ResponsePromise<AdminReturnsRes>

Description

receive a return

Parameters

Name	Type	Description
id	string	id of the return to receive.
payload	AdminPostReturnsReturnReceiveReq	items to receive and an optional refund amount
customHeaders	Record<string, any>

Returns

ResponsePromise<AdminReturnsRes>

the return

Defined in

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