asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity
Files
6721633478294edcf3b6b5d2abcdcceb3f30bb08
medusa-store/www/apps/docs/content/references/services/classes/services.SalesChannelService.mdx
github-actions[bot] 6721633478 chore(docs): Generated References (#6042) 
Generated the following references:
- `entities`
- `fulfillment`
- `inventory`
- `js_client`
- `medusa`
- `medusa_react`
- `modules`
- `payment`
- `pricing`
- `product`
- `services`
- `stock_location`
- `types`
- `workflows`

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2024-01-10 09:25:11 +00:00

254 lines
14 KiB
Plaintext
Raw Blame History

---
displayed_sidebar: servicesSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# SalesChannelService
## constructor
### Parameters
<ParameterTypes parameters={[{"name":"__namedParameters","type":"`InjectedDependencies`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
___
## Properties
<ParameterTypes parameters={[{"name":"__container__","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"eventBusService_","type":"[EventBusService](services.EventBusService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"featureFlagRouter_","type":"`FlagRouter`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"manager_","type":"`EntityManager`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"salesChannelRepository_","type":"Repository&#60;[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)&#62; & `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"storeService_","type":"[StoreService](services.StoreService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionManager_","type":"`undefined` \\| `EntityManager`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"Events","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"Events.CREATED","type":"`string`","description":"","optional":false,"defaultValue":"\"sales_channel.created\"","expandable":false,"children":[]},{"name":"Events.DELETED","type":"`string`","description":"","optional":false,"defaultValue":"\"sales_channel.deleted\"","expandable":false,"children":[]},{"name":"Events.UPDATED","type":"`string`","description":"","optional":false,"defaultValue":"\"sales_channel.updated\"","expandable":false,"children":[]},{"name":"__configModule__","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"__moduleDeclaration__","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
___
## Accessors
### activeManager\_
#### Returns
<ParameterTypes parameters={[{"name":"EntityManager","type":"`EntityManager`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
## Methods
### addProducts
Add a batch of product to a sales channel
#### Parameters
<ParameterTypes parameters={[{"name":"salesChannelId","type":"`string`","description":"The id of the sales channel on which to add the products","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"productIds","type":"`string`[]","description":"The products ids to attach to the sales channel","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)&#62;","optional":false,"defaultValue":"","description":"the sales channel on which the products have been added","expandable":false,"children":[]}]} />
___
### atomicPhase\_
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.
#### Type Parameters
<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&#60;TResult&#62;","description":"the transactional work to be done","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationOrErrorHandler","type":"`IsolationLevel` \\| (`error`: TError) => Promise&#60;void \\| TResult&#62;","description":"the isolation level to be used for the work.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"maybeErrorHandlerOrDontFail","type":"(`error`: TError) => Promise&#60;void \\| TResult&#62;","description":"Potential error handler","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;TResult&#62;","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
___
### create
Creates a SalesChannel
This feature is under development and may change in the future.
To use this feature please enable the corresponding feature flag in your medusa backend project.
#### Parameters
<ParameterTypes parameters={[{"name":"data","type":"`CreateSalesChannelInput`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)&#62;","optional":false,"defaultValue":"","description":"the created channel","expandable":false,"children":[]}]} />
___
### createDefault
Creates a default sales channel, if this does not already exist.
#### Returns
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)&#62;","optional":false,"defaultValue":"","description":"the sales channel","expandable":false,"children":[]}]} />
___
### delete
Deletes a sales channel from
This feature is under development and may change in the future.
To use this feature please enable the corresponding feature flag in your medusa backend project.
#### Parameters
<ParameterTypes parameters={[{"name":"salesChannelId","type":"`string`","description":"the id of the sales channel to delete","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;void&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
### list
Lists sales channels based on the provided parameters.
#### Parameters
<ParameterTypes parameters={[{"name":"selector","type":"[QuerySelector](../../medusa/types/medusa.QuerySelector.mdx)&#60;[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]&#62;","optional":false,"defaultValue":"","description":"an array containing the sales channels","expandable":false,"children":[]}]} />
___
### listAndCount
Lists sales channels based on the provided parameters and include the count of
sales channels that match the query.
#### Parameters
<ParameterTypes parameters={[{"name":"selector","type":"[QuerySelector](../../medusa/types/medusa.QuerySelector.mdx)&#60;[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[], number]&#62;","optional":false,"defaultValue":"","description":"an array containing the sales channels as\n the first element and the total count of sales channels that matches the query\n as the second element.","expandable":false,"children":[]}]} />
___
### listProductIdsBySalesChannelIds
List all product ids that belongs to the sales channels ids
#### Parameters
<ParameterTypes parameters={[{"name":"salesChannelIds","type":"`string` \\| `string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;object&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
### removeProducts
Remove a batch of product from a sales channel
#### Parameters
<ParameterTypes parameters={[{"name":"salesChannelId","type":"`string`","description":"The id of the sales channel on which to remove the products","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"productIds","type":"`string`[]","description":"The products ids to remove from the sales channel","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)&#62;","optional":false,"defaultValue":"","description":"the sales channel on which the products have been removed","expandable":false,"children":[]}]} />
___
### retrieve
Retrieve a SalesChannel by id
#### Parameters
<ParameterTypes parameters={[{"name":"salesChannelId","type":"`string`","description":"id of the channel to retrieve","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)&#62;","description":"SC config\n This feature is under development and may change in the future.\nTo use this feature please enable the corresponding feature flag in your medusa backend project.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)&#62;","optional":false,"defaultValue":"","description":"a sales channel","expandable":false,"children":[]}]} />
___
### retrieveByName
Find a sales channel by name.
#### Parameters
<ParameterTypes parameters={[{"name":"name","type":"`string`","description":"of the sales channel","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)&#62;","description":"find config","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;unknown&#62;","optional":false,"defaultValue":"","description":"a sales channel with matching name","expandable":false,"children":[]}]} />
___
### retrieveDefault
Retrieves the default sales channel.
#### Returns
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)&#62;","optional":false,"defaultValue":"","description":"the sales channel","expandable":false,"children":[]}]} />
___
### retrieve\_
A generic retrieve used to find a sales channel by different attributes.
#### Parameters
<ParameterTypes parameters={[{"name":"selector","type":"[Selector](../../medusa/types/medusa.Selector.mdx)&#60;[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)&#62;","description":"SC selector","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)&#62;","description":"find config","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)&#62;","optional":false,"defaultValue":"","description":"a single SC matching the query or throws","expandable":false,"children":[]}]} />
___
### shouldRetryTransaction\_
#### Parameters
<ParameterTypes parameters={[{"name":"err","type":"`Record<string, unknown>` \\| `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
### update
#### Parameters
<ParameterTypes parameters={[{"name":"salesChannelId","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"Partial&#60;CreateSalesChannelInput&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
### withTransaction
#### Parameters
<ParameterTypes parameters={[{"name":"transactionManager","type":"`EntityManager`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[{"name":"this","type":"`this`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
Reference in New Issue View Git Blame Copy Permalink