asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

chore(docs): Generated Services Reference (automated) (#2993)

Browse Source 
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2023-01-11 18:08:25 +02:00
committed by GitHub
parent 6dafb51547
commit f521260a8f
60 changed files with 2600 additions and 1647 deletions
Download Patch File Download Diff File Expand all files Collapse all files

82
docs/content/references/services/classes/SalesChannelInventoryService.md Normal file
View File

@@ -0,0 +1,82 @@
# Class: SalesChannelInventoryService
## Constructors
### constructor
• **new SalesChannelInventoryService**(`__namedParameters`)
#### Parameters
| Name | Type |
| :------ | :------ |
| `__namedParameters` | `InjectedDependencies` |
#### Defined in
[packages/medusa/src/services/sales-channel-inventory.ts:21](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/sales-channel-inventory.ts#L21)
## Properties
### eventBusService\_
• `Protected` `Readonly` **eventBusService\_**: [`EventBusService`](EventBusService.md)
#### Defined in
[packages/medusa/src/services/sales-channel-inventory.ts:18](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/sales-channel-inventory.ts#L18)
___
### inventoryService\_
• `Protected` `Readonly` **inventoryService\_**: `IInventoryService`
#### Defined in
[packages/medusa/src/services/sales-channel-inventory.ts:19](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/sales-channel-inventory.ts#L19)
___
### manager\_
• `Protected` **manager\_**: `EntityManager`
#### Defined in
[packages/medusa/src/services/sales-channel-inventory.ts:15](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/sales-channel-inventory.ts#L15)
___
### salesChannelLocationService\_
• `Protected` `Readonly` **salesChannelLocationService\_**: [`SalesChannelLocationService`](SalesChannelLocationService.md)
#### Defined in
[packages/medusa/src/services/sales-channel-inventory.ts:17](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/sales-channel-inventory.ts#L17)
## Methods
### retrieveAvailableItemQuantity
▸ **retrieveAvailableItemQuantity**(`salesChannelId`, `itemId`): `Promise`<`number`\>
Retrieves the available quantity of an item across all sales channel locations
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `salesChannelId` | `string` | Sales channel id |
| `itemId` | `string` | Item id |
#### Returns
`Promise`<`number`\>
available quantity of item across all sales channel locations
#### Defined in
[packages/medusa/src/services/sales-channel-inventory.ts:39](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/sales-channel-inventory.ts#L39)