Files
medusa-store/docs/content/references/js-client/classes/AdminOrderEditsResource.md
Shahed Nasser 8ca9354c50 docs: updated js client reference (#2414)
* docs: updated js client reference

* docs: fixed link
2022-10-11 16:32:41 +03:00

7.7 KiB

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

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


cancel

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

Parameters

Name Type
id string
customHeaders Record<string, any>

Returns

ResponsePromise<AdminOrderEditsRes>

Defined in

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


confirm

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

Parameters

Name Type
id string
customHeaders Record<string, any>

Returns

ResponsePromise<AdminOrderEditsRes>

Defined in

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


create

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

Parameters

Name Type
payload AdminPostOrderEditsReq
customHeaders Record<string, any>

Returns

ResponsePromise<AdminOrderEditsRes>

Defined in

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


delete

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

Parameters

Name Type
id string
customHeaders Record<string, any>

Returns

ResponsePromise<DeleteResponse>

Defined in

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


deleteItemChange

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

Parameters

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

Returns

ResponsePromise<AdminOrderEditItemChangeDeleteRes>

Defined in

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


removeLineItem

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

Parameters

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

Returns

ResponsePromise<AdminOrderEditsRes>

Defined in

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


requestConfirmation

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

Parameters

Name Type
id string
customHeaders Record<string, any>

Returns

ResponsePromise<AdminOrderEditsRes>

Defined in

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


retrieve

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

Parameters

Name Type
id string
customHeaders Record<string, any>

Returns

ResponsePromise<AdminOrderEditsRes>

Defined in

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


update

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

Parameters

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

Returns

ResponsePromise<AdminOrderEditsRes>

Defined in

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


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

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