feat(core-flows,order,medusa,types): update item metadata on item_update change action

.changeset/seven-windows-brake.md

@@ -0,0 +1,8 @@
+---
+"@medusajs/core-flows": patch
+"@medusajs/order": patch
+"@medusajs/types": patch
+"@medusajs/medusa": patch
+---
+
+feat(core-flows,order,medusa,types): update item metadata on item_update change action

integration-tests/http/__tests__/draft-order/admin/draft-order.spec.ts

@@ -750,6 +750,95 @@ medusaIntegrationTestRunner({
 
         expect(reservations.length).toBe(0)
       })
+
+      it("should update item metadata", async () => {
+        // Create edit
+        await api.post(
+          `/admin/draft-orders/${testDraftOrder.id}/edit`,
+          {},
+          adminHeaders
+        )
+
+        // Add item with initial metadata
+        let orderPreview = (
+          await api.post(
+            `/admin/draft-orders/${testDraftOrder.id}/edit/items`,
+            {
+              items: [
+                {
+                  variant_id: product.variants.find(
+                    (v) => v.title === "L shirt"
+                  ).id,
+                  quantity: 1,
+                  metadata: { initial: "value", custom_field: "original" },
+                },
+              ],
+            },
+            adminHeaders
+          )
+        ).data.draft_order_preview
+
+        const itemToUpdate = orderPreview.items.find(
+          (i) => i.subtitle === "L shirt"
+        )
+        expect(itemToUpdate.metadata).toEqual({
+          initial: "value",
+          custom_field: "original",
+        })
+
+        await api.post(
+          `/admin/draft-orders/${testDraftOrder.id}/edit/confirm`,
+          {},
+          adminHeaders
+        )
+
+        await api.post(
+          `/admin/draft-orders/${testDraftOrder.id}/edit`,
+          {},
+          adminHeaders
+        )
+
+        // Update item with new metadata
+        orderPreview = (
+          await api.post(
+            `/admin/draft-orders/${testDraftOrder.id}/edit/items/item/${itemToUpdate.id}`,
+            {
+              quantity: 2,
+              metadata: { updated: "metadata", custom_field: "modified" },
+            },
+            adminHeaders
+          )
+        ).data.draft_order_preview
+
+        const updatedItem = orderPreview.items.find(
+          (i) => i.subtitle === "L shirt"
+        )
+        expect(updatedItem.quantity).toBe(2)
+        expect(updatedItem.metadata).toEqual({
+          updated: "metadata",
+          custom_field: "modified",
+        })
+
+        await api.post(
+          `/admin/draft-orders/${testDraftOrder.id}/edit/confirm`,
+          {},
+          adminHeaders
+        )
+
+        const order = (
+          await api.get(
+            `/admin/draft-orders/${testDraftOrder.id}`,
+            adminHeaders
+          )
+        ).data.draft_order
+
+        expect(
+          order.items.find((i) => i.subtitle === "L shirt").metadata
+        ).toEqual({
+          updated: "metadata",
+          custom_field: "modified",
+        })
+      })
     })
 
     describe("DELETE /draft-orders/:id/shipping-options/methods/:method_id", () => {

packages/core/core-flows/src/draft-order/workflows/update-draft-order-item.ts

@@ -107,6 +107,7 @@ export const updateDraftOrderItemWorkflow = createWorkflow(
               unit_price: item.unit_price,
               compare_at_unit_price: item.compare_at_unit_price,
               quantity_diff: quantityDiff,
+              metadata: item.metadata,
             },
           }
         })

packages/core/types/src/workflow/order/items.ts

@@ -59,6 +59,10 @@ interface ExistingItem {
    * A note viewed by admins only related to the item.
    */
   internal_note?: string | null
+  /**
+   * Custom key-value pairs to store additional information about the item.
+   */
+  metadata?: Record<string, any> | null
 }
 
 /**

packages/medusa/src/api/admin/draft-orders/validators.ts

@@ -137,6 +137,7 @@ export const AdminUpdateDraftOrderItem = z.object({
   unit_price: z.number().nullish(),
   compare_at_unit_price: z.number().nullish(),
   internal_note: z.string().optional(),
+  metadata: z.record(z.unknown()).nullish(),
 })
 
 export type AdminUpdateDraftOrderActionItemType = z.infer<

packages/modules/order/src/types/utils/index.ts

@@ -20,6 +20,7 @@ export type VirtualOrder = {
     unit_price: BigNumberInput
     compare_at_unit_price: BigNumberInput | null
     quantity: BigNumberInput
+    metadata?: Record<string, unknown>
     adjustments?: (LineItemAdjustmentDTO & { version: number })[]
     tax_lines?: LineItemTaxLineDTO[]
 

packages/modules/order/src/utils/actions/item-update.ts

@@ -27,6 +27,11 @@ OrderChangeProcessing.registerActionType(ChangeActionType.ITEM_UPDATE, {
     existing.quantity = currentQuantity
     existing.detail.quantity = currentQuantity
 
+    if (action.details.metadata !== undefined) {
+      existing.detail.metadata = action.details.metadata
+      existing.metadata = action.details.metadata
+    }
+
     if (action.details.adjustments) {
       existing.adjustments = action.details.adjustments
     }

packages/modules/order/src/utils/transform-order.ts

@@ -55,6 +55,7 @@ export function formatOrder<T = any>(
         raw_compare_at_unit_price:
           detail.raw_compare_at_unit_price ??
           orderItem.item.raw_compare_at_unit_price,
+        metadata: detail.metadata ?? orderItem.item.metadata,
         detail,
       }
     })