asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity
Files
02d5c1da88725ea2edbd190260bb1b2cfb1b4bcb
medusa-store/docs/content/references/js-client/classes/AdminOrdersResource.md
Shahed Nasser 02d5c1da88 docs: update Typedoc and regenerate references (#1994) 
* generated new services reference

* changed from automatic push to automated pull request

* updated typedoc, regenerated JS Client reference

* regenerated the reference after updating typedoc

* added action for js client
2022-08-04 17:29:52 +03:00

17 KiB
Raw Blame History

Class: AdminOrdersResource

Hierarchy

  • default

    ↳ AdminOrdersResource

Methods

addShippingMethod

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

Parameters

Name Type
id string
payload AdminPostOrdersOrderShippingMethodsReq
customHeaders Record<string, any>

Returns

ResponsePromise<AdminOrdersRes>

Defined in

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

archive

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

Parameters

Name Type
id string
customHeaders Record<string, any>

Returns

ResponsePromise<AdminOrdersRes>

Defined in

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

cancel

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

Parameters

Name Type
id string
customHeaders Record<string, any>

Returns

ResponsePromise<AdminOrdersRes>

Defined in

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

cancelClaim

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

Parameters

Name Type
id string
claimId string
customHeaders Record<string, any>

Returns

ResponsePromise<AdminOrdersRes>

Defined in

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

cancelClaimFulfillment

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

Parameters

Name Type
id string
claimId string
fulfillmentId string
customHeaders Record<string, any>

Returns

ResponsePromise<AdminOrdersRes>

Defined in

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

cancelFulfillment

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

Parameters

Name Type
id string
fulfillmentId string
customHeaders Record<string, any>

Returns

ResponsePromise<AdminOrdersRes>

Defined in

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

cancelSwap

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

Parameters

Name Type
id string
swapId string
customHeaders Record<string, any>

Returns

ResponsePromise<AdminOrdersRes>

Defined in

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

cancelSwapFulfillment

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

Parameters

Name Type
id string
swapId string
fulfillmentId string
customHeaders Record<string, any>

Returns

ResponsePromise<AdminOrdersRes>

Defined in

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

capturePayment

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

Parameters

Name Type
id string
customHeaders Record<string, any>

Returns

ResponsePromise<AdminOrdersRes>

Defined in

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

complete

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

Parameters

Name Type
id string
customHeaders Record<string, any>

Returns

ResponsePromise<AdminOrdersRes>

Defined in

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

createClaim

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

Parameters

Name Type
id string
payload AdminPostOrdersOrderClaimsReq
customHeaders Record<string, any>

Returns

ResponsePromise<AdminOrdersRes>

Defined in

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

createClaimShipment

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

Parameters

Name Type
id string
claimId string
payload AdminPostOrdersOrderClaimsClaimShipmentsReq
customHeaders Record<string, any>

Returns

ResponsePromise<AdminOrdersRes>

Defined in

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

createFulfillment

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

Parameters

Name Type
id string
payload AdminPostOrdersOrderFulfillmentsReq
customHeaders Record<string, any>

Returns

ResponsePromise<AdminOrdersRes>

Defined in

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

createShipment

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

Parameters

Name Type
id string
payload AdminPostOrdersOrderShipmentReq
customHeaders Record<string, any>

Returns

ResponsePromise<AdminOrdersRes>

Defined in

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

createSwap

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

Parameters

Name Type
id string
payload AdminPostOrdersOrderSwapsReq
customHeaders Record<string, any>

Returns

ResponsePromise<AdminOrdersRes>

Defined in

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

createSwapShipment

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

Parameters

Name Type
id string
swapId string
payload AdminPostOrdersOrderSwapsSwapShipmentsReq
customHeaders Record<string, any>

Returns

ResponsePromise<AdminOrdersRes>

Defined in

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

fulfillClaim

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

Parameters

Name Type
id string
claimId string
payload AdminPostOrdersOrderClaimsClaimFulfillmentsReq
customHeaders Record<string, any>

Returns

ResponsePromise<AdminOrdersRes>

Defined in

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

fulfillSwap

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

Parameters

Name Type
id string
swapId string
payload AdminPostOrdersOrderSwapsSwapFulfillmentsReq
customHeaders Record<string, any>

Returns

ResponsePromise<AdminOrdersRes>

Defined in

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

list

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

Parameters

Name Type
query? AdminGetOrdersParams
customHeaders Record<string, any>

Returns

ResponsePromise<AdminOrdersListRes>

Defined in

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

processSwapPayment

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

Parameters

Name Type
id string
swapId string
customHeaders Record<string, any>

Returns

ResponsePromise<AdminOrdersRes>

Defined in

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

refundPayment

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

Parameters

Name Type
id string
payload AdminPostOrdersOrderRefundsReq
customHeaders Record<string, any>

Returns

ResponsePromise<AdminOrdersRes>

Defined in

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

requestReturn

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

Parameters

Name Type
id string
payload AdminPostOrdersOrderReturnsReq
customHeaders Record<string, any>

Returns

ResponsePromise<AdminOrdersRes>

Defined in

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

retrieve

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

Parameters

Name Type
id string
customHeaders Record<string, any>

Returns

ResponsePromise<AdminOrdersRes>

Defined in

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

update

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

Parameters

Name Type
id string
payload AdminPostOrdersOrderReq
customHeaders Record<string, any>

Returns

ResponsePromise<AdminOrdersRes>

Defined in

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

updateClaim

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

Parameters

Name Type
id string
claimId string
payload AdminPostOrdersOrderClaimsClaimReq
customHeaders Record<string, any>

Returns

ResponsePromise<AdminOrdersRes>

Defined in

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

Reference in New Issue View Git Blame Copy Permalink