Skip to main content

Class: AdminDraftOrdersResource

Hierarchy

  • Copy to Clipboard

    Copy to Clipboard

Methods

addLineItem

addLineItem(

Copy to Clipboard
,
Copy to Clipboard
,
Copy to Clipboard
):
Copy to Clipboard
<
Copy to Clipboard
>

Copy to Clipboard

Add line item to draft order

Parameters

NameType
Copy to Clipboard
Copy to Clipboard
Copy to Clipboard
Copy to Clipboard
Copy to Clipboard
Copy to Clipboard
<
Copy to Clipboard
,
Copy to Clipboard
>

Returns

<
Copy to Clipboard
>

Defined in

medusa-js/src/resources/admin/draft-orders.ts:30


create

create(

Copy to Clipboard
,
Copy to Clipboard
):
Copy to Clipboard
<
Copy to Clipboard
>

Copy to Clipboard

Creates a draft order

Parameters

NameType
Copy to Clipboard
Copy to Clipboard
Copy to Clipboard
Copy to Clipboard
<
Copy to Clipboard
,
Copy to Clipboard
>

Returns

<
Copy to Clipboard
>

Defined in

medusa-js/src/resources/admin/draft-orders.ts:20


delete

delete(

Copy to Clipboard
,
Copy to Clipboard
):
Copy to Clipboard
<
Copy to Clipboard
>

Copy to Clipboard

Delete draft order

Parameters

NameType
Copy to Clipboard
Copy to Clipboard
Copy to Clipboard
Copy to Clipboard
<
Copy to Clipboard
,
Copy to Clipboard
>

Returns

<
Copy to Clipboard
>

Defined in

medusa-js/src/resources/admin/draft-orders.ts:42


list

list(

Copy to Clipboard
,
Copy to Clipboard
):
Copy to Clipboard
<
Copy to Clipboard
>

Copy to Clipboard

Lists draft orders

Parameters

NameType
Copy to Clipboard
Copy to Clipboard
Copy to Clipboard
Copy to Clipboard
<
Copy to Clipboard
,
Copy to Clipboard
>

Returns

<
Copy to Clipboard
>

Defined in

medusa-js/src/resources/admin/draft-orders.ts:76


markPaid

markPaid(

Copy to Clipboard
,
Copy to Clipboard
):
Copy to Clipboard
<
Copy to Clipboard
>

Copy to Clipboard

Mark a draft order as paid

Parameters

NameType
Copy to Clipboard
Copy to Clipboard
Copy to Clipboard
Copy to Clipboard
<
Copy to Clipboard
,
Copy to Clipboard
>

Returns

<
Copy to Clipboard
>

Defined in

medusa-js/src/resources/admin/draft-orders.ts:93


removeLineItem

removeLineItem(

Copy to Clipboard
,
Copy to Clipboard
,
Copy to Clipboard
):
Copy to Clipboard
<
Copy to Clipboard
>

Copy to Clipboard

Remove line item

Parameters

NameType
Copy to Clipboard
Copy to Clipboard
Copy to Clipboard
Copy to Clipboard
Copy to Clipboard
Copy to Clipboard
<
Copy to Clipboard
,
Copy to Clipboard
>

Returns

<
Copy to Clipboard
>

Defined in

medusa-js/src/resources/admin/draft-orders.ts:53


retrieve

retrieve(

Copy to Clipboard
,
Copy to Clipboard
):
Copy to Clipboard
<
Copy to Clipboard
>

Copy to Clipboard

Retrieves a draft order

Parameters

NameType
Copy to Clipboard
Copy to Clipboard
Copy to Clipboard
Copy to Clipboard
<
Copy to Clipboard
,
Copy to Clipboard
>

Returns

<
Copy to Clipboard
>

Defined in

medusa-js/src/resources/admin/draft-orders.ts:65


update

update(

Copy to Clipboard
,
Copy to Clipboard
,
Copy to Clipboard
):
Copy to Clipboard
<
Copy to Clipboard
>

Copy to Clipboard

Update draft order

Parameters

NameType
Copy to Clipboard
Copy to Clipboard
Copy to Clipboard
Copy to Clipboard
Copy to Clipboard
Copy to Clipboard
<
Copy to Clipboard
,
Copy to Clipboard
>

Returns

<
Copy to Clipboard
>

Defined in

medusa-js/src/resources/admin/draft-orders.ts:104


updateLineItem

updateLineItem(

Copy to Clipboard
,
Copy to Clipboard
,
Copy to Clipboard
,
Copy to Clipboard
):
Copy to Clipboard
<
Copy to Clipboard
>

Copy to Clipboard

Update draft order line item

Parameters

NameType
Copy to Clipboard
Copy to Clipboard
Copy to Clipboard
Copy to Clipboard
Copy to Clipboard
Copy to Clipboard
Copy to Clipboard
Copy to Clipboard
<
Copy to Clipboard
,
Copy to Clipboard
>

Returns

<
Copy to Clipboard
>

Defined in

medusa-js/src/resources/admin/draft-orders.ts:116