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:152
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:161
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:144
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:225
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:116
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:97
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:178
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:106
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:71
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:63
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:216
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:254
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:88
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:126
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:169
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:197
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:244
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:187
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:49
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:207
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:79
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:135
retrieve
▸ retrieve(id, query?, customHeaders?): ResponsePromise<AdminOrdersRes>
Parameters
| Name | Type |
|---|---|
id | string |
query? | FindParams |
customHeaders | Record<string, any> |
Returns
ResponsePromise<AdminOrdersRes>
Defined in
medusa-js/src/resources/admin/orders.ts:34
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:25
updateClaim
▸ updateClaim(id, claimId, payload, customHeaders?): ResponsePromise<AdminOrdersRes>
Parameters
| Name | Type |
|---|---|
id | string |
claimId | string |
payload | AdminPostOrdersOrderClaimsClaimReq |
customHeaders | Record<string, any> |
Returns
ResponsePromise<AdminOrdersRes>