AdminOrdersResource

admin/orders.AdminOrdersResource

Methods

addShippingMethod

addShippingMethod(id, payload, customHeaders?): ResponsePromise<AdminOrdersRes>

Parameters

idstringRequired

payloadAdminPostOrdersOrderShippingMethodsReqRequired

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminOrdersRes>

ResponsePromiseResponsePromise<AdminOrdersRes>Required

---

archive

archive(id, customHeaders?): ResponsePromise<AdminOrdersRes>

Parameters

idstringRequired

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminOrdersRes>

ResponsePromiseResponsePromise<AdminOrdersRes>Required

---

cancel

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

Parameters

idstringRequired

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminOrdersRes>

ResponsePromiseResponsePromise<AdminOrdersRes>Required

---

cancelClaim

cancelClaim(id, claimId, customHeaders?): ResponsePromise<AdminOrdersRes>

Parameters

idstringRequired

claimIdstringRequired

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminOrdersRes>

ResponsePromiseResponsePromise<AdminOrdersRes>Required

---

cancelClaimFulfillment

cancelClaimFulfillment(id, claimId, fulfillmentId, customHeaders?): ResponsePromise<AdminOrdersRes>

Parameters

idstringRequired

claimIdstringRequired

fulfillmentIdstringRequired

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminOrdersRes>

ResponsePromiseResponsePromise<AdminOrdersRes>Required

---

cancelFulfillment

cancelFulfillment(id, fulfillmentId, customHeaders?): ResponsePromise<AdminOrdersRes>

Parameters

idstringRequired

fulfillmentIdstringRequired

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminOrdersRes>

ResponsePromiseResponsePromise<AdminOrdersRes>Required

---

cancelSwap

cancelSwap(id, swapId, customHeaders?): ResponsePromise<AdminOrdersRes>

Parameters

idstringRequired

swapIdstringRequired

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminOrdersRes>

ResponsePromiseResponsePromise<AdminOrdersRes>Required

---

cancelSwapFulfillment

cancelSwapFulfillment(id, swapId, fulfillmentId, customHeaders?): ResponsePromise<AdminOrdersRes>

Parameters

idstringRequired

swapIdstringRequired

fulfillmentIdstringRequired

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminOrdersRes>

ResponsePromiseResponsePromise<AdminOrdersRes>Required

---

capturePayment

capturePayment(id, customHeaders?): ResponsePromise<AdminOrdersRes>

Parameters

idstringRequired

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminOrdersRes>

ResponsePromiseResponsePromise<AdminOrdersRes>Required

---

complete

complete(id, customHeaders?): ResponsePromise<AdminOrdersRes>

Parameters

idstringRequired

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminOrdersRes>

ResponsePromiseResponsePromise<AdminOrdersRes>Required

---

createClaim

createClaim(id, payload, customHeaders?): ResponsePromise<AdminOrdersRes>

Parameters

idstringRequired

payloadAdminPostOrdersOrderClaimsReqRequired

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminOrdersRes>

ResponsePromiseResponsePromise<AdminOrdersRes>Required

---

createClaimShipment

createClaimShipment(id, claimId, payload, customHeaders?): ResponsePromise<AdminOrdersRes>

Parameters

idstringRequired

claimIdstringRequired

payloadAdminPostOrdersOrderClaimsClaimShipmentsReqRequired

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminOrdersRes>

ResponsePromiseResponsePromise<AdminOrdersRes>Required

---

createFulfillment

createFulfillment(id, payload, customHeaders?): ResponsePromise<AdminOrdersRes>

Parameters

idstringRequired

payloadAdminPostOrdersOrderFulfillmentsReqRequired

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminOrdersRes>

ResponsePromiseResponsePromise<AdminOrdersRes>Required

---

createShipment

createShipment(id, payload, customHeaders?): ResponsePromise<AdminOrdersRes>

Parameters

idstringRequired

payloadAdminPostOrdersOrderShipmentReqRequired

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminOrdersRes>

ResponsePromiseResponsePromise<AdminOrdersRes>Required

---

createSwap

createSwap(id, payload, customHeaders?): ResponsePromise<AdminOrdersRes>

Parameters

idstringRequired

payloadAdminPostOrdersOrderSwapsReqRequired

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminOrdersRes>

ResponsePromiseResponsePromise<AdminOrdersRes>Required

---

createSwapShipment

createSwapShipment(id, swapId, payload, customHeaders?): ResponsePromise<AdminOrdersRes>

Parameters

idstringRequired

swapIdstringRequired

payloadAdminPostOrdersOrderSwapsSwapShipmentsReqRequired

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminOrdersRes>

ResponsePromiseResponsePromise<AdminOrdersRes>Required

---

fulfillClaim

fulfillClaim(id, claimId, payload, customHeaders?): ResponsePromise<AdminOrdersRes>

Parameters

idstringRequired

claimIdstringRequired

payloadAdminPostOrdersOrderClaimsClaimFulfillmentsReqRequired

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminOrdersRes>

ResponsePromiseResponsePromise<AdminOrdersRes>Required

---

fulfillSwap

fulfillSwap(id, swapId, payload, customHeaders?): ResponsePromise<AdminOrdersRes>

Parameters

idstringRequired

swapIdstringRequired

payloadAdminPostOrdersOrderSwapsSwapFulfillmentsReqRequired

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminOrdersRes>

ResponsePromiseResponsePromise<AdminOrdersRes>Required

---

list

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

Parameters

queryAdminGetOrdersParams

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminOrdersListRes>

ResponsePromiseResponsePromise<AdminOrdersListRes>Required

---

processSwapPayment

processSwapPayment(id, swapId, customHeaders?): ResponsePromise<AdminOrdersRes>

Parameters

idstringRequired

swapIdstringRequired

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminOrdersRes>

ResponsePromiseResponsePromise<AdminOrdersRes>Required

---

refundPayment

refundPayment(id, payload, customHeaders?): ResponsePromise<AdminOrdersRes>

Parameters

idstringRequired

payloadAdminPostOrdersOrderRefundsReqRequired

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminOrdersRes>

ResponsePromiseResponsePromise<AdminOrdersRes>Required

---

requestReturn

requestReturn(id, payload, customHeaders?): ResponsePromise<AdminOrdersRes>

Parameters

idstringRequired

payloadAdminPostOrdersOrderReturnsReqRequired

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminOrdersRes>

ResponsePromiseResponsePromise<AdminOrdersRes>Required

---

retrieve

retrieve(id, query?, customHeaders?): ResponsePromise<AdminOrdersRes>

Parameters

idstringRequired

queryFindParams

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminOrdersRes>

ResponsePromiseResponsePromise<AdminOrdersRes>Required

---

update

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

Parameters

idstringRequired

payloadAdminPostOrdersOrderReqRequired

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminOrdersRes>

ResponsePromiseResponsePromise<AdminOrdersRes>Required

---

updateClaim

updateClaim(id, claimId, payload, customHeaders?): ResponsePromise<AdminOrdersRes>

Parameters

idstringRequired

claimIdstringRequired

payloadAdminPostOrdersOrderClaimsClaimReqRequired

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminOrdersRes>

ResponsePromiseResponsePromise<AdminOrdersRes>Required