feat: Delete service zone (#6984)

integration-tests/api/__tests__/admin/fulfillment-sets.spec.ts

@@ -249,6 +249,74 @@ medusaIntegrationTestRunner({
           `Invalid request body: ${JSON.stringify(expectedErrors)}`
         )
       })
+
+      describe("POST /admin/fulfillment-sets/:id/service-zones", () => {
+        it("should delete a service zone for a fulfillment set", async () => {
+          const stockLocationResponse = await api.post(
+            `/admin/stock-locations`,
+            {
+              name: "test location",
+            },
+            adminHeaders
+          )
+
+          const stockLocationId = stockLocationResponse.data.stock_location.id
+
+          const locationWithFSetResponse = await api.post(
+            `/admin/stock-locations/${stockLocationId}/fulfillment-sets?fields=id,*fulfillment_sets`,
+            {
+              name: "Fulfillment Set",
+              type: "shipping",
+            },
+            adminHeaders
+          )
+
+          const fulfillmentSetId =
+            locationWithFSetResponse.data.stock_location.fulfillment_sets[0].id
+
+          const response = await api.post(
+            `/admin/fulfillment-sets/${fulfillmentSetId}/service-zones`,
+            {
+              name: "Test Zone",
+              geo_zones: [],
+            },
+            adminHeaders
+          )
+
+          const fset = response.data.fulfillment_set
+
+          const serviceZoneId = fset.service_zones[0].id
+
+          const deleteResponse = await api.delete(
+            `/admin/fulfillment-sets/${fulfillmentSetId}/service-zones/${serviceZoneId}`,
+            adminHeaders
+          )
+
+          expect(deleteResponse.status).toEqual(200)
+          expect(deleteResponse.data).toEqual(
+            expect.objectContaining({
+              id: serviceZoneId,
+              object: "service-zone",
+              deleted: true,
+              parent: expect.objectContaining({
+                id: fulfillmentSetId,
+              }),
+            })
+          )
+        })
+
+        it("should throw when fulfillment set doesn't exist", async () => {
+          const deleteResponse = await api
+            .delete(
+              `/admin/fulfillment-sets/foo/service-zones/bar`,
+              adminHeaders
+            )
+            .catch((e) => e.response)
+
+          expect(deleteResponse.status).toEqual(404)
+          expect(deleteResponse.data.message).toEqual("FulfillmentSet with id: foo was not found")
+        })
+      })
     })
   },
 })

packages/core-flows/src/fulfillment/steps/delete-service-zones.ts

@@ -0,0 +1,28 @@
+import { ModuleRegistrationName } from "@medusajs/modules-sdk"
+import { IFulfillmentModuleService } from "@medusajs/types"
+import { StepResponse, createStep } from "@medusajs/workflows-sdk"
+
+export const deleteServiceZonesStepId = "delete-service-zones"
+export const deleteServiceZonesStep = createStep(
+  deleteServiceZonesStepId,
+  async (ids: string[], { container }) => {
+    const service = container.resolve<IFulfillmentModuleService>(
+      ModuleRegistrationName.FULFILLMENT
+    )
+
+    await service.softDelete(ids)
+
+    return new StepResponse(void 0, ids)
+  },
+  async (prevIds, { container }) => {
+    if (!prevIds?.length) {
+      return
+    }
+
+    const service = container.resolve<IFulfillmentModuleService>(
+      ModuleRegistrationName.FULFILLMENT
+    )
+
+    await service.restore(prevIds)
+  }
+)

packages/core-flows/src/fulfillment/steps/index.ts

@@ -3,4 +3,5 @@ export * from "./add-shipping-options-prices"
 export * from "./create-fulfillment-set"
 export * from "./create-service-zones"
 export * from "./create-shipping-options"
+export * from "./delete-service-zones"
 export * from "./remove-rules-from-fulfillment-shipping-option"

packages/core-flows/src/fulfillment/workflows/delete-service-zones.ts

@@ -0,0 +1,10 @@
+import { WorkflowData, createWorkflow } from "@medusajs/workflows-sdk"
+import { deleteServiceZonesStep } from "../steps"
+
+export const deleteServiceZonesWorkflowId = "delete-service-zones-workflow"
+export const deleteServiceZonesWorkflow = createWorkflow(
+  deleteServiceZonesWorkflowId,
+  (input: WorkflowData<{ ids: string[] }>) => {
+    deleteServiceZonesStep(input.ids)
+  }
+)

packages/core-flows/src/fulfillment/workflows/index.ts

@@ -1,4 +1,5 @@
 export * from "./add-rules-to-fulfillment-shipping-option"
 export * from "./create-service-zones"
+export * from "./delete-service-zones"
 export * from "./create-shipping-options"
 export * from "./remove-rules-from-fulfillment-shipping-option"

packages/medusa/src/api-v2/admin/fulfillment-sets/[id]/service-zones/[zone_id]/route.ts

@@ -0,0 +1,36 @@
+import { ModuleRegistrationName } from "@medusajs/modules-sdk"
+import { IFulfillmentModuleService } from "@medusajs/types"
+import { deleteServiceZonesWorkflow } from "../../../../../../../../core-flows/dist"
+import {
+  AuthenticatedMedusaRequest,
+  MedusaResponse,
+} from "../../../../../../types/routing"
+
+export const DELETE = async (
+  req: AuthenticatedMedusaRequest,
+  res: MedusaResponse
+) => {
+  const { id, zone_id } = req.params
+
+  const fulfillmentModuleService = req.scope.resolve<IFulfillmentModuleService>(
+    ModuleRegistrationName.FULFILLMENT
+  )
+
+  const fulfillmentSet = await fulfillmentModuleService.retrieve(id)
+
+  const { errors } = await deleteServiceZonesWorkflow(req.scope).run({
+    input: { ids: [zone_id] },
+    throwOnError: false,
+  })
+
+  if (Array.isArray(errors) && errors[0]) {
+    throw errors[0].error
+  }
+
+  res.status(200).json({
+    id: zone_id,
+    object: "service-zone",
+    deleted: true,
+    parent: fulfillmentSet,
+  })
+}

packages/medusa/src/api-v2/admin/fulfillment-sets/middlewares.ts

@@ -5,7 +5,7 @@ import { validateAndTransformQuery } from "../../utils/validate-query"
 import * as QueryConfig from "./query-config"
 import {
   AdminCreateFulfillmentSetServiceZonesSchema,
-  AdminFulfillmentSetParams
+  AdminFulfillmentSetParams,
 } from "./validators"
 
 export const adminFulfillmentSetsRoutesMiddlewares: MiddlewareRoute[] = [
@@ -25,4 +25,9 @@ export const adminFulfillmentSetsRoutesMiddlewares: MiddlewareRoute[] = [
       ),
     ],
   },
+  {
+    method: ["DELETE"],
+    matcher: "/admin/fulfillment-sets/:id/service-zones/:zone_id",
+    middlewares: [],
+  },
 ]