IStockLocationService

Methods

create

**create**(input, context?): Promise<[StockLocationDTO](/references/services/types/StockLocationDTO)>

This method is used to create a stock location.

Example

import {
  initialize as initializeStockLocationModule,
} from "@medusajs/stock-location"

async function createStockLocation (name: string) {
  const stockLocationModule = await initializeStockLocationModule({})

  const stockLocation = await stockLocationModule.create({
    name
  })

  // do something with the stock location or return it
}

Parameters

inputCreateStockLocationInputRequired

The details of the stock location to create.

contextSharedContext

A context used to share resources, such as transaction manager, between the application and the module.

Returns

Promise<StockLocationDTO>

PromisePromise<StockLocationDTO>Required

The created stock location's details.

---

delete

**delete**(id, context?): Promise<void>

This method is used to delete a stock location.

Example

import {
  initialize as initializeStockLocationModule,
} from "@medusajs/stock-location"

async function deleteStockLocation (id:string) {
  const stockLocationModule = await initializeStockLocationModule({})

  await stockLocationModule.delete(id)
}

Parameters

idstringRequired

The ID of the stock location.

contextSharedContext

A context used to share resources, such as transaction manager, between the application and the module.

Returns

Promise<void>

PromisePromise<void>Required

Resolves when the stock location is successfully deleted.

---

list

**list**(selector, config?, context?): Promise<[StockLocationDTO](/references/services/types/StockLocationDTO)[]>

This method is used to retrieve a paginated list of stock locations based on optional filters and configuration.

Example

To retrieve a list of stock locations using their IDs:

import {
  initialize as initializeStockLocationModule,
} from "@medusajs/stock-location"

async function listStockLocations (ids: string[]) {
  const stockLocationModule = await initializeStockLocationModule({})

  const stockLocations = await stockLocationModule.list({
    id: ids
  })

  // do something with the stock locations or return them
}

To specify relations that should be retrieved within the stock locations:

import {
  initialize as initializeStockLocationModule,
} from "@medusajs/stock-location"

async function listStockLocations (ids: string[]) {
  const stockLocationModule = await initializeStockLocationModule({})

  const stockLocations = await stockLocationModule.list({
    id: ids
  }, {
    relations: ["address"]
  })

  // do something with the stock locations or return them
}

By default, only the first 10 records are retrieved. You can control pagination by specifying the skip and take properties of the config parameter:

import {
  initialize as initializeStockLocationModule,
} from "@medusajs/stock-location"

async function listStockLocations (ids: string[], skip: number, take: number) {
  const stockLocationModule = await initializeStockLocationModule({})

  const stockLocations = await stockLocationModule.list({
    id: ids
  }, {
    relations: ["address"],
    skip,
    take
  })

  // do something with the stock locations or return them
}

Parameters

selectorFilterableStockLocationPropsRequired

The filters to apply on the retrieved stock locations.

configFindConfig<StockLocationDTO>

The configurations determining how the stock locations are retrieved. Its properties, such as select or relations, accept the attributes or relations associated with a stock location.

contextSharedContext

A context used to share resources, such as transaction manager, between the application and the module.

Returns

Promise<StockLocationDTO[]>

PromisePromise<StockLocationDTO[]>Required

The list of stock locations.

---

listAndCount

**listAndCount**(selector, config?, context?): Promise<[[StockLocationDTO](/references/services/types/StockLocationDTO)[], number]>

This method is used to retrieve a paginated list of stock locations along with the total count of available stock locations satisfying the provided filters.

Example

To retrieve a list of stock locations using their IDs:

import {
  initialize as initializeStockLocationModule,
} from "@medusajs/stock-location"

async function listStockLocations (ids: string[]) {
  const stockLocationModule = await initializeStockLocationModule({})

  const [stockLocations, count] = await stockLocationModule.listAndCount({
    id: ids
  })

  // do something with the stock locations or return them
}

To specify relations that should be retrieved within the stock locations:

import {
  initialize as initializeStockLocationModule,
} from "@medusajs/stock-location"

async function listStockLocations (ids: string[]) {
  const stockLocationModule = await initializeStockLocationModule({})

  const [stockLocations, count] = await stockLocationModule.listAndCount({
    id: ids
  }, {
    relations: ["address"]
  })

  // do something with the stock locations or return them
}

By default, only the first 10 records are retrieved. You can control pagination by specifying the skip and take properties of the config parameter:

import {
  initialize as initializeStockLocationModule,
} from "@medusajs/stock-location"

async function listStockLocations (ids: string[], skip: number, take: number) {
  const stockLocationModule = await initializeStockLocationModule({})

  const [stockLocations, count] = await stockLocationModule.listAndCount({
    id: ids
  }, {
    relations: ["address"],
    skip,
    take
  })

  // do something with the stock locations or return them
}

Parameters

selectorFilterableStockLocationPropsRequired

The filters to apply on the retrieved stock locations.

configFindConfig<StockLocationDTO>

The configurations determining how the stock locations are retrieved. Its properties, such as select or relations, accept the attributes or relations associated with a stock location.

contextSharedContext

A context used to share resources, such as transaction manager, between the application and the module.

Returns

Promise<[StockLocationDTO[], number]>

PromisePromise<[StockLocationDTO[], number]>Required

The list of stock locations along with the total count.

---

retrieve

**retrieve**(id, config?, context?): Promise<[StockLocationDTO](/references/services/types/StockLocationDTO)>

This method is used to retrieve a stock location by its ID

Example

A simple example that retrieves a inventory item by its ID:

import {
  initialize as initializeStockLocationModule,
} from "@medusajs/stock-location"

async function retrieveStockLocation (id: string) {
  const stockLocationModule = await initializeStockLocationModule({})

  const stockLocation = await stockLocationModule.retrieve(id)

  // do something with the stock location or return it
}

To specify relations that should be retrieved:

import {
  initialize as initializeStockLocationModule,
} from "@medusajs/stock-location"

async function retrieveStockLocation (id: string) {
  const stockLocationModule = await initializeStockLocationModule({})

  const stockLocation = await stockLocationModule.retrieve(id, {
    relations: ["address"]
  })

  // do something with the stock location or return it
}

Parameters

idstringRequired

The ID of the stock location

configFindConfig<StockLocationDTO>

The configurations determining how the stock location is retrieved. Its properties, such as select or relations, accept the attributes or relations associated with a stock location.

contextSharedContext

A context used to share resources, such as transaction manager, between the application and the module.

Returns

Promise<StockLocationDTO>

PromisePromise<StockLocationDTO>Required

The stock location's details.

---

update

**update**(id, input, context?): Promise<[StockLocationDTO](/references/services/types/StockLocationDTO)>

This method is used to update a stock location.

Example

import {
  initialize as initializeStockLocationModule,
} from "@medusajs/stock-location"

async function updateStockLocation (id:string, name: string) {
  const stockLocationModule = await initializeStockLocationModule({})

  const stockLocation = await stockLocationModule.update(id, {
    name
  })

  // do something with the stock location or return it
}

Parameters

idstringRequired

The ID of the stock location.

inputUpdateStockLocationInputRequired

The attributes to update in the stock location.

contextSharedContext

A context used to share resources, such as transaction manager, between the application and the module.

Returns

Promise<StockLocationDTO>

PromisePromise<StockLocationDTO>Required

The stock location's details.