OrderEditsResource
This class is used to send requests to Store Order Edits API Routes. All its method
are available in the JS Client under the medusa.orderEdits
property.
Order edits are changes made to items in an order such as adding, updating their quantity, or deleting them. Order edits are created by the admin. A customer can review order edit requests created by an admin and confirm or decline them.
Related Guide: How to handle order edits in a storefront.
Methods
retrieve
Retrieve an Order Edit's details.
Example
Parameters
id
stringRequiredcustomHeaders
Record<string, any>RequiredDefault: {}
Returns
ResponsePromise
ResponsePromise<StoreOrderEditsRes>RequiredResolves to the order edit's details.
ResponsePromise
ResponsePromise<StoreOrderEditsRes>Requireddecline
Decline an Order Edit. The changes are not reflected on the original order.
Example
Parameters
id
stringRequiredThe decline details.
customHeaders
Record<string, any>RequiredDefault: {}
Returns
ResponsePromise
ResponsePromise<StoreOrderEditsRes>RequiredResolves to the order edit's details.
ResponsePromise
ResponsePromise<StoreOrderEditsRes>Requiredcomplete
Complete and confirm an Order Edit and reflect its changes on the original order. Any additional payment required must be authorized first using the PaymentCollectionsResource routes.
Example
Parameters
id
stringRequiredcustomHeaders
Record<string, any>RequiredDefault: {}
Returns
ResponsePromise
ResponsePromise<StoreOrderEditsRes>RequiredResolves to the order edit's details.
ResponsePromise
ResponsePromise<StoreOrderEditsRes>Required