AdminReturnReasonsResource

admin/return-reasons.AdminReturnReasonsResource

Methods

create

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

Parameters

payloadAdminPostReturnReasonsReqRequired

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminReturnReasonsRes>

ResponsePromiseResponsePromise<AdminReturnReasonsRes>Required

Created return reason.

Description

Creates a return reason.

---

delete

delete(id, customHeaders?): ResponsePromise<DeleteResponse>

Parameters

idstringRequired

id of return reason to delete.

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<DeleteResponse>

ResponsePromiseResponsePromise<DeleteResponse>Required

Deleted response

Description

deletes a return reason

---

list

list(customHeaders?): ResponsePromise<AdminReturnReasonsListRes>

Parameters

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminReturnReasonsListRes>

ResponsePromiseResponsePromise<AdminReturnReasonsListRes>Required

a list of return reasons matching the query.

Description

Lists return reasons matching a query

---

retrieve

retrieve(id, customHeaders?): ResponsePromise<AdminReturnReasonsRes>

Parameters

idstringRequired

id of the return reason to retrieve.

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminReturnReasonsRes>

ResponsePromiseResponsePromise<AdminReturnReasonsRes>Required

the return reason with the given id

Description

retrieves a return reason

---

update

update(id, payload, customHeaders?): ResponsePromise<AdminReturnReasonsRes>

Parameters

idstringRequired

id of the return reason to update.

payloadAdminPostReturnReasonsReasonReqRequired

update to apply to return reason.

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminReturnReasonsRes>

ResponsePromiseResponsePromise<AdminReturnReasonsRes>Required

the updated return reason.

Description

Updates a return reason