02d5c1da88
* generated new services reference * changed from automatic push to automated pull request * updated typedoc, regenerated JS Client reference * regenerated the reference after updating typedoc * added action for js client
6.9 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
medusa-js/src/resources/admin/draft-orders.ts:30
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
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
medusa-js/src/resources/admin/draft-orders.ts:42
list
▸ list(query?, customHeaders?): ResponsePromise<AdminDraftOrdersListRes>
Description
Lists draft orders
Parameters
| Name | Type |
|---|---|
query? |
AdminGetDraftOrdersParams |
customHeaders |
Record<string, any> |
Returns
ResponsePromise<AdminDraftOrdersListRes>
Defined in
medusa-js/src/resources/admin/draft-orders.ts:76
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
medusa-js/src/resources/admin/draft-orders.ts:93
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
medusa-js/src/resources/admin/draft-orders.ts:53
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
medusa-js/src/resources/admin/draft-orders.ts:65
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
medusa-js/src/resources/admin/draft-orders.ts:104
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>