Class: AdminReturnReasonsResource
Hierarchy
default↳
AdminReturnReasonsResource
Methods
create
▸ create(payload, customHeaders?): ResponsePromise<AdminReturnReasonsRes>
Description
Creates a return reason.
Parameters
| Name | Type |
|---|---|
payload | AdminPostReturnReasonsReq |
customHeaders | Record<string, any> |
Returns
ResponsePromise<AdminReturnReasonsRes>
Created return reason.
Defined in
medusa-js/src/resources/admin/return-reasons.ts:18
delete
▸ delete(id, customHeaders?): ResponsePromise<DeleteResponse>
Description
deletes a return reason
Parameters
| Name | Type | Description |
|---|---|---|
id | string | id of return reason to delete. |
customHeaders | Record<string, any> |
Returns
ResponsePromise<DeleteResponse>
Deleted response
Defined in
medusa-js/src/resources/admin/return-reasons.ts:48
list
▸ list(customHeaders?): ResponsePromise<AdminReturnReasonsListRes>
Description
Lists return reasons matching a query
Parameters
| Name | Type |
|---|---|
customHeaders | Record<string, any> |
Returns
ResponsePromise<AdminReturnReasonsListRes>
a list of return reasons matching the query.
Defined in
medusa-js/src/resources/admin/return-reasons.ts:75
retrieve
▸ retrieve(id, customHeaders?): ResponsePromise<AdminReturnReasonsRes>
Description
retrieves a return reason
Parameters
| Name | Type | Description |
|---|---|---|
id | string | id of the return reason to retrieve. |
customHeaders | Record<string, any> |
Returns
ResponsePromise<AdminReturnReasonsRes>
the return reason with the given id
Defined in
medusa-js/src/resources/admin/return-reasons.ts:62
update
▸ update(id, payload, customHeaders?): ResponsePromise<AdminReturnReasonsRes>
Description
Updates a return reason
Parameters
| Name | Type | Description |
|---|---|---|
id | string | id of the return reason to update. |
payload | AdminPostReturnReasonsReasonReq | update to apply to return reason. |
customHeaders | Record<string, any> |
Returns
ResponsePromise<AdminReturnReasonsRes>
the updated return reason.