medusa-store/www/apps/docs/content/references/services/classes/SalesChannelLocationService.mdx

---
displayed_sidebar: servicesSidebar
---

import ParameterTypes from "@site/src/components/ParameterTypes"

# SalesChannelLocationService

Service for managing the stock locations of sales channels

## Constructors

### constructor

**new SalesChannelLocationService**(`«destructured»`)

#### Parameters

<ParameterTypes parameters={[
  {
    "name": "__namedParameters",
    "type": "[`InjectedDependencies`](../types/InjectedDependencies-35.mdx)",
    "description": "",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  }
]} />

## Properties

<ParameterTypes parameters={[
  {
    "name": "__configModule__",
    "type": "Record<`string`, `unknown`\\>",
    "description": "",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "__container__",
    "type": "`any`",
    "description": "",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "__moduleDeclaration__",
    "type": "Record<`string`, `unknown`\\>",
    "description": "",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "eventBusService_",
    "type": "[`IEventBusService`](../interfaces/IEventBusService.mdx)",
    "description": "",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "manager_",
    "type": "`EntityManager`",
    "description": "",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "salesChannelService_",
    "type": "[`SalesChannelService`](SalesChannelService.mdx)",
    "description": "",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "transactionManager_",
    "type": "`undefined` \\| `EntityManager`",
    "description": "",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  }
]} />

## Accessors

### activeManager\_

`Protected` `get` **activeManager_**(): `EntityManager`

#### Returns

`EntityManager`

<ParameterTypes parameters={[
  {
    "name": "EntityManager",
    "type": "`EntityManager`",
    "optional": false,
    "defaultValue": "",
    "description": "",
    "expandable": false,
    "children": []
  }
]} />

___

### stockLocationService\_

`Protected` `get` **stockLocationService_**(): [`IStockLocationService`](../interfaces/IStockLocationService.mdx)

#### Returns

[`IStockLocationService`](../interfaces/IStockLocationService.mdx)

<ParameterTypes parameters={[
  {
    "name": "__joinerConfig",
    "type": "() => [`ModuleJoinerConfig`](../types/ModuleJoinerConfig.mdx)",
    "description": "",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "create",
    "type": "(`input`: [`CreateStockLocationInput`](../types/CreateStockLocationInput.mdx), `context?`: [`SharedContext`](../types/SharedContext.mdx)) => `Promise`<[`StockLocationDTO`](../types/StockLocationDTO.mdx)\\>",
    "description": "",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "delete",
    "type": "(`id`: `string`, `context?`: [`SharedContext`](../types/SharedContext.mdx)) => `Promise`<`void`\\>",
    "description": "",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "list",
    "type": "(`selector`: [`FilterableStockLocationProps`](../types/FilterableStockLocationProps.mdx), `config?`: [`FindConfig`](../interfaces/FindConfig-1.mdx)<[`StockLocationDTO`](../types/StockLocationDTO.mdx)\\>, `context?`: [`SharedContext`](../types/SharedContext.mdx)) => `Promise`<[`StockLocationDTO`](../types/StockLocationDTO.mdx)[]\\>",
    "description": "",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "listAndCount",
    "type": "(`selector`: [`FilterableStockLocationProps`](../types/FilterableStockLocationProps.mdx), `config?`: [`FindConfig`](../interfaces/FindConfig-1.mdx)<[`StockLocationDTO`](../types/StockLocationDTO.mdx)\\>, `context?`: [`SharedContext`](../types/SharedContext.mdx)) => `Promise`<[[`StockLocationDTO`](../types/StockLocationDTO.mdx)[], `number`]\\>",
    "description": "",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "retrieve",
    "type": "(`id`: `string`, `config?`: [`FindConfig`](../interfaces/FindConfig-1.mdx)<[`StockLocationDTO`](../types/StockLocationDTO.mdx)\\>, `context?`: [`SharedContext`](../types/SharedContext.mdx)) => `Promise`<[`StockLocationDTO`](../types/StockLocationDTO.mdx)\\>",
    "description": "",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "update",
    "type": "(`id`: `string`, `input`: [`UpdateStockLocationInput`](../types/UpdateStockLocationInput.mdx), `context?`: [`SharedContext`](../types/SharedContext.mdx)) => `Promise`<[`StockLocationDTO`](../types/StockLocationDTO.mdx)\\>",
    "description": "",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  }
]} />

## Methods

### associateLocation

**associateLocation**(`salesChannelId`, `locationId`): `Promise`<`void`\>

Associates a sales channel with a stock location.

#### Parameters

<ParameterTypes parameters={[
  {
    "name": "salesChannelId",
    "type": "`string`",
    "description": "The ID of the sales channel.",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "locationId",
    "type": "`string`",
    "description": "The ID of the stock location.",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  }
]} />

#### Returns

`Promise`<`void`\>

<ParameterTypes parameters={[
  {
    "name": "Promise",
    "type": "`Promise`<`void`\\>",
    "optional": false,
    "defaultValue": "",
    "description": "A promise that resolves when the association has been created.",
    "expandable": false,
    "children": []
  }
]} />

___

### atomicPhase\_

`Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\>

Wraps some work within a transactional block. If the service already has
a transaction manager attached this will be reused, otherwise a new
transaction manager is created.

<ParameterTypes parameters={[
  {
    "name": "TResult",
    "type": "`object`",
    "description": "",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "TError",
    "type": "`object`",
    "description": "",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  }
]} />

#### Parameters

<ParameterTypes parameters={[
  {
    "name": "work",
    "type": "(`transactionManager`: `EntityManager`) => `Promise`<`TResult`\\>",
    "description": "the transactional work to be done",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "isolationOrErrorHandler",
    "type": "`IsolationLevel` \\| (`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>",
    "description": "the isolation level to be used for the work.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "maybeErrorHandlerOrDontFail",
    "type": "(`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>",
    "description": "Potential error handler",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  }
]} />

#### Returns

`Promise`<`TResult`\>

<ParameterTypes parameters={[
  {
    "name": "Promise",
    "type": "`Promise`<`TResult`\\>",
    "optional": false,
    "defaultValue": "",
    "description": "the result of the transactional work",
    "expandable": false,
    "children": []
  }
]} />

___

### listLocationIds

**listLocationIds**(`salesChannelId`): `Promise`<`string`[]\>

Lists the stock locations associated with a sales channel.

#### Parameters

<ParameterTypes parameters={[
  {
    "name": "salesChannelId",
    "type": "`string` \\| `string`[]",
    "description": "The ID of the sales channel.",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  }
]} />

#### Returns

`Promise`<`string`[]\>

<ParameterTypes parameters={[
  {
    "name": "Promise",
    "type": "`Promise`<`string`[]\\>",
    "optional": false,
    "defaultValue": "",
    "description": "A promise that resolves with an array of location IDs.",
    "expandable": false,
    "children": []
  }
]} />

___

### listSalesChannelIds

**listSalesChannelIds**(`locationId`): `Promise`<`string`[]\>

Lists the sales channels associated with a stock location.

#### Parameters

<ParameterTypes parameters={[
  {
    "name": "locationId",
    "type": "`string`",
    "description": "",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  }
]} />

#### Returns

`Promise`<`string`[]\>

<ParameterTypes parameters={[
  {
    "name": "Promise",
    "type": "`Promise`<`string`[]\\>",
    "optional": false,
    "defaultValue": "",
    "description": "A promise that resolves with an array of sales channel IDs.",
    "expandable": false,
    "children": []
  }
]} />

___

### removeLocation

**removeLocation**(`locationId`, `salesChannelId?`): `Promise`<`void`\>

Removes an association between a sales channel and a stock location.

#### Parameters

<ParameterTypes parameters={[
  {
    "name": "locationId",
    "type": "`string`",
    "description": "The ID of the stock location.",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "salesChannelId",
    "type": "`string`",
    "description": "The ID of the sales channel or undefined if all the sales channel will be affected.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  }
]} />

#### Returns

`Promise`<`void`\>

<ParameterTypes parameters={[
  {
    "name": "Promise",
    "type": "`Promise`<`void`\\>",
    "optional": false,
    "defaultValue": "",
    "description": "A promise that resolves when the association has been removed.",
    "expandable": false,
    "children": []
  }
]} />

___

### shouldRetryTransaction\_

`Protected` **shouldRetryTransaction_**(`err`): `boolean`

#### Parameters

<ParameterTypes parameters={[
  {
    "name": "err",
    "type": "Record<`string`, `unknown`\\> \\| { `code`: `string`  }",
    "description": "",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  }
]} />

#### Returns

`boolean`

<ParameterTypes parameters={[
  {
    "name": "boolean",
    "type": "`boolean`",
    "optional": true,
    "defaultValue": "",
    "description": "",
    "expandable": false,
    "children": []
  }
]} />

___

### withTransaction

**withTransaction**(`transactionManager?`): [`SalesChannelLocationService`](SalesChannelLocationService.mdx)

#### Parameters

<ParameterTypes parameters={[
  {
    "name": "transactionManager",
    "type": "`EntityManager`",
    "description": "",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  }
]} />

#### Returns

[`SalesChannelLocationService`](SalesChannelLocationService.mdx)

<ParameterTypes parameters={[
  {
    "name": "SalesChannelLocationService",
    "type": "[`SalesChannelLocationService`](SalesChannelLocationService.mdx)",
    "optional": false,
    "defaultValue": "",
    "description": "",
    "expandable": false,
    "children": []
  }
]} />