asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

docs: general updates and fixes (#13620)

Browse Source
This commit is contained in:
Shahed Nasser
2025-09-30 08:45:30 +03:00
committed by GitHub
parent dda756dfaa
commit f970e1355a
47 changed files with 358 additions and 306 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/apps/resources/app/commerce-modules/order/edit/page.mdx
+12 -12
View File
@@ -4,7 +4,7 @@ export const metadata = {
# {metadata.title}
In this document, you'll learn about order edits.
In this guide, you'll learn about order edits.
<Note title="Looking for no-code docs?">
@@ -14,23 +14,23 @@ Refer to this [Medusa Admin User Guide](!user-guide!/orders/edit) to learn how t
## What is an Order Edit?
A merchant can edit an order to add new items or change the quantity of existing items in the order.
A merchant can edit an order to add new items or change the quantity of existing items.
An order edit is represented by the [OrderChange data model](/references/order/models/OrderChange).
The `OrderChange` data model is associated with any type of change, including a return or exchange. However, its `change_type` property distinguishes the type of change it's making.
The `OrderChange` data model is associated with any type of change, including returns or exchanges. However, its `change_type` property distinguishes the type of change being made.
In the case of an order edit, the `OrderChange`'s type is `edit`.
For order edits, the `OrderChange`'s `change_type` is `edit`.
---
## Add Items in an Order Edit
When the merchant adds new items to the order in the order edit, the item is added as an [OrderItem](/references/order/models/OrderItem).
When a merchant adds new items to an order during editing, the item is added as an [OrderItem](/references/order/models/OrderItem).
Also, an `OrderChangeAction` is created. The [OrderChangeAction data model](/references/order/models/OrderChangeAction) represents a change made by an `OrderChange`, such as an item added.
Additionally, an `OrderChangeAction` is created. The [OrderChangeAction data model](/references/order/models/OrderChangeAction) represents a change made by an `OrderChange`, such as adding an item.
So, when an item is added, an `OrderChangeAction` is created with the type `ITEM_ADD`. In its `details` property, the item's ID, price, and quantity are stored.
When an item is added, an `OrderChangeAction` is created with the type `ITEM_ADD`. Its `details` property stores the item's ID, price, and quantity.
---
@@ -38,7 +38,7 @@ So, when an item is added, an `OrderChangeAction` is created with the type `ITEM
A merchant can update an existing item's quantity or price.
This change is added as an `OrderChangeAction` with the type `ITEM_UPDATE`. In its `details` property, the item's ID, new price, and new quantity are stored.
This change is recorded as an `OrderChangeAction` with the type `ITEM_UPDATE`. Its `details` property stores the item's ID, updated price, and updated quantity.
---
@@ -46,18 +46,18 @@ This change is added as an `OrderChangeAction` with the type `ITEM_UPDATE`. In i
Adding new items to the order requires adding shipping methods for those items.
These shipping methods are represented by the [OrderShippingMethod data model](/references/order/models/OrderItem). Also, an `OrderChangeAction` is created with the type `SHIPPING_ADD`
These shipping methods are represented by the [OrderShippingMethod data model](/references/order/models/OrderShippingMethod). Also, an `OrderChangeAction` is created with the type `SHIPPING_ADD`.
---
## How Order Edits Impact an Order’s Version
When an order edit is confirmed, the order’s version is incremented.
When an order edit is confirmed, the order’s [version](../order-versioning/page.mdx) is incremented.
---
## Payments and Refunds for Order Edit Changes
Once the Order Edit is confirmed, any additional payment or refund required can be made on the original order.
Once the order edit is confirmed, any additional payment or refund required can be made on the original order.
This is determined by the comparison between the `OrderSummary` and the order's transactions, as mentioned in [this guide](../transactions/page.mdx#checking-outstanding-amount).
This is determined by the comparison between the `OrderSummary` and the order's transactions, as mentioned in the [Transactions guide](../transactions/page.mdx#checking-outstanding-amount).