AdminReturnsResource

admin/returns.AdminReturnsResource

Methods

cancel

cancel(id, customHeaders?): ResponsePromise<AdminReturnsCancelRes>

Parameters

idstringRequired

id of return to cancel

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminReturnsCancelRes>

ResponsePromiseResponsePromise<AdminReturnsCancelRes>Required

the order for which the return was canceled

Description

cancels a return

---

list

list(query?, customHeaders?): ResponsePromise<AdminReturnsListRes>

Parameters

queryAdminGetReturnsParams

query for searching returns

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminReturnsListRes>

ResponsePromiseResponsePromise<AdminReturnsListRes>Required

a list of returns matching the query

Description

lists returns matching a query

---

receive

receive(id, payload, customHeaders?): ResponsePromise<AdminReturnsRes>

Parameters

idstringRequired

id of the return to receive.

payloadAdminPostReturnsReturnReceiveReqRequired

items to receive and an optional refund amount

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminReturnsRes>

ResponsePromiseResponsePromise<AdminReturnsRes>Required

the return

Description

receive a return