feat(core-flows,order,medusa,types): Version shipping method adjustments & implement missing creation flow for versioned adjustments

.changeset/sixty-eagles-melt.md

@@ -0,0 +1,5 @@
+---
+"@medusajs/core-flows": patch
+---
+
+fix(core-flows): Pass shipping_methods to computeActions context

.changeset/strong-ants-warn.md

@@ -0,0 +1,8 @@
+---
+"@medusajs/core-flows": patch
+"@medusajs/order": patch
+"@medusajs/types": patch
+"@medusajs/medusa": patch
+---
+
+feat(core-flows,order,medusa,types): Version shipping method adjustments & implement missing creation flow for versioned adjustments

integration-tests/http/__tests__/order-edits/order-edits.spec.ts

@@ -2492,6 +2492,186 @@ medusaIntegrationTestRunner({
         expect(orderResult2.total).toEqual(20)
         expect(orderResult2.original_total).toEqual(20)
       })
+
+      it("should maintain shipping method adjustments when adding a new item with promotion targeting shipping methods", async () => {
+        // Create a promotion that targets shipping methods
+        const shippingPromotion = await promotionModule.createPromotions({
+          code: "SHIPPING_PROMO",
+          type: PromotionType.STANDARD,
+          status: PromotionStatus.ACTIVE,
+          application_method: {
+            type: "fixed",
+            target_type: "shipping_methods",
+            allocation: "each",
+            value: 2,
+            max_quantity: 1,
+            currency_code: "usd",
+            target_rules: [
+              {
+                attribute: "name",
+                operator: "in",
+                values: ["Test shipping method"],
+              },
+            ],
+          },
+        })
+
+        // Create an order with shipping method
+        // @ts-ignore
+        const orderWithShipping = await orderModule.createOrders({
+          email: "foo@bar.com",
+          region_id: region.id,
+          sales_channel_id: salesChannel.id,
+          items: [
+            {
+              // @ts-ignore
+              id: "item-shipping-1",
+              title: "Custom Item",
+              quantity: 1,
+              unit_price: 10,
+            },
+          ],
+          shipping_address: {
+            first_name: "Test",
+            last_name: "Test",
+            address_1: "Test",
+            city: "Test",
+            country_code: "US",
+            postal_code: "12345",
+            phone: "12345",
+          },
+          billing_address: {
+            first_name: "Test",
+            last_name: "Test",
+            address_1: "Test",
+            city: "Test",
+            country_code: "US",
+            postal_code: "12345",
+          },
+          shipping_methods: [
+            {
+              name: "Test shipping method",
+              amount: 5,
+            },
+          ],
+          currency_code: "usd",
+        })
+
+        // Create shipping method adjustment for the promotion
+        if (orderWithShipping.shipping_methods?.[0]) {
+          await orderModule.createOrderShippingMethodAdjustments(
+            orderWithShipping.id,
+            [
+              {
+                shipping_method_id: orderWithShipping.shipping_methods[0].id,
+                code: shippingPromotion.code!,
+                amount: 2,
+              },
+            ]
+          )
+        }
+
+        // Link promotion to order
+        await remoteLink.create({
+          [Modules.ORDER]: { order_id: orderWithShipping.id },
+          [Modules.PROMOTION]: { promotion_id: shippingPromotion.id },
+        })
+
+        // Create order edit
+        let result = await api.post(
+          "/admin/order-edits",
+          {
+            order_id: orderWithShipping.id,
+            description: "Test shipping promotion",
+          },
+          adminHeaders
+        )
+
+        const orderChangeId = result.data.order_change.id
+        const orderId = result.data.order_change.order_id
+
+        // Enable carry over promotions
+        await api.post(
+          `/admin/order-changes/${orderChangeId}`,
+          {
+            carry_over_promotions: true,
+          },
+          adminHeaders
+        )
+
+        result = (await api.get(`/admin/orders/${orderId}`, adminHeaders)).data
+          .order
+
+        // Original order: $10 item + $5 shipping - $2 shipping discount = $13
+        expect(result.total).toEqual(13)
+        expect(result.shipping_methods[0].adjustments).toEqual([
+          expect.objectContaining({
+            code: shippingPromotion.code!,
+            amount: 2,
+          }),
+        ])
+
+        // Add item with price $12
+        result = (
+          await api.post(
+            `/admin/order-edits/${orderId}/items`,
+            {
+              items: [
+                {
+                  variant_id: productExtra.variants[0].id,
+                  quantity: 1,
+                },
+              ],
+            },
+            adminHeaders
+          )
+        ).data.order_preview
+
+        // After adding item: $22 items + $5 shipping - $2 shipping discount + $1.2 tax = $26.2
+        expect(result.total).toEqual(26.2)
+        expect(result.original_total).toEqual(28.2) // +$2 shipping discount
+
+        // Shipping method adjustment should still be present
+        expect(result.shipping_methods[0].adjustments).toEqual([
+          expect.objectContaining({
+            code: shippingPromotion.code!,
+            amount: 2,
+          }),
+        ])
+
+        // Confirm original order is not updated
+        const orderResult = (
+          await api.get(`/admin/orders/${orderId}`, adminHeaders)
+        ).data.order
+
+        expect(orderResult.total).toEqual(13)
+        expect(orderResult.shipping_methods[0].adjustments).toEqual([
+          expect.objectContaining({
+            code: shippingPromotion.code!,
+            amount: 2,
+          }),
+        ])
+
+        // Confirm the order edit
+        await api.post(
+          `/admin/order-edits/${orderId}/confirm`,
+          {},
+          adminHeaders
+        )
+
+        const orderResult2 = (
+          await api.get(`/admin/orders/${orderId}`, adminHeaders)
+        ).data.order
+
+        expect(orderResult2.total).toEqual(26.2)
+        expect(orderResult2.original_total).toEqual(28.2)
+        expect(orderResult2.shipping_methods[0].adjustments).toEqual([
+          expect.objectContaining({
+            code: shippingPromotion.code!,
+            amount: 2,
+          }),
+        ])
+      })
     })
   },
 })

packages/core/core-flows/src/draft-order/workflows/compute-draft-order-adjustments.ts

@@ -8,6 +8,7 @@ import {
 } from "@medusajs/framework/workflows-sdk"
 import type {
   ComputeActionContext,
+  ComputeActionShippingLine,
   OrderChangeDTO,
   OrderDTO,
   PromotionDTO,
@@ -145,7 +146,7 @@ export const computeDraftOrderAdjustmentsWorkflow = createWorkflow(
           .filter((p) => p !== undefined)
       })
 
-      const actionsToComputeItemsInput = transform(
+      const actionsToComputeContext = transform(
         { previewedOrder, order },
         ({ previewedOrder, order }) => {
           return {
@@ -155,12 +156,14 @@ export const computeDraftOrderAdjustmentsWorkflow = createWorkflow(
               // Buy-Get promotions rely on the product ID, so we need to manually set it before refreshing adjustments
               product: { id: item.product_id },
             })),
+            shipping_methods:
+              previewedOrder.shipping_methods as unknown as ComputeActionShippingLine[],
           } as ComputeActionContext
         }
       )
 
       const actions = getActionsToComputeFromPromotionsStep({
-        computeActionContext: actionsToComputeItemsInput,
+        computeActionContext: actionsToComputeContext,
         promotionCodesToApply: orderPromotions,
       })
 

packages/core/core-flows/src/order/workflows/compute-adjustments-for-preview.ts

@@ -1,5 +1,6 @@
 import {
   ComputeActionContext,
+  ComputeActionShippingLine,
   OrderChangeDTO,
   OrderDTO,
   PromotionDTO,
@@ -87,7 +88,7 @@ export const computeAdjustmentsForPreviewWorkflow = createWorkflow(
          */
         !!order.promotions.length && !!input.orderChange.carry_over_promotions
     ).then(() => {
-      const actionsToComputeItemsInput = transform(
+      const actionsToComputeContext = transform(
         { previewedOrder, order: input.order },
         ({ previewedOrder, order }) => {
           return {
@@ -97,6 +98,8 @@ export const computeAdjustmentsForPreviewWorkflow = createWorkflow(
               // Buy-Get promotions rely on the product ID, so we need to manually set it before refreshing adjustments
               product: { id: item.product_id },
             })),
+            shipping_methods:
+              previewedOrder.shipping_methods as unknown as ComputeActionShippingLine[],
           } as ComputeActionContext
         }
       )
@@ -108,7 +111,7 @@ export const computeAdjustmentsForPreviewWorkflow = createWorkflow(
       })
 
       const actions = getActionsToComputeFromPromotionsStep({
-        computeActionContext: actionsToComputeItemsInput,
+        computeActionContext: actionsToComputeContext,
         promotionCodesToApply: orderPromotions,
         options: {
           skip_usage_limit_checks: true,

packages/core/types/src/order/common.ts

@@ -130,6 +130,11 @@ export interface OrderShippingMethodAdjustmentDTO
    * The ID of the associated shipping method.
    */
   shipping_method_id: string
+
+  /**
+   * The version of the adjustment.
+   */
+  version: number
 }
 
 /**
@@ -147,6 +152,11 @@ export interface OrderLineItemAdjustmentDTO extends OrderAdjustmentLineDTO {
    * The ID of the associated line item.
    */
   item_id: string
+
+  /**
+   * The version of the adjustment.
+   */
+  version: number
 }
 
 /**

packages/core/types/src/order/mutations.ts

@@ -840,6 +840,11 @@ export interface CreateOrderShippingMethodAdjustmentDTO {
    * The associated provider's ID.
    */
   provider_id?: string
+
+  /**
+   * The version of the adjustment.
+   */
+  version?: number
 }
 
 /**

packages/medusa/src/migration-scripts/backfill-shipping-adjustment-versions.ts

@@ -0,0 +1,42 @@
+import { ExecArgs } from "@medusajs/framework/types"
+import { ContainerRegistrationKeys } from "@medusajs/framework/utils"
+
+/**
+ * Data migration to backfill version field for existing order_shipping_method_adjustment records.
+ * Sets adjustment versions based on the latest order_shipping version for their associated shipping method.
+ */
+export default async function backfillShippingAdjustmentVersions({
+  container,
+}: ExecArgs) {
+  const knex = container.resolve(ContainerRegistrationKeys.PG_CONNECTION)
+  const logger = container.resolve(ContainerRegistrationKeys.LOGGER)
+
+  logger.info("Backfilling shipping method adjustment versions")
+
+  try {
+    await knex.transaction(async (trx) => {
+      const result = await trx.raw(`
+        WITH latest_order_shipping_version AS (
+          SELECT
+            os.shipping_method_id AS shipping_method_id,
+            MAX(os.version) AS version
+          FROM "order_shipping" os
+          WHERE os.deleted_at IS NULL
+          GROUP BY os.shipping_method_id
+        )
+        UPDATE "order_shipping_method_adjustment" osma
+        SET version = losv.version
+        FROM latest_order_shipping_version losv
+        WHERE osma.shipping_method_id = losv.shipping_method_id
+          AND osma.version <> losv.version
+      `)
+
+      logger.info(
+        `Successfully backfilled shipping method adjustment versions (${result.rowCount} rows updated)`
+      )
+    })
+  } catch (e) {
+    logger.error("Failed to backfill shipping method adjustment versions", e)
+    throw e
+  }
+}