asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity
Files
e51fdd3304697725f8d7e3980e38fbdec6a3c58d
medusa-store/docs/content/references/js-client/classes/AdminOrdersResource.md
Shahed Nasser 3b28f46705 docs: added reference for JS Client (#1629) 
* added reference for JS Client

* added reference for JS Client

* added reference for JS Client
2022-07-08 18:21:46 +03:00

20 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

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

archive

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

Parameters

Name Type
id string
customHeaders Record<string, any>

Returns

ResponsePromise<AdminOrdersRes>

Defined in

packages/medusa-js/src/resources/admin/orders.ts:162

cancel

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

Parameters

Name Type
id string
customHeaders Record<string, any>

Returns

ResponsePromise<AdminOrdersRes>

Defined in

packages/medusa-js/src/resources/admin/orders.ts:145

cancelClaim

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

Parameters

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

Returns

ResponsePromise<AdminOrdersRes>

Defined in

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

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

packages/medusa-js/src/resources/admin/orders.ts:117

cancelFulfillment

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

Parameters

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

Returns

ResponsePromise<AdminOrdersRes>

Defined in

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

cancelSwap

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

Parameters

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

Returns

ResponsePromise<AdminOrdersRes>

Defined in

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

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

packages/medusa-js/src/resources/admin/orders.ts:107

capturePayment

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

Parameters

Name Type
id string
customHeaders Record<string, any>

Returns

ResponsePromise<AdminOrdersRes>

Defined in

packages/medusa-js/src/resources/admin/orders.ts:72

complete

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

Parameters

Name Type
id string
customHeaders Record<string, any>

Returns

ResponsePromise<AdminOrdersRes>

Defined in

packages/medusa-js/src/resources/admin/orders.ts:64

create

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

Parameters

Name Type
payload AdminPostOrdersReq
customHeaders Record<string, any>

Returns

ResponsePromise<AdminOrdersRes>

Defined in

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

createClaim

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

Parameters

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

Returns

ResponsePromise<AdminOrdersRes>

Defined in

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

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

packages/medusa-js/src/resources/admin/orders.ts:255

createFulfillment

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

Parameters

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

Returns

ResponsePromise<AdminOrdersRes>

Defined in

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

createShipment

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

Parameters

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

Returns

ResponsePromise<AdminOrdersRes>

Defined in

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

createSwap

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

Parameters

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

Returns

ResponsePromise<AdminOrdersRes>

Defined in

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

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

packages/medusa-js/src/resources/admin/orders.ts:198

deleteMetadata

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

Parameters

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

Returns

ResponsePromise<AdminOrdersRes>

Defined in

packages/medusa-js/src/resources/admin/orders.ts:265

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

packages/medusa-js/src/resources/admin/orders.ts:245

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

packages/medusa-js/src/resources/admin/orders.ts:188

list

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

Parameters

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

Returns

ResponsePromise<AdminOrdersListRes>

Defined in

packages/medusa-js/src/resources/admin/orders.ts:50

processSwapPayment

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

Parameters

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

Returns

ResponsePromise<AdminOrdersRes>

Defined in

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

refundPayment

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

Parameters

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

Returns

ResponsePromise<AdminOrdersRes>

Defined in

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

requestReturn

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

Parameters

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

Returns

ResponsePromise<AdminOrdersRes>

Defined in

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

retrieve

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

Parameters

Name Type
id string
customHeaders Record<string, any>

Returns

ResponsePromise<AdminOrdersRes>

Defined in

packages/medusa-js/src/resources/admin/orders.ts:42

update

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

Parameters

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

Returns

ResponsePromise<AdminOrdersRes>

Defined in

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

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

packages/medusa-js/src/resources/admin/orders.ts:235

Reference in New Issue View Git Blame Copy Permalink