daea35fe73
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
7.5 KiB
displayed_sidebar
| displayed_sidebar |
|---|
| jsClientSidebar |
Class: AdminDraftOrdersResource
Hierarchy
-
default↳
AdminDraftOrdersResource
Methods
addLineItem
▸ addLineItem(id, payload, customHeaders?): ResponsePromise<AdminDraftOrdersRes>
Parameters
| Name | Type |
|---|---|
id |
string |
payload |
AdminPostDraftOrdersDraftOrderLineItemsReq |
customHeaders |
Record<string, any> |
Returns
ResponsePromise<AdminDraftOrdersRes>
Description
Add line item to draft order
Defined in
packages/medusa-js/src/resources/admin/draft-orders.ts:30
create
▸ create(payload, customHeaders?): ResponsePromise<AdminDraftOrdersRes>
Parameters
| Name | Type |
|---|---|
payload |
AdminPostDraftOrdersReq |
customHeaders |
Record<string, any> |
Returns
ResponsePromise<AdminDraftOrdersRes>
Description
Creates a draft order
Defined in
packages/medusa-js/src/resources/admin/draft-orders.ts:20
delete
▸ delete(id, customHeaders?): ResponsePromise<DeleteResponse>
Parameters
| Name | Type |
|---|---|
id |
string |
customHeaders |
Record<string, any> |
Returns
ResponsePromise<DeleteResponse>
Description
Delete draft order
Defined in
packages/medusa-js/src/resources/admin/draft-orders.ts:42
list
▸ list(query?, customHeaders?): ResponsePromise<AdminDraftOrdersListRes>
Parameters
| Name | Type |
|---|---|
query? |
AdminGetDraftOrdersParams |
customHeaders |
Record<string, any> |
Returns
ResponsePromise<AdminDraftOrdersListRes>
Description
Lists draft orders
Defined in
packages/medusa-js/src/resources/admin/draft-orders.ts:76
markPaid
▸ markPaid(id, customHeaders?): ResponsePromise<AdminPostDraftOrdersDraftOrderRegisterPaymentRes>
Parameters
| Name | Type |
|---|---|
id |
string |
customHeaders |
Record<string, any> |
Returns
ResponsePromise<AdminPostDraftOrdersDraftOrderRegisterPaymentRes>
Description
Mark a draft order as paid
Defined in
packages/medusa-js/src/resources/admin/draft-orders.ts:93
removeLineItem
▸ removeLineItem(id, itemId, customHeaders?): ResponsePromise<AdminDraftOrdersRes>
Parameters
| Name | Type |
|---|---|
id |
string |
itemId |
string |
customHeaders |
Record<string, any> |
Returns
ResponsePromise<AdminDraftOrdersRes>
Description
Remove line item
Defined in
packages/medusa-js/src/resources/admin/draft-orders.ts:53
retrieve
▸ retrieve(id, customHeaders?): ResponsePromise<AdminDraftOrdersRes>
Parameters
| Name | Type |
|---|---|
id |
string |
customHeaders |
Record<string, any> |
Returns
ResponsePromise<AdminDraftOrdersRes>
Description
Retrieves a draft order
Defined in
packages/medusa-js/src/resources/admin/draft-orders.ts:65
update
▸ update(id, payload, customHeaders?): ResponsePromise<AdminDraftOrdersRes>
Parameters
| Name | Type |
|---|---|
id |
string |
payload |
AdminPostDraftOrdersDraftOrderReq |
customHeaders |
Record<string, any> |
Returns
ResponsePromise<AdminDraftOrdersRes>
Description
Update draft order
Defined in
packages/medusa-js/src/resources/admin/draft-orders.ts:104
updateLineItem
▸ updateLineItem(id, itemId, payload, customHeaders?): ResponsePromise<AdminDraftOrdersRes>
Parameters
| Name | Type |
|---|---|
id |
string |
itemId |
string |
payload |
AdminPostDraftOrdersDraftOrderLineItemsItemReq |
customHeaders |
Record<string, any> |
Returns
ResponsePromise<AdminDraftOrdersRes>
Description
Update draft order line item