AdminDraftOrdersResource

admin/draft-orders.AdminDraftOrdersResource

Methods

addLineItem

addLineItem(id, payload, customHeaders?): ResponsePromise<AdminDraftOrdersRes>

Parameters

idstringRequired

payloadAdminPostDraftOrdersDraftOrderLineItemsReqRequired

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminDraftOrdersRes>

ResponsePromiseResponsePromise<AdminDraftOrdersRes>Required

Description

Add line item to draft order

---

create

create(payload, customHeaders?): ResponsePromise<AdminDraftOrdersRes>

Parameters

payloadAdminPostDraftOrdersReqRequired

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminDraftOrdersRes>

ResponsePromiseResponsePromise<AdminDraftOrdersRes>Required

Description

Creates a draft order

---

delete

delete(id, customHeaders?): ResponsePromise<DeleteResponse>

Parameters

idstringRequired

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<DeleteResponse>

ResponsePromiseResponsePromise<DeleteResponse>Required

Description

Delete draft order

---

list

list(query?, customHeaders?): ResponsePromise<AdminDraftOrdersListRes>

Parameters

queryAdminGetDraftOrdersParams

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminDraftOrdersListRes>

ResponsePromiseResponsePromise<AdminDraftOrdersListRes>Required

Description

Lists draft orders

---

markPaid

markPaid(id, customHeaders?): ResponsePromise<AdminPostDraftOrdersDraftOrderRegisterPaymentRes>

Parameters

idstringRequired

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminPostDraftOrdersDraftOrderRegisterPaymentRes>

ResponsePromiseResponsePromise<AdminPostDraftOrdersDraftOrderRegisterPaymentRes>Required

Description

Mark a draft order as paid

---

removeLineItem

removeLineItem(id, itemId, customHeaders?): ResponsePromise<AdminDraftOrdersRes>

Parameters

idstringRequired

itemIdstringRequired

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminDraftOrdersRes>

ResponsePromiseResponsePromise<AdminDraftOrdersRes>Required

Description

Remove line item

---

retrieve

retrieve(id, customHeaders?): ResponsePromise<AdminDraftOrdersRes>

Parameters

idstringRequired

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminDraftOrdersRes>

ResponsePromiseResponsePromise<AdminDraftOrdersRes>Required

Description

Retrieves a draft order

---

update

update(id, payload, customHeaders?): ResponsePromise<AdminDraftOrdersRes>

Parameters

idstringRequired

payloadAdminPostDraftOrdersDraftOrderReqRequired

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminDraftOrdersRes>

ResponsePromiseResponsePromise<AdminDraftOrdersRes>Required

Description

Update draft order

---

updateLineItem

updateLineItem(id, itemId, payload, customHeaders?): ResponsePromise<AdminDraftOrdersRes>

Parameters

idstringRequired

itemIdstringRequired

payloadAdminPostDraftOrdersDraftOrderLineItemsItemReqRequired

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminDraftOrdersRes>

ResponsePromiseResponsePromise<AdminDraftOrdersRes>Required

Description

Update draft order line item