Class: AdminDraftOrdersResource
Hierarchy
defaultCopy to Clipboard↳
AdminDraftOrdersResourceCopy to Clipboard
Methods
addLineItem
▸ addLineItem(idCopy to Clipboard, payloadCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminDraftOrdersResCopy to Clipboard>
DescriptionCopy to Clipboard
Add line item to draft order
Parameters
| Name | Type |
|---|---|
idCopy to Clipboard | stringCopy to Clipboard |
payloadCopy to Clipboard | AdminPostDraftOrdersDraftOrderLineItemsReqCopy to Clipboard |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminDraftOrdersResCopy to Clipboard>
Defined in
medusa-js/src/resources/admin/draft-orders.ts:30
create
▸ create(payloadCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminDraftOrdersResCopy to Clipboard>
DescriptionCopy to Clipboard
Creates a draft order
Parameters
| Name | Type |
|---|---|
payloadCopy to Clipboard | AdminPostDraftOrdersReqCopy to Clipboard |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminDraftOrdersResCopy to Clipboard>
Defined in
medusa-js/src/resources/admin/draft-orders.ts:20
delete
▸ delete(idCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<DeleteResponseCopy to Clipboard>
DescriptionCopy to Clipboard
Delete draft order
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/draft-orders.ts:42
list
▸ list(query?Copy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminDraftOrdersListResCopy to Clipboard>
DescriptionCopy to Clipboard
Lists draft orders
Parameters
| Name | Type |
|---|---|
query?Copy to Clipboard | AdminGetDraftOrdersParamsCopy to Clipboard |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminDraftOrdersListResCopy to Clipboard>
Defined in
medusa-js/src/resources/admin/draft-orders.ts:76
markPaid
▸ markPaid(idCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminPostDraftOrdersDraftOrderRegisterPaymentResCopy to Clipboard>
DescriptionCopy to Clipboard
Mark a draft order as paid
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<AdminPostDraftOrdersDraftOrderRegisterPaymentResCopy to Clipboard>
Defined in
medusa-js/src/resources/admin/draft-orders.ts:93
removeLineItem
▸ removeLineItem(idCopy to Clipboard, itemIdCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminDraftOrdersResCopy to Clipboard>
DescriptionCopy to Clipboard
Remove line item
Parameters
| Name | Type |
|---|---|
idCopy 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<AdminDraftOrdersResCopy to Clipboard>
Defined in
medusa-js/src/resources/admin/draft-orders.ts:53
retrieve
▸ retrieve(idCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminDraftOrdersResCopy to Clipboard>
DescriptionCopy to Clipboard
Retrieves a draft order
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<AdminDraftOrdersResCopy to Clipboard>
Defined in
medusa-js/src/resources/admin/draft-orders.ts:65
update
▸ update(idCopy to Clipboard, payloadCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminDraftOrdersResCopy to Clipboard>
DescriptionCopy to Clipboard
Update draft order
Parameters
| Name | Type |
|---|---|
idCopy to Clipboard | stringCopy to Clipboard |
payloadCopy to Clipboard | AdminPostDraftOrdersDraftOrderReqCopy to Clipboard |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminDraftOrdersResCopy to Clipboard>
Defined in
medusa-js/src/resources/admin/draft-orders.ts:104
updateLineItem
▸ updateLineItem(idCopy to Clipboard, itemIdCopy to Clipboard, payloadCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminDraftOrdersResCopy to Clipboard>
DescriptionCopy to Clipboard
Update draft order line item
Parameters
| Name | Type |
|---|---|
idCopy to Clipboard | stringCopy to Clipboard |
itemIdCopy to Clipboard | stringCopy to Clipboard |
payloadCopy to Clipboard | AdminPostDraftOrdersDraftOrderLineItemsItemReqCopy to Clipboard |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminDraftOrdersResCopy to Clipboard>