Class: AdminOrderEditsResource
Hierarchy
defaultCopy to Clipboard↳
AdminOrderEditsResourceCopy to Clipboard
Methods
addLineItem
▸ addLineItem(idCopy to Clipboard, payloadCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminOrderEditsResCopy to Clipboard>
Parameters
| Name | Type |
|---|---|
idCopy to Clipboard | stringCopy to Clipboard |
payloadCopy to Clipboard | AdminPostOrderEditsEditLineItemsReqCopy to Clipboard |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminOrderEditsResCopy to Clipboard>
Defined in
medusa-js/src/resources/admin/order-edits.ts:72
cancel
▸ cancel(idCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminOrderEditsResCopy 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<AdminOrderEditsResCopy to Clipboard>
Defined in
medusa-js/src/resources/admin/order-edits.ts:98
confirm
▸ confirm(idCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminOrderEditsResCopy 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<AdminOrderEditsResCopy to Clipboard>
Defined in
medusa-js/src/resources/admin/order-edits.ts:106
create
▸ create(payloadCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminOrderEditsResCopy to Clipboard>
Parameters
| Name | Type |
|---|---|
payloadCopy to Clipboard | AdminPostOrderEditsReqCopy to Clipboard |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminOrderEditsResCopy to Clipboard>
Defined in
medusa-js/src/resources/admin/order-edits.ts:47
delete
▸ delete(idCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<DeleteResponseCopy 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<DeleteResponseCopy to Clipboard>
Defined in
medusa-js/src/resources/admin/order-edits.ts:64
deleteItemChange
▸ deleteItemChange(orderEditIdCopy to Clipboard, itemChangeIdCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminOrderEditItemChangeDeleteResCopy to Clipboard>
Parameters
| Name | Type |
|---|---|
orderEditIdCopy to Clipboard | stringCopy to Clipboard |
itemChangeIdCopy to Clipboard | stringCopy to Clipboard |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminOrderEditItemChangeDeleteResCopy to Clipboard>
Defined in
medusa-js/src/resources/admin/order-edits.ts:81
list
▸ list(query?Copy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminOrderEditsListResCopy to Clipboard>
Parameters
| Name | Type |
|---|---|
query?Copy to Clipboard | GetOrderEditsParamsCopy to Clipboard |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminOrderEditsListResCopy to Clipboard>
Defined in
medusa-js/src/resources/admin/order-edits.ts:33
removeLineItem
▸ removeLineItem(orderEditIdCopy to Clipboard, itemIdCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminOrderEditsResCopy to Clipboard>
Parameters
| Name | Type |
|---|---|
orderEditIdCopy to Clipboard | stringCopy to Clipboard |
itemIdCopy to Clipboard | stringCopy to Clipboard |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminOrderEditsResCopy to Clipboard>
Defined in
medusa-js/src/resources/admin/order-edits.ts:124
requestConfirmation
▸ requestConfirmation(idCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminOrderEditsResCopy 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<AdminOrderEditsResCopy to Clipboard>
Defined in
medusa-js/src/resources/admin/order-edits.ts:90
retrieve
▸ retrieve(idCopy to Clipboard, query?Copy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminOrderEditsResCopy to Clipboard>
Parameters
| Name | Type |
|---|---|
idCopy to Clipboard | stringCopy to Clipboard |
query?Copy to Clipboard | GetOrderEditsOrderEditParamsCopy to Clipboard |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminOrderEditsResCopy to Clipboard>
Defined in
medusa-js/src/resources/admin/order-edits.ts:18
update
▸ update(idCopy to Clipboard, payloadCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminOrderEditsResCopy to Clipboard>
Parameters
| Name | Type |
|---|---|
idCopy to Clipboard | stringCopy to Clipboard |
payloadCopy to Clipboard | AdminPostOrderEditsOrderEditReqCopy to Clipboard |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminOrderEditsResCopy to Clipboard>
Defined in
medusa-js/src/resources/admin/order-edits.ts:55
updateLineItem
▸ updateLineItem(orderEditIdCopy to Clipboard, itemIdCopy to Clipboard, payloadCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminOrderEditsResCopy to Clipboard>
Parameters
| Name | Type |
|---|---|
orderEditIdCopy to Clipboard | stringCopy to Clipboard |
itemIdCopy to Clipboard | stringCopy to Clipboard |
payloadCopy to Clipboard | AdminPostOrderEditsEditLineItemsLineItemReqCopy to Clipboard |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminOrderEditsResCopy to Clipboard>