3b28f46705
* added reference for JS Client * added reference for JS Client * added reference for JS Client
7.2 KiB
Class: AdminDraftOrdersResource
Hierarchy
-
default↳
AdminDraftOrdersResource
Methods
addLineItem
▸ addLineItem(id, payload, customHeaders?): ResponsePromise<AdminDraftOrdersRes>
description Add line item to draft order
Parameters
| Name | Type |
|---|---|
id |
string |
payload |
AdminPostDraftOrdersDraftOrderLineItemsReq |
customHeaders |
Record<string, any> |
Returns
ResponsePromise<AdminDraftOrdersRes>
Defined in
packages/medusa-js/src/resources/admin/draft-orders.ts:29
create
▸ create(payload, customHeaders?): ResponsePromise<AdminDraftOrdersRes>
description Creates a draft order
Parameters
| Name | Type |
|---|---|
payload |
AdminPostDraftOrdersDraftOrderReq |
customHeaders |
Record<string, any> |
Returns
ResponsePromise<AdminDraftOrdersRes>
Defined in
packages/medusa-js/src/resources/admin/draft-orders.ts:19
delete
▸ delete(id, customHeaders?): ResponsePromise<DeleteResponse>
description Delete draft order
Parameters
| Name | Type |
|---|---|
id |
string |
customHeaders |
Record<string, any> |
Returns
ResponsePromise<DeleteResponse>
Defined in
packages/medusa-js/src/resources/admin/draft-orders.ts:40
list
▸ list(query?, customHeaders?): ResponsePromise<AdminDraftOrdersListRes>
description Lists draft orders
Parameters
| Name | Type |
|---|---|
query? |
AdminGetDraftOrdersParams |
customHeaders |
Record<string, any> |
Returns
ResponsePromise<AdminDraftOrdersListRes>
Defined in
packages/medusa-js/src/resources/admin/draft-orders.ts:67
markPaid
▸ markPaid(id, customHeaders?): ResponsePromise<AdminPostDraftOrdersDraftOrderRegisterPaymentRes>
description Mark a draft order as paid
Parameters
| Name | Type |
|---|---|
id |
string |
customHeaders |
Record<string, any> |
Returns
ResponsePromise<AdminPostDraftOrdersDraftOrderRegisterPaymentRes>
Defined in
packages/medusa-js/src/resources/admin/draft-orders.ts:83
removeLineItem
▸ removeLineItem(id, itemId, customHeaders?): ResponsePromise<AdminDraftOrdersRes>
description Remove line item
Parameters
| Name | Type |
|---|---|
id |
string |
itemId |
string |
customHeaders |
Record<string, any> |
Returns
ResponsePromise<AdminDraftOrdersRes>
Defined in
packages/medusa-js/src/resources/admin/draft-orders.ts:48
retrieve
▸ retrieve(id, customHeaders?): ResponsePromise<AdminDraftOrdersRes>
description Retrieves a draft order
Parameters
| Name | Type |
|---|---|
id |
string |
customHeaders |
Record<string, any> |
Returns
ResponsePromise<AdminDraftOrdersRes>
Defined in
packages/medusa-js/src/resources/admin/draft-orders.ts:59
update
▸ update(id, payload, customHeaders?): ResponsePromise<AdminDraftOrdersRes>
description Update draft order
Parameters
| Name | Type |
|---|---|
id |
string |
payload |
AdminPostDraftOrdersDraftOrderReq |
customHeaders |
Record<string, any> |
Returns
ResponsePromise<AdminDraftOrdersRes>
Defined in
packages/medusa-js/src/resources/admin/draft-orders.ts:94
updateLineItem
▸ updateLineItem(id, itemId, payload, customHeaders?): ResponsePromise<AdminDraftOrdersRes>
description Update draft order line item
Parameters
| Name | Type |
|---|---|
id |
string |
itemId |
string |
payload |
AdminPostDraftOrdersDraftOrderLineItemsItemReq |
customHeaders |
Record<string, any> |
Returns
ResponsePromise<AdminDraftOrdersRes>