feat(medusa, stock-location): Sales channel filtering when listing locations (#3324)

* only add ordering select if not already selected

* add integration test

* add changeset

* remove catch

* linting and suggestion from adrien

* add sales channel filtering when listing locations

* add changeset

* add exception back into sales channel location service

---------

Co-authored-by: Oliver Windall Juhl <59018053+olivermrbl@users.noreply.github.com>

.changeset/lucky-boats-invent.md

@@ -0,0 +1,5 @@
+---
+"@medusajs/medusa": patch
+---
+
+Add filtering of stock locations based on sales channels

integration-tests/plugins/__tests__/stock-location/sales-channels.js

@@ -8,6 +8,8 @@ const adminSeeder = require("../../helpers/admin-seeder")
 
 jest.setTimeout(30000)
 
+const adminHeaders = { headers: { Authorization: "Bearer test_token" } }
+
 describe("Sales channels", () => {
   let appContainer
   let dbConnection
@@ -38,10 +40,13 @@ describe("Sales channels", () => {
   })
 
   describe("Stock Locations", () => {
+    describe("CORE", () => {
       it("When listing a sales channel, it brings all associated locations with it", async () => {
         await adminSeeder(dbConnection)
 
-      const stockLocationService = appContainer.resolve("stockLocationService")
+        const stockLocationService = appContainer.resolve(
+          "stockLocationService"
+        )
         const salesChannelService = appContainer.resolve("salesChannelService")
         const salesChannelLocationService = appContainer.resolve(
           "salesChannelLocationService"
@@ -91,4 +96,64 @@ describe("Sales channels", () => {
         )
       })
     })
+
+    describe("API", () => {
+      it("Filters stock locations based on sales channel ids", async () => {
+        const api = useApi()
+
+        await adminSeeder(dbConnection)
+
+        const stockLocationService = appContainer.resolve(
+          "stockLocationService"
+        )
+        const salesChannelService = appContainer.resolve("salesChannelService")
+        const salesChannelLocationService = appContainer.resolve(
+          "salesChannelLocationService"
+        )
+
+        const loc = await stockLocationService.create({
+          name: "warehouse",
+        })
+        const loc2 = await stockLocationService.create({
+          name: "other place",
+        })
+
+        const sc = await salesChannelService.create({ name: "Default Channel" })
+        const sc2 = await salesChannelService.create({ name: "Physical store" })
+
+        await salesChannelLocationService.associateLocation(sc.id, loc.id)
+        await salesChannelLocationService.associateLocation(sc.id, loc2.id)
+        await salesChannelLocationService.associateLocation(sc2.id, loc2.id)
+
+        const defaultSalesChannelFilterRes = await api.get(
+          `/admin/stock-locations?sales_channel_id=${sc.id}`,
+          adminHeaders
+        )
+
+        expect(defaultSalesChannelFilterRes.data.stock_locations).toHaveLength(
+          2
+        )
+        expect(defaultSalesChannelFilterRes.data.stock_locations).toEqual(
+          expect.arrayContaining([
+            expect.objectContaining({ name: "warehouse" }),
+            expect.objectContaining({ name: "other place" }),
+          ])
+        )
+
+        const physicalStoreSalesChannelFilterRes = await api.get(
+          `/admin/stock-locations?sales_channel_id=${sc2.id}`,
+          adminHeaders
+        )
+        expect(
+          physicalStoreSalesChannelFilterRes.data.stock_locations
+        ).toHaveLength(1)
+
+        expect(physicalStoreSalesChannelFilterRes.data.stock_locations).toEqual(
+          expect.arrayContaining([
+            expect.objectContaining({ name: "other place" }),
+          ])
+        )
+      })
+    })
+  })
 })

packages/medusa/src/api/routes/admin/stock-locations/list-stock-locations.ts

@@ -148,6 +148,8 @@ export default async (req: Request, res: Response) => {
   const { filterableFields, listConfig } = req
   const { skip, take } = listConfig
 
+  const filterOnSalesChannel = !!filterableFields.sales_channel_id
+
   const includeSalesChannels =
     !!listConfig.relations?.includes("sales_channels")
 
@@ -157,6 +159,18 @@ export default async (req: Request, res: Response) => {
     )
   }
 
+  if (filterOnSalesChannel) {
+    const ids: string[] = Array.isArray(filterableFields.sales_channel_id)
+      ? filterableFields.sales_channel_id
+      : [filterableFields.sales_channel_id]
+
+    delete filterableFields.sales_channel_id
+
+    const locationIds = await channelLocationService.listLocationIds(ids)
+
+    filterableFields.id = [...new Set(locationIds.flat())]
+  }
+
   let [locations, count] = await stockLocationService.listAndCount(
     filterableFields,
     listConfig
@@ -193,4 +207,8 @@ export class AdminGetStockLocationsParams extends extendedFindParamsMixin({
   @IsOptional()
   @IsType([String, [String]])
   address_id?: string | string[]
+
+  @IsOptional()
+  @IsType([String, [String]])
+  sales_channel_id?: string | string[]
 }

packages/medusa/src/services/sales-channel-location.ts

@@ -1,8 +1,9 @@
-import { EntityManager } from "typeorm"
+import { EntityManager, In } from "typeorm"
 import { IStockLocationService, TransactionBaseService } from "../interfaces"
 import { EventBusService, SalesChannelService } from "./"
 
 import { SalesChannelLocation } from "../models/sales-channel-location"
+import { MedusaError } from "medusa-core-utils"
 
 type InjectedDependencies = {
   stockLocationService: IStockLocationService
@@ -97,13 +98,24 @@ class SalesChannelLocationService extends TransactionBaseService {
    * @param salesChannelId - The ID of the sales channel.
    * @returns A promise that resolves with an array of location IDs.
    */
-  async listLocationIds(salesChannelId: string): Promise<string[]> {
+  async listLocationIds(salesChannelId: string | string[]): Promise<string[]> {
-    const salesChannel = await this.salesChannelService_
+    const ids = Array.isArray(salesChannelId)
+      ? salesChannelId
+      : [salesChannelId]
+
+    const [salesChannels, count] = await this.salesChannelService_
       .withTransaction(this.activeManager_)
-      .retrieve(salesChannelId)
+      .listAndCount({ id: ids }, { select: ["id"], skip: 0 })
+
+    if (!count) {
+      throw new MedusaError(
+        MedusaError.Types.NOT_FOUND,
+        `Sales channel with id: ${ids.join(", ")} was not found`
+      )
+    }
 
     const locations = await this.activeManager_.find(SalesChannelLocation, {
-      where: { sales_channel_id: salesChannel.id },
+      where: { sales_channel_id: In(salesChannels.map((sc) => sc.id)) },
       select: ["location_id"],
     })