Skip to main content

Class: AdminOrdersResource

Hierarchy

  • default

    AdminOrdersResource

Methods

addShippingMethod

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

Parameters

NameType
idstring
payloadAdminPostOrdersOrderShippingMethodsReq
customHeadersRecord<string, any>

Returns

ResponsePromise<AdminOrdersRes>

Defined in

medusa-js/src/resources/admin/orders.ts:152


archive

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

Parameters

NameType
idstring
customHeadersRecord<string, any>

Returns

ResponsePromise<AdminOrdersRes>

Defined in

medusa-js/src/resources/admin/orders.ts:161


cancel

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

Parameters

NameType
idstring
customHeadersRecord<string, any>

Returns

ResponsePromise<AdminOrdersRes>

Defined in

medusa-js/src/resources/admin/orders.ts:144


cancelClaim

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

Parameters

NameType
idstring
claimIdstring
customHeadersRecord<string, any>

Returns

ResponsePromise<AdminOrdersRes>

Defined in

medusa-js/src/resources/admin/orders.ts:225


cancelClaimFulfillment

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

Parameters

NameType
idstring
claimIdstring
fulfillmentIdstring
customHeadersRecord<string, any>

Returns

ResponsePromise<AdminOrdersRes>

Defined in

medusa-js/src/resources/admin/orders.ts:116


cancelFulfillment

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

Parameters

NameType
idstring
fulfillmentIdstring
customHeadersRecord<string, any>

Returns

ResponsePromise<AdminOrdersRes>

Defined in

medusa-js/src/resources/admin/orders.ts:97


cancelSwap

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

Parameters

NameType
idstring
swapIdstring
customHeadersRecord<string, any>

Returns

ResponsePromise<AdminOrdersRes>

Defined in

medusa-js/src/resources/admin/orders.ts:178


cancelSwapFulfillment

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

Parameters

NameType
idstring
swapIdstring
fulfillmentIdstring
customHeadersRecord<string, any>

Returns

ResponsePromise<AdminOrdersRes>

Defined in

medusa-js/src/resources/admin/orders.ts:106


capturePayment

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

Parameters

NameType
idstring
customHeadersRecord<string, any>

Returns

ResponsePromise<AdminOrdersRes>

Defined in

medusa-js/src/resources/admin/orders.ts:71


complete

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

Parameters

NameType
idstring
customHeadersRecord<string, any>

Returns

ResponsePromise<AdminOrdersRes>

Defined in

medusa-js/src/resources/admin/orders.ts:63


createClaim

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

Parameters

NameType
idstring
payloadAdminPostOrdersOrderClaimsReq
customHeadersRecord<string, any>

Returns

ResponsePromise<AdminOrdersRes>

Defined in

medusa-js/src/resources/admin/orders.ts:216


createClaimShipment

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

Parameters

NameType
idstring
claimIdstring
payloadAdminPostOrdersOrderClaimsClaimShipmentsReq
customHeadersRecord<string, any>

Returns

ResponsePromise<AdminOrdersRes>

Defined in

medusa-js/src/resources/admin/orders.ts:254


createFulfillment

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

Parameters

NameType
idstring
payloadAdminPostOrdersOrderFulfillmentsReq
customHeadersRecord<string, any>

Returns

ResponsePromise<AdminOrdersRes>

Defined in

medusa-js/src/resources/admin/orders.ts:88


createShipment

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

Parameters

NameType
idstring
payloadAdminPostOrdersOrderShipmentReq
customHeadersRecord<string, any>

Returns

ResponsePromise<AdminOrdersRes>

Defined in

medusa-js/src/resources/admin/orders.ts:126


createSwap

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

Parameters

NameType
idstring
payloadAdminPostOrdersOrderSwapsReq
customHeadersRecord<string, any>

Returns

ResponsePromise<AdminOrdersRes>

Defined in

medusa-js/src/resources/admin/orders.ts:169


createSwapShipment

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

Parameters

NameType
idstring
swapIdstring
payloadAdminPostOrdersOrderSwapsSwapShipmentsReq
customHeadersRecord<string, any>

Returns

ResponsePromise<AdminOrdersRes>

Defined in

medusa-js/src/resources/admin/orders.ts:197


fulfillClaim

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

Parameters

NameType
idstring
claimIdstring
payloadAdminPostOrdersOrderClaimsClaimFulfillmentsReq
customHeadersRecord<string, any>

Returns

ResponsePromise<AdminOrdersRes>

Defined in

medusa-js/src/resources/admin/orders.ts:244


fulfillSwap

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

Parameters

NameType
idstring
swapIdstring
payloadAdminPostOrdersOrderSwapsSwapFulfillmentsReq
customHeadersRecord<string, any>

Returns

ResponsePromise<AdminOrdersRes>

Defined in

medusa-js/src/resources/admin/orders.ts:187


list

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

Parameters

NameType
query?AdminGetOrdersParams
customHeadersRecord<string, any>

Returns

ResponsePromise<AdminOrdersListRes>

Defined in

medusa-js/src/resources/admin/orders.ts:49


processSwapPayment

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

Parameters

NameType
idstring
swapIdstring
customHeadersRecord<string, any>

Returns

ResponsePromise<AdminOrdersRes>

Defined in

medusa-js/src/resources/admin/orders.ts:207


refundPayment

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

Parameters

NameType
idstring
payloadAdminPostOrdersOrderRefundsReq
customHeadersRecord<string, any>

Returns

ResponsePromise<AdminOrdersRes>

Defined in

medusa-js/src/resources/admin/orders.ts:79


requestReturn

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

Parameters

NameType
idstring
payloadAdminPostOrdersOrderReturnsReq
customHeadersRecord<string, any>

Returns

ResponsePromise<AdminOrdersRes>

Defined in

medusa-js/src/resources/admin/orders.ts:135


retrieve

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

Parameters

NameType
idstring
query?FindParams
customHeadersRecord<string, any>

Returns

ResponsePromise<AdminOrdersRes>

Defined in

medusa-js/src/resources/admin/orders.ts:34


update

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

Parameters

NameType
idstring
payloadAdminPostOrdersOrderReq
customHeadersRecord<string, any>

Returns

ResponsePromise<AdminOrdersRes>

Defined in

medusa-js/src/resources/admin/orders.ts:25


updateClaim

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

Parameters

NameType
idstring
claimIdstring
payloadAdminPostOrdersOrderClaimsClaimReq
customHeadersRecord<string, any>

Returns

ResponsePromise<AdminOrdersRes>

Defined in

medusa-js/src/resources/admin/orders.ts:234

Was this page helpful?