Class: AdminReturnsResource
Hierarchy
defaultCopy to Clipboard↳
AdminReturnsResourceCopy to Clipboard
Methods
cancel
▸ cancel(idCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminReturnsCancelResCopy to Clipboard>
DescriptionCopy to Clipboard
cancels a return
Parameters
| Name | Type | Description |
|---|---|---|
idCopy to Clipboard | stringCopy to Clipboard | id of return to cancel |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminReturnsCancelResCopy to Clipboard>
the order for which the return was canceled
Defined in
medusa-js/src/resources/admin/returns.ts:19
list
▸ list(query?Copy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminReturnsListResCopy to Clipboard>
DescriptionCopy to Clipboard
lists returns matching a query
Parameters
| Name | Type | Description |
|---|---|---|
query?Copy to Clipboard | AdminGetReturnsParamsCopy to Clipboard | query for searching returns |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminReturnsListResCopy to Clipboard>
a list of returns matching the query
Defined in
medusa-js/src/resources/admin/returns.ts:49
receive
▸ receive(idCopy to Clipboard, payloadCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminReturnsResCopy to Clipboard>
DescriptionCopy to Clipboard
receive a return
Parameters
| Name | Type | Description |
|---|---|---|
idCopy to Clipboard | stringCopy to Clipboard | id of the return to receive. |
payloadCopy to Clipboard | AdminPostReturnsReturnReceiveReqCopy to Clipboard | items to receive and an optional refund amount |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminReturnsResCopy to Clipboard>
the return