Class: AdminOrdersResource
Hierarchy
defaultCopy to Clipboard↳
AdminOrdersResourceCopy to Clipboard
Methods
addShippingMethod
▸ addShippingMethod(idCopy to Clipboard, payloadCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminOrdersResCopy to Clipboard>
Parameters
| Name | Type |
|---|---|
idCopy to Clipboard | stringCopy to Clipboard |
payloadCopy to Clipboard | AdminPostOrdersOrderShippingMethodsReqCopy to Clipboard |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminOrdersResCopy to Clipboard>
Defined in
medusa-js/src/resources/admin/orders.ts:152
archive
▸ archive(idCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminOrdersResCopy to Clipboard>
Parameters
| Name | Type |
|---|---|
idCopy to Clipboard | stringCopy to Clipboard |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminOrdersResCopy to Clipboard>
Defined in
medusa-js/src/resources/admin/orders.ts:161
cancel
▸ cancel(idCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminOrdersResCopy to Clipboard>
Parameters
| Name | Type |
|---|---|
idCopy to Clipboard | stringCopy to Clipboard |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminOrdersResCopy to Clipboard>
Defined in
medusa-js/src/resources/admin/orders.ts:144
cancelClaim
▸ cancelClaim(idCopy to Clipboard, claimIdCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminOrdersResCopy to Clipboard>
Parameters
| Name | Type |
|---|---|
idCopy to Clipboard | stringCopy to Clipboard |
claimIdCopy to Clipboard | stringCopy to Clipboard |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminOrdersResCopy to Clipboard>
Defined in
medusa-js/src/resources/admin/orders.ts:225
cancelClaimFulfillment
▸ cancelClaimFulfillment(idCopy to Clipboard, claimIdCopy to Clipboard, fulfillmentIdCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminOrdersResCopy to Clipboard>
Parameters
| Name | Type |
|---|---|
idCopy to Clipboard | stringCopy to Clipboard |
claimIdCopy to Clipboard | stringCopy to Clipboard |
fulfillmentIdCopy to Clipboard | stringCopy to Clipboard |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminOrdersResCopy to Clipboard>
Defined in
medusa-js/src/resources/admin/orders.ts:116
cancelFulfillment
▸ cancelFulfillment(idCopy to Clipboard, fulfillmentIdCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminOrdersResCopy to Clipboard>
Parameters
| Name | Type |
|---|---|
idCopy to Clipboard | stringCopy to Clipboard |
fulfillmentIdCopy to Clipboard | stringCopy to Clipboard |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminOrdersResCopy to Clipboard>
Defined in
medusa-js/src/resources/admin/orders.ts:97
cancelSwap
▸ cancelSwap(idCopy to Clipboard, swapIdCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminOrdersResCopy to Clipboard>
Parameters
| Name | Type |
|---|---|
idCopy to Clipboard | stringCopy to Clipboard |
swapIdCopy to Clipboard | stringCopy to Clipboard |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminOrdersResCopy to Clipboard>
Defined in
medusa-js/src/resources/admin/orders.ts:178
cancelSwapFulfillment
▸ cancelSwapFulfillment(idCopy to Clipboard, swapIdCopy to Clipboard, fulfillmentIdCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminOrdersResCopy to Clipboard>
Parameters
| Name | Type |
|---|---|
idCopy to Clipboard | stringCopy to Clipboard |
swapIdCopy to Clipboard | stringCopy to Clipboard |
fulfillmentIdCopy to Clipboard | stringCopy to Clipboard |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminOrdersResCopy to Clipboard>
Defined in
medusa-js/src/resources/admin/orders.ts:106
capturePayment
▸ capturePayment(idCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminOrdersResCopy to Clipboard>
Parameters
| Name | Type |
|---|---|
idCopy to Clipboard | stringCopy to Clipboard |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminOrdersResCopy to Clipboard>
Defined in
medusa-js/src/resources/admin/orders.ts:71
complete
▸ complete(idCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminOrdersResCopy to Clipboard>
Parameters
| Name | Type |
|---|---|
idCopy to Clipboard | stringCopy to Clipboard |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminOrdersResCopy to Clipboard>
Defined in
medusa-js/src/resources/admin/orders.ts:63
createClaim
▸ createClaim(idCopy to Clipboard, payloadCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminOrdersResCopy to Clipboard>
Parameters
| Name | Type |
|---|---|
idCopy to Clipboard | stringCopy to Clipboard |
payloadCopy to Clipboard | AdminPostOrdersOrderClaimsReqCopy to Clipboard |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminOrdersResCopy to Clipboard>
Defined in
medusa-js/src/resources/admin/orders.ts:216
createClaimShipment
▸ createClaimShipment(idCopy to Clipboard, claimIdCopy to Clipboard, payloadCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminOrdersResCopy to Clipboard>
Parameters
| Name | Type |
|---|---|
idCopy to Clipboard | stringCopy to Clipboard |
claimIdCopy to Clipboard | stringCopy to Clipboard |
payloadCopy to Clipboard | AdminPostOrdersOrderClaimsClaimShipmentsReqCopy to Clipboard |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminOrdersResCopy to Clipboard>
Defined in
medusa-js/src/resources/admin/orders.ts:254
createFulfillment
▸ createFulfillment(idCopy to Clipboard, payloadCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminOrdersResCopy to Clipboard>
Parameters
| Name | Type |
|---|---|
idCopy to Clipboard | stringCopy to Clipboard |
payloadCopy to Clipboard | AdminPostOrdersOrderFulfillmentsReqCopy to Clipboard |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminOrdersResCopy to Clipboard>
Defined in
medusa-js/src/resources/admin/orders.ts:88
createShipment
▸ createShipment(idCopy to Clipboard, payloadCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminOrdersResCopy to Clipboard>
Parameters
| Name | Type |
|---|---|
idCopy to Clipboard | stringCopy to Clipboard |
payloadCopy to Clipboard | AdminPostOrdersOrderShipmentReqCopy to Clipboard |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminOrdersResCopy to Clipboard>
Defined in
medusa-js/src/resources/admin/orders.ts:126
createSwap
▸ createSwap(idCopy to Clipboard, payloadCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminOrdersResCopy to Clipboard>
Parameters
| Name | Type |
|---|---|
idCopy to Clipboard | stringCopy to Clipboard |
payloadCopy to Clipboard | AdminPostOrdersOrderSwapsReqCopy to Clipboard |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminOrdersResCopy to Clipboard>
Defined in
medusa-js/src/resources/admin/orders.ts:169
createSwapShipment
▸ createSwapShipment(idCopy to Clipboard, swapIdCopy to Clipboard, payloadCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminOrdersResCopy to Clipboard>
Parameters
| Name | Type |
|---|---|
idCopy to Clipboard | stringCopy to Clipboard |
swapIdCopy to Clipboard | stringCopy to Clipboard |
payloadCopy to Clipboard | AdminPostOrdersOrderSwapsSwapShipmentsReqCopy to Clipboard |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminOrdersResCopy to Clipboard>
Defined in
medusa-js/src/resources/admin/orders.ts:197
fulfillClaim
▸ fulfillClaim(idCopy to Clipboard, claimIdCopy to Clipboard, payloadCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminOrdersResCopy to Clipboard>
Parameters
| Name | Type |
|---|---|
idCopy to Clipboard | stringCopy to Clipboard |
claimIdCopy to Clipboard | stringCopy to Clipboard |
payloadCopy to Clipboard | AdminPostOrdersOrderClaimsClaimFulfillmentsReqCopy to Clipboard |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminOrdersResCopy to Clipboard>
Defined in
medusa-js/src/resources/admin/orders.ts:244
fulfillSwap
▸ fulfillSwap(idCopy to Clipboard, swapIdCopy to Clipboard, payloadCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminOrdersResCopy to Clipboard>
Parameters
| Name | Type |
|---|---|
idCopy to Clipboard | stringCopy to Clipboard |
swapIdCopy to Clipboard | stringCopy to Clipboard |
payloadCopy to Clipboard | AdminPostOrdersOrderSwapsSwapFulfillmentsReqCopy to Clipboard |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminOrdersResCopy to Clipboard>
Defined in
medusa-js/src/resources/admin/orders.ts:187
list
▸ list(query?Copy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminOrdersListResCopy to Clipboard>
Parameters
| Name | Type |
|---|---|
query?Copy to Clipboard | AdminGetOrdersParamsCopy to Clipboard |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminOrdersListResCopy to Clipboard>
Defined in
medusa-js/src/resources/admin/orders.ts:49
processSwapPayment
▸ processSwapPayment(idCopy to Clipboard, swapIdCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminOrdersResCopy to Clipboard>
Parameters
| Name | Type |
|---|---|
idCopy to Clipboard | stringCopy to Clipboard |
swapIdCopy to Clipboard | stringCopy to Clipboard |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminOrdersResCopy to Clipboard>
Defined in
medusa-js/src/resources/admin/orders.ts:207
refundPayment
▸ refundPayment(idCopy to Clipboard, payloadCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminOrdersResCopy to Clipboard>
Parameters
| Name | Type |
|---|---|
idCopy to Clipboard | stringCopy to Clipboard |
payloadCopy to Clipboard | AdminPostOrdersOrderRefundsReqCopy to Clipboard |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminOrdersResCopy to Clipboard>
Defined in
medusa-js/src/resources/admin/orders.ts:79
requestReturn
▸ requestReturn(idCopy to Clipboard, payloadCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminOrdersResCopy to Clipboard>
Parameters
| Name | Type |
|---|---|
idCopy to Clipboard | stringCopy to Clipboard |
payloadCopy to Clipboard | AdminPostOrdersOrderReturnsReqCopy to Clipboard |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminOrdersResCopy to Clipboard>
Defined in
medusa-js/src/resources/admin/orders.ts:135
retrieve
▸ retrieve(idCopy to Clipboard, query?Copy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminOrdersResCopy to Clipboard>
Parameters
| Name | Type |
|---|---|
idCopy to Clipboard | stringCopy to Clipboard |
query?Copy to Clipboard | FindParamsCopy to Clipboard |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminOrdersResCopy to Clipboard>
Defined in
medusa-js/src/resources/admin/orders.ts:34
update
▸ update(idCopy to Clipboard, payloadCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminOrdersResCopy to Clipboard>
Parameters
| Name | Type |
|---|---|
idCopy to Clipboard | stringCopy to Clipboard |
payloadCopy to Clipboard | AdminPostOrdersOrderReqCopy to Clipboard |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminOrdersResCopy to Clipboard>
Defined in
medusa-js/src/resources/admin/orders.ts:25
updateClaim
▸ updateClaim(idCopy to Clipboard, claimIdCopy to Clipboard, payloadCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminOrdersResCopy to Clipboard>
Parameters
| Name | Type |
|---|---|
idCopy to Clipboard | stringCopy to Clipboard |
claimIdCopy to Clipboard | stringCopy to Clipboard |
payloadCopy to Clipboard | AdminPostOrdersOrderClaimsClaimReqCopy to Clipboard |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminOrdersResCopy to Clipboard>