Skip to main content

Class: AdminReturnReasonsResource

Hierarchy

  • default

    AdminReturnReasonsResource

Methods

create

create(payload, customHeaders?): ResponsePromise<AdminReturnReasonsRes>

Description

Creates a return reason.

Parameters

NameType
payloadAdminPostReturnReasonsReq
customHeadersRecord<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

NameTypeDescription
idstringid of return reason to delete.
customHeadersRecord<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

NameType
customHeadersRecord<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

NameTypeDescription
idstringid of the return reason to retrieve.
customHeadersRecord<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

NameTypeDescription
idstringid of the return reason to update.
payloadAdminPostReturnReasonsReasonRequpdate to apply to return reason.
customHeadersRecord<string, any>

Returns

ResponsePromise<AdminReturnReasonsRes>

the updated return reason.

Defined in

medusa-js/src/resources/admin/return-reasons.ts:33

Was this page helpful?