medusa-store/www/apps/docs/content/references/js-client/classes/AdminOrderEditsResource.md

displayed_sidebar

displayed_sidebar
jsClientSidebar

Class: AdminOrderEditsResource

Hierarchy

• default

  ↳ AdminOrderEditsResource

Methods

addLineItem

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

Parameters

Name	Type
id	string
payload	AdminPostOrderEditsEditLineItemsReq
customHeaders	Record<string, any>

Returns

ResponsePromise<AdminOrderEditsRes>

Defined in

packages/medusa-js/src/resources/admin/order-edits.ts:72

---

cancel

▸ cancel(id, customHeaders?): ResponsePromise<AdminOrderEditsRes>

Parameters

Name	Type
id	string
customHeaders	Record<string, any>

Returns

ResponsePromise<AdminOrderEditsRes>

Defined in

packages/medusa-js/src/resources/admin/order-edits.ts:98

---

confirm

▸ confirm(id, customHeaders?): ResponsePromise<AdminOrderEditsRes>

Parameters

Name	Type
id	string
customHeaders	Record<string, any>

Returns

ResponsePromise<AdminOrderEditsRes>

Defined in

packages/medusa-js/src/resources/admin/order-edits.ts:106

---

create

▸ create(payload, customHeaders?): ResponsePromise<AdminOrderEditsRes>

Parameters

Name	Type
payload	AdminPostOrderEditsReq
customHeaders	Record<string, any>

Returns

ResponsePromise<AdminOrderEditsRes>

Defined in

packages/medusa-js/src/resources/admin/order-edits.ts:47

---

delete

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

Parameters

Name	Type
id	string
customHeaders	Record<string, any>

Returns

ResponsePromise<DeleteResponse>

Defined in

packages/medusa-js/src/resources/admin/order-edits.ts:64

---

deleteItemChange

▸ deleteItemChange(orderEditId, itemChangeId, customHeaders?): ResponsePromise<AdminOrderEditItemChangeDeleteRes>

Parameters

Name	Type
orderEditId	string
itemChangeId	string
customHeaders	Record<string, any>

Returns

ResponsePromise<AdminOrderEditItemChangeDeleteRes>

Defined in

packages/medusa-js/src/resources/admin/order-edits.ts:81

---

list

▸ list(query?, customHeaders?): ResponsePromise<AdminOrderEditsListRes>

Parameters

Name	Type
query?	GetOrderEditsParams
customHeaders	Record<string, any>

Returns

ResponsePromise<AdminOrderEditsListRes>

Defined in

packages/medusa-js/src/resources/admin/order-edits.ts:33

---

removeLineItem

▸ removeLineItem(orderEditId, itemId, customHeaders?): ResponsePromise<AdminOrderEditsRes>

Parameters

Name	Type
orderEditId	string
itemId	string
customHeaders	Record<string, any>

Returns

ResponsePromise<AdminOrderEditsRes>

Defined in

packages/medusa-js/src/resources/admin/order-edits.ts:124

---

requestConfirmation

▸ requestConfirmation(id, customHeaders?): ResponsePromise<AdminOrderEditsRes>

Parameters

Name	Type
id	string
customHeaders	Record<string, any>

Returns

ResponsePromise<AdminOrderEditsRes>

Defined in

packages/medusa-js/src/resources/admin/order-edits.ts:90

---

retrieve

▸ retrieve(id, query?, customHeaders?): ResponsePromise<AdminOrderEditsRes>

Parameters

Name	Type
id	string
query?	GetOrderEditsOrderEditParams
customHeaders	Record<string, any>

Returns

ResponsePromise<AdminOrderEditsRes>

Defined in

packages/medusa-js/src/resources/admin/order-edits.ts:18

---

update

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

Parameters

Name	Type
id	string
payload	AdminPostOrderEditsOrderEditReq
customHeaders	Record<string, any>

Returns

ResponsePromise<AdminOrderEditsRes>

Defined in

packages/medusa-js/src/resources/admin/order-edits.ts:55

---

updateLineItem

▸ updateLineItem(orderEditId, itemId, payload, customHeaders?): ResponsePromise<AdminOrderEditsRes>

Parameters

Name	Type
orderEditId	string
itemId	string
payload	AdminPostOrderEditsEditLineItemsLineItemReq
customHeaders	Record<string, any>

Returns

ResponsePromise<AdminOrderEditsRes>

Defined in

packages/medusa-js/src/resources/admin/order-edits.ts:114