feat(order): cancel fulfillment (#7573)

packages/modules/order/src/services/__tests__/util/actions/returns.ts

@@ -95,7 +95,7 @@ describe("Order Return - Actions", function () {
         order: originalOrder,
         actions,
       })
-    }).toThrow(`Reference ID "333" not found.`)
+    }).toThrow(`Item ID "333" not found.`)
   })
 
   it("should validate return received", function () {

packages/modules/order/src/services/order-module-service.ts

@@ -2142,6 +2142,40 @@ export default class OrderModuleService<
     await this.confirmOrderChange(change[0].id, sharedContext)
   }
 
+  @InjectTransactionManager("baseRepository_")
+  async cancelFulfillment(
+    data: OrderTypes.CancelOrderFulfillmentDTO,
+    sharedContext?: Context
+  ): Promise<void> {
+    const items = data.items.map((item) => {
+      return {
+        action: ChangeActionType.CANCEL_ITEM_FULFILLMENT,
+        internal_note: item.internal_note,
+        reference: data.reference,
+        reference_id: data.reference_id,
+        details: {
+          reference_id: item.id,
+          quantity: item.quantity,
+          metadata: item.metadata,
+        },
+      }
+    })
+
+    const change = await this.createOrderChange_(
+      {
+        order_id: data.order_id,
+        description: data.description,
+        internal_note: data.internal_note,
+        created_by: data.created_by,
+        metadata: data.metadata,
+        actions: items,
+      },
+      sharedContext
+    )
+
+    await this.confirmOrderChange(change[0].id, sharedContext)
+  }
+
   @InjectTransactionManager("baseRepository_")
   async registerShipment(
     data: OrderTypes.RegisterOrderShipmentDTO,

packages/modules/order/src/utils/action-key.ts

@@ -2,6 +2,7 @@ export enum ChangeActionType {
   CANCEL = "CANCEL",
   CANCEL_RETURN = "CANCEL_RETURN",
   FULFILL_ITEM = "FULFILL_ITEM",
+  CANCEL_ITEM_FULFILLMENT = "CANCEL_ITEM_FULFILLMENT",
   ITEM_ADD = "ITEM_ADD",
   ITEM_REMOVE = "ITEM_REMOVE",
   RECEIVE_DAMAGED_RETURN_ITEM = "RECEIVE_DAMAGED_RETURN_ITEM",

packages/modules/order/src/utils/actions/cancel-item-fulfillment.ts

@@ -0,0 +1,74 @@
+import { MathBN, MedusaError, isDefined } from "@medusajs/utils"
+import { ChangeActionType } from "../action-key"
+import { OrderChangeProcessing } from "../calculate-order-change"
+
+OrderChangeProcessing.registerActionType(
+  ChangeActionType.CANCEL_ITEM_FULFILLMENT,
+  {
+    operation({ action, currentOrder }) {
+      const existing = currentOrder.items.find(
+        (item) => item.id === action.details.reference_id
+      )!
+
+      existing.detail.fulfilled_quantity ??= 0
+
+      existing.detail.fulfilled_quantity = MathBN.sub(
+        existing.detail.fulfilled_quantity,
+        action.details.quantity
+      )
+    },
+    revert({ action, currentOrder }) {
+      const existing = currentOrder.items.find(
+        (item) => item.id === action.reference_id
+      )!
+
+      existing.detail.fulfilled_quantity = MathBN.add(
+        existing.detail.fulfilled_quantity,
+        action.details.quantity
+      )
+    },
+    validate({ action, currentOrder }) {
+      const refId = action.details?.reference_id
+      if (!isDefined(refId)) {
+        throw new MedusaError(
+          MedusaError.Types.INVALID_DATA,
+          "Reference ID is required."
+        )
+      }
+
+      const existing = currentOrder.items.find((item) => item.id === refId)
+
+      if (!existing) {
+        throw new MedusaError(
+          MedusaError.Types.INVALID_DATA,
+          `Item ID "${refId}" not found.`
+        )
+      }
+
+      if (!action.details?.quantity) {
+        throw new MedusaError(
+          MedusaError.Types.INVALID_DATA,
+          `Quantity to cancel item fulfillment ${refId} is required.`
+        )
+      }
+
+      if (action.details?.quantity < 1) {
+        throw new MedusaError(
+          MedusaError.Types.INVALID_DATA,
+          `Quantity to cancel item ${refId} must be greater than 0.`
+        )
+      }
+
+      const greater = MathBN.gt(
+        action.details?.quantity,
+        existing.detail?.fulfilled_quantity
+      )
+      if (greater) {
+        throw new MedusaError(
+          MedusaError.Types.INVALID_DATA,
+          `Cannot cancel more items than what was fulfilled for item ${refId}.`
+        )
+      }
+    },
+  }
+)

packages/modules/order/src/utils/actions/cancel-return.ts

@@ -48,7 +48,7 @@ OrderChangeProcessing.registerActionType(ChangeActionType.CANCEL_RETURN, {
     if (!existing) {
       throw new MedusaError(
         MedusaError.Types.INVALID_DATA,
-        `Reference ID "${refId}" not found.`
+        `Item ID "${refId}" not found.`
       )
     }
 

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

@@ -38,7 +38,7 @@ OrderChangeProcessing.registerActionType(ChangeActionType.FULFILL_ITEM, {
     if (!existing) {
       throw new MedusaError(
         MedusaError.Types.INVALID_DATA,
-        `Reference ID "${refId}" not found.`
+        `Item ID "${refId}" not found.`
       )
     }
 

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

@@ -1,4 +1,5 @@
 export * from "./cancel"
+export * from "./cancel-item-fulfillment"
 export * from "./cancel-return"
 export * from "./fulfill-item"
 export * from "./item-add"

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

@@ -58,7 +58,7 @@ OrderChangeProcessing.registerActionType(ChangeActionType.ITEM_REMOVE, {
     if (!existing) {
       throw new MedusaError(
         MedusaError.Types.INVALID_DATA,
-        `Reference ID "${refId}" not found.`
+        `Item ID "${refId}" not found.`
       )
     }
 

packages/modules/order/src/utils/actions/receive-damaged-return-item.ts

@@ -89,7 +89,7 @@ OrderChangeProcessing.registerActionType(
       if (!existing) {
         throw new MedusaError(
           MedusaError.Types.INVALID_DATA,
-          `Reference ID "${refId}" not found.`
+          `Item ID "${refId}" not found.`
         )
       }
 

packages/modules/order/src/utils/actions/receive-return-item.ts

@@ -95,7 +95,7 @@ OrderChangeProcessing.registerActionType(ChangeActionType.RECEIVE_RETURN_ITEM, {
     if (!existing) {
       throw new MedusaError(
         MedusaError.Types.INVALID_DATA,
-        `Reference ID "${refId}" not found.`
+        `Item ID "${refId}" not found.`
       )
     }
 

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

@@ -42,7 +42,7 @@ OrderChangeProcessing.registerActionType(ChangeActionType.RETURN_ITEM, {
     if (!existing) {
       throw new MedusaError(
         MedusaError.Types.INVALID_DATA,
-        `Reference ID "${refId}" not found.`
+        `Item ID "${refId}" not found.`
       )
     }
 

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

@@ -38,7 +38,7 @@ OrderChangeProcessing.registerActionType(ChangeActionType.SHIP_ITEM, {
     if (!existing) {
       throw new MedusaError(
         MedusaError.Types.INVALID_DATA,
-        `Reference ID "${refId}" not found.`
+        `Item ID "${refId}" not found.`
       )
     }
 

packages/modules/order/src/utils/actions/write-off-item.ts

@@ -38,7 +38,7 @@ OrderChangeProcessing.registerActionType(ChangeActionType.WRITE_OFF_ITEM, {
     if (!existing) {
       throw new MedusaError(
         MedusaError.Types.INVALID_DATA,
-        `Reference ID "${refId}" not found.`
+        `Item ID "${refId}" not found.`
       )
     }