fa7c94b4cc
* docs: migrate ui docs to docs universe * created yarn workspace * added eslint and tsconfig configurations * fix eslint configurations * fixed eslint configurations * shared tailwind configurations * added shared ui package * added more shared components * migrating more components * made details components shared * move InlineCode component * moved InputText * moved Loading component * Moved Modal component * moved Select components * Moved Tooltip component * moved Search components * moved ColorMode provider * Moved Notification components and providers * used icons package * use UI colors in api-reference * moved Navbar component * used Navbar and Search in UI docs * added Feedback to UI docs * general enhancements * fix color mode * added copy colors file from ui-preset * added features and enhancements to UI docs * move Sidebar component and provider * general fixes and preparations for deployment * update docusaurus version * adjusted versions * fix output directory * remove rootDirectory property * fix yarn.lock * moved code component * added vale for all docs MD and MDX * fix tests * fix vale error * fix deployment errors * change ignore commands * add output directory * fix docs test * general fixes * content fixes * fix announcement script * added changeset * fix vale checks * added nofilter option * fix vale error
6.8 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 |
AdminPostDraftOrdersReq |
customHeaders |
Record<string, any> |
Returns
ResponsePromise<AdminDraftOrdersRes>
Defined in
medusa-js/src/resources/admin/draft-orders.ts:20
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>