Class: AdminReturnReasonsResource
Hierarchy
defaultCopy to Clipboard↳
AdminReturnReasonsResourceCopy to Clipboard
Methods
create
▸ create(payloadCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminReturnReasonsResCopy to Clipboard>
DescriptionCopy to Clipboard
Creates a return reason.
Parameters
| Name | Type |
|---|---|
payloadCopy to Clipboard | AdminPostReturnReasonsReqCopy to Clipboard |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminReturnReasonsResCopy to Clipboard>
Created return reason.
Defined in
medusa-js/src/resources/admin/return-reasons.ts:18
delete
▸ delete(idCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<DeleteResponseCopy to Clipboard>
DescriptionCopy to Clipboard
deletes a return reason
Parameters
| Name | Type | Description |
|---|---|---|
idCopy to Clipboard | stringCopy to Clipboard | id of return reason to delete. |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<DeleteResponseCopy to Clipboard>
Deleted response
Defined in
medusa-js/src/resources/admin/return-reasons.ts:48
list
▸ list(customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminReturnReasonsListResCopy to Clipboard>
DescriptionCopy to Clipboard
Lists return reasons matching a query
Parameters
| Name | Type |
|---|---|
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminReturnReasonsListResCopy to Clipboard>
a list of return reasons matching the query.
Defined in
medusa-js/src/resources/admin/return-reasons.ts:75
retrieve
▸ retrieve(idCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminReturnReasonsResCopy to Clipboard>
DescriptionCopy to Clipboard
retrieves a return reason
Parameters
| Name | Type | Description |
|---|---|---|
idCopy to Clipboard | stringCopy to Clipboard | id of the return reason to retrieve. |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminReturnReasonsResCopy to Clipboard>
the return reason with the given id
Defined in
medusa-js/src/resources/admin/return-reasons.ts:62
update
▸ update(idCopy to Clipboard, payloadCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminReturnReasonsResCopy to Clipboard>
DescriptionCopy to Clipboard
Updates a return reason
Parameters
| Name | Type | Description |
|---|---|---|
idCopy to Clipboard | stringCopy to Clipboard | id of the return reason to update. |
payloadCopy to Clipboard | AdminPostReturnReasonsReasonReqCopy to Clipboard | update to apply to return reason. |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminReturnReasonsResCopy to Clipboard>
the updated return reason.