Skip to main content
Skip to main content

AdminOrderEditsResource

admin/order-edits.AdminOrderEditsResource

Methods​

addLineItem​

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

Parameters​

idstringRequired
payloadAdminPostOrderEditsEditLineItemsReqRequired
customHeadersRecord<string, any>Required

Default: `{}`

Returns​

ResponsePromise<AdminOrderEditsRes>

ResponsePromiseResponsePromise<AdminOrderEditsRes>Required

cancel​

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

Parameters​

idstringRequired
customHeadersRecord<string, any>Required

Default: `{}`

Returns​

ResponsePromise<AdminOrderEditsRes>

ResponsePromiseResponsePromise<AdminOrderEditsRes>Required

confirm​

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

Parameters​

idstringRequired
customHeadersRecord<string, any>Required

Default: `{}`

Returns​

ResponsePromise<AdminOrderEditsRes>

ResponsePromiseResponsePromise<AdminOrderEditsRes>Required

create​

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

Parameters​

payloadAdminPostOrderEditsReqRequired
customHeadersRecord<string, any>Required

Default: `{}`

Returns​

ResponsePromise<AdminOrderEditsRes>

ResponsePromiseResponsePromise<AdminOrderEditsRes>Required

delete​

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

Parameters​

idstringRequired
customHeadersRecord<string, any>Required

Default: `{}`

Returns​

ResponsePromise<DeleteResponse>

ResponsePromiseResponsePromise<DeleteResponse>Required

deleteItemChange​

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

Parameters​

orderEditIdstringRequired
itemChangeIdstringRequired
customHeadersRecord<string, any>Required

Default: `{}`

Returns​

ResponsePromise<AdminOrderEditItemChangeDeleteRes>

list​

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

Parameters​

queryGetOrderEditsParams
customHeadersRecord<string, any>Required

Default: `{}`

Returns​

ResponsePromise<AdminOrderEditsListRes>

ResponsePromiseResponsePromise<AdminOrderEditsListRes>Required

removeLineItem​

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

Parameters​

orderEditIdstringRequired
itemIdstringRequired
customHeadersRecord<string, any>Required

Default: `{}`

Returns​

ResponsePromise<AdminOrderEditsRes>

ResponsePromiseResponsePromise<AdminOrderEditsRes>Required

requestConfirmation​

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

Parameters​

idstringRequired
customHeadersRecord<string, any>Required

Default: `{}`

Returns​

ResponsePromise<AdminOrderEditsRes>

ResponsePromiseResponsePromise<AdminOrderEditsRes>Required

retrieve​

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

Parameters​

idstringRequired
queryGetOrderEditsOrderEditParams
customHeadersRecord<string, any>Required

Default: `{}`

Returns​

ResponsePromise<AdminOrderEditsRes>

ResponsePromiseResponsePromise<AdminOrderEditsRes>Required

update​

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

Parameters​

idstringRequired
payloadAdminPostOrderEditsOrderEditReqRequired
customHeadersRecord<string, any>Required

Default: `{}`

Returns​

ResponsePromise<AdminOrderEditsRes>

ResponsePromiseResponsePromise<AdminOrderEditsRes>Required

updateLineItem​

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

Parameters​

orderEditIdstringRequired
itemIdstringRequired
payloadAdminPostOrderEditsEditLineItemsLineItemReqRequired
customHeadersRecord<string, any>Required

Default: `{}`

Returns​

ResponsePromise<AdminOrderEditsRes>

ResponsePromiseResponsePromise<AdminOrderEditsRes>Required
Was this section helpful?
© 2023 Medusa, Inc. All rights reserved.