@vendure/docs 0.0.0-202601161541

package/docs/reference/typescript-api/payment/refund-transition-data.md

@@ -0,0 +1,41 @@
+---
+title: "RefundTransitionData"
+generated: true
+---
+<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
+
+
+## RefundTransitionData
+
+<GenerationInfo sourceFile="packages/core/src/service/helpers/refund-state-machine/refund-state.ts" sourceLine="35" packageName="@vendure/core" />
+
+The data which is passed to the state transition handler of the RefundStateMachine.
+
+```ts title="Signature"
+interface RefundTransitionData {
+    ctx: RequestContext;
+    order: Order;
+    refund: Refund;
+}
+```
+
+<div className="members-wrapper">
+
+### ctx
+
+<MemberInfo kind="property" type={`<a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>`}   />
+
+
+### order
+
+<MemberInfo kind="property" type={`<a href='/reference/typescript-api/entities/order#order'>Order</a>`}   />
+
+
+### refund
+
+<MemberInfo kind="property" type={`<a href='/reference/typescript-api/entities/refund#refund'>Refund</a>`}   />
+
+
+
+
+</div>

package/docs/reference/typescript-api/plugin/index.md

@@ -0,0 +1,5 @@
+---
+title: "Plugin"
+generated: true
+---
+<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->

package/docs/reference/typescript-api/plugin/plugin-common-module.md

@@ -0,0 +1,28 @@
+---
+title: "PluginCommonModule"
+generated: true
+---
+<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
+
+
+## PluginCommonModule
+
+<GenerationInfo sourceFile="packages/core/src/plugin/plugin-common.module.ts" sourceLine="30" packageName="@vendure/core" />
+
+This module provides the common services, configuration, and event bus capabilities
+required by a typical plugin. It should be imported into plugins to avoid having to
+repeat the same boilerplate for each individual plugin.
+
+The PluginCommonModule exports:
+
+* `EventBusModule`, allowing the injection of the <a href='/reference/typescript-api/events/event-bus#eventbus'>EventBus</a> service.
+* `ServiceModule` allowing the injection of any of the various entity services such as ProductService, OrderService etc.
+* `ConfigModule`, allowing the injection of the ConfigService.
+* `JobQueueModule`, allowing the injection of the <a href='/reference/typescript-api/job-queue/job-queue-service#jobqueueservice'>JobQueueService</a>.
+* `HealthCheckModule`, allowing the injection of the <a href='/reference/typescript-api/health-check/health-check-registry-service#healthcheckregistryservice'>HealthCheckRegistryService</a>.
+
+```ts title="Signature"
+class PluginCommonModule {
+
+}
+```

package/docs/reference/typescript-api/plugin/plugin-utilities.md

@@ -0,0 +1,96 @@
+---
+title: "Plugin Utilities"
+generated: true
+---
+<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
+
+
+## createProxyHandler
+
+<GenerationInfo sourceFile="packages/core/src/plugin/plugin-utils.ts" sourceLine="37" packageName="@vendure/core" />
+
+Creates a proxy middleware which proxies the given route to the given port.
+Useful for plugins which start their own servers but should be accessible
+via the main Vendure url.
+
+*Example*
+
+```ts
+// Example usage in the `configuration` method of a VendurePlugin.
+// Imagine that we have started a Node server on port 5678
+// running some service which we want to access via the `/my-plugin/`
+// route of the main Vendure server.
+@VendurePlugin({
+  configuration: (config: Required<VendureConfig>) => {
+      config.apiOptions.middleware.push({
+          handler: createProxyHandler({
+              label: 'Admin UI',
+              route: 'my-plugin',
+              port: 5678,
+          }),
+          route: 'my-plugin',
+      });
+      return config;
+  }
+})
+export class MyPlugin {}
+```
+
+```ts title="Signature"
+function createProxyHandler(options: ProxyOptions): RequestHandler
+```
+Parameters
+
+### options
+
+<MemberInfo kind="parameter" type={`<a href='/reference/typescript-api/plugin/plugin-utilities#proxyoptions'>ProxyOptions</a>`} />
+
+
+
+## ProxyOptions
+
+<GenerationInfo sourceFile="packages/core/src/plugin/plugin-utils.ts" sourceLine="74" packageName="@vendure/core" />
+
+Options to configure proxy middleware via <a href='/reference/typescript-api/plugin/plugin-utilities#createproxyhandler'>createProxyHandler</a>.
+
+```ts title="Signature"
+interface ProxyOptions {
+    label: string;
+    route: string;
+    port: number;
+    hostname?: string;
+    basePath?: string;
+}
+```
+
+<div className="members-wrapper">
+
+### label
+
+<MemberInfo kind="property" type={`string`}   />
+
+A human-readable label for the service which is being proxied. Used to
+generate more informative logs.
+### route
+
+<MemberInfo kind="property" type={`string`}   />
+
+The route of the Vendure server which will act as the proxy url.
+### port
+
+<MemberInfo kind="property" type={`number`}   />
+
+The port on which the service being proxied is running.
+### hostname
+
+<MemberInfo kind="property" type={`string`} default={`'localhost'`}   />
+
+The hostname of the server on which the service being proxied is running.
+### basePath
+
+<MemberInfo kind="property" type={`string`}   />
+
+An optional base path on the proxied server.
+
+
+</div>

package/docs/reference/typescript-api/plugin/vendure-plugin-metadata.md

@@ -0,0 +1,147 @@
+---
+title: "VendurePluginMetadata"
+generated: true
+---
+<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
+
+
+## VendurePluginMetadata
+
+<GenerationInfo sourceFile="packages/core/src/plugin/vendure-plugin.ts" sourceLine="23" packageName="@vendure/core" />
+
+Defines the metadata of a Vendure plugin. This interface is an superset of the [Nestjs ModuleMetadata](https://docs.nestjs.com/modules)
+(which allows the definition of `imports`, `exports`, `providers` and `controllers`), which means
+that any Nestjs Module is a valid Vendure plugin. In addition, the VendurePluginMetadata allows the definition of
+extra properties specific to Vendure.
+
+```ts title="Signature"
+interface VendurePluginMetadata extends ModuleMetadata {
+    configuration?: PluginConfigurationFn;
+    shopApiExtensions?: APIExtensionDefinition;
+    adminApiExtensions?: APIExtensionDefinition;
+    entities?: Array<Type<any>> | (() => Array<Type<any>>);
+    dashboard?: DashboardExtension;
+    compatibility?: string;
+}
+```
+* Extends: <code>ModuleMetadata</code>
+
+
+
+<div className="members-wrapper">
+
+### configuration
+
+<MemberInfo kind="property" type={`<a href='/reference/typescript-api/plugin/vendure-plugin-metadata#pluginconfigurationfn'>PluginConfigurationFn</a>`}   />
+
+A function which can modify the <a href='/reference/typescript-api/configuration/vendure-config#vendureconfig'>VendureConfig</a> object before the server bootstraps.
+### shopApiExtensions
+
+<MemberInfo kind="property" type={`<a href='/reference/typescript-api/plugin/vendure-plugin-metadata#apiextensiondefinition'>APIExtensionDefinition</a>`}   />
+
+The plugin may extend the default Vendure GraphQL shop api by providing extended
+schema definitions and any required resolvers.
+### adminApiExtensions
+
+<MemberInfo kind="property" type={`<a href='/reference/typescript-api/plugin/vendure-plugin-metadata#apiextensiondefinition'>APIExtensionDefinition</a>`}   />
+
+The plugin may extend the default Vendure GraphQL admin api by providing extended
+schema definitions and any required resolvers.
+### entities
+
+<MemberInfo kind="property" type={`Array&#60;Type&#60;any&#62;&#62; | (() =&#62; Array&#60;Type&#60;any&#62;&#62;)`}   />
+
+The plugin may define custom [TypeORM database entities](https://typeorm.io/#/entities).
+### dashboard
+
+<MemberInfo kind="property" type={`DashboardExtension`}   />
+
+
+### compatibility
+
+<MemberInfo kind="property" type={`string`}  since="2.0.0"  />
+
+The plugin should define a valid [semver version string](https://www.npmjs.com/package/semver) to indicate which versions of
+Vendure core it is compatible with. Attempting to use a plugin with an incompatible
+version of Vendure will result in an error and the server will be unable to bootstrap.
+
+If a plugin does not define this property, a message will be logged on bootstrap that the plugin is not
+guaranteed to be compatible with the current version of Vendure.
+
+To effectively disable this check for a plugin, you can use an overly-permissive string such as `>0.0.0`.
+
+:::note
+Since Vendure v3.1.0, it is possible to ignore compatibility errors for specific plugins by
+passing the `ignoreCompatibilityErrorsForPlugins` option to the <a href='/reference/typescript-api/common/bootstrap#bootstrap'>bootstrap</a> function.
+:::
+
+*Example*
+
+```ts
+compatibility: '^3.0.0'
+```
+
+
+</div>
+
+
+## APIExtensionDefinition
+
+<GenerationInfo sourceFile="packages/core/src/plugin/vendure-plugin.ts" sourceLine="80" packageName="@vendure/core" />
+
+An object which allows a plugin to extend the Vendure GraphQL API.
+
+```ts title="Signature"
+interface APIExtensionDefinition {
+    schema?: DocumentNode | ((schema?: GraphQLSchema) => DocumentNode | undefined);
+    resolvers?: Array<Type<any>> | (() => Array<Type<any>>);
+    scalars?: Record<string, GraphQLScalarType> | (() => Record<string, GraphQLScalarType>);
+}
+```
+
+<div className="members-wrapper">
+
+### schema
+
+<MemberInfo kind="property" type={`DocumentNode | ((schema?: GraphQLSchema) =&#62; DocumentNode | undefined)`}   />
+
+Extensions to the schema.
+Passes the current schema as an optional argument, allowing the extension to be based on the existing schema.
+
+*Example*
+
+```ts
+const schema = gql`extend type SearchReindexResponse {
+    timeTaken: Int!
+    indexedItemCount: Int!
+}`;
+```
+### resolvers
+
+<MemberInfo kind="property" type={`Array&#60;Type&#60;any&#62;&#62; | (() =&#62; Array&#60;Type&#60;any&#62;&#62;)`}   />
+
+An array of resolvers for the schema extensions. Should be defined as [Nestjs GraphQL resolver](https://docs.nestjs.com/graphql/resolvers-map)
+classes, i.e. using the Nest `@Resolver()` decorator etc.
+### scalars
+
+<MemberInfo kind="property" type={`Record&#60;string, GraphQLScalarType&#62; | (() =&#62; Record&#60;string, GraphQLScalarType&#62;)`}  since="1.7.0"  />
+
+A map of GraphQL scalar types which should correspond to any custom scalars defined in your schema.
+Read more about defining custom scalars in the
+[Apollo Server Custom Scalars docs](https://www.apollographql.com/docs/apollo-server/schema/custom-scalars)
+
+
+</div>
+
+
+## PluginConfigurationFn
+
+<GenerationInfo sourceFile="packages/core/src/plugin/vendure-plugin.ts" sourceLine="119" packageName="@vendure/core" />
+
+This method is called before the app bootstraps and should be used to perform any needed modifications to the <a href='/reference/typescript-api/configuration/vendure-config#vendureconfig'>VendureConfig</a>.
+
+```ts title="Signature"
+type PluginConfigurationFn = (
+    config: RuntimeVendureConfig,
+) => RuntimeVendureConfig | Promise<RuntimeVendureConfig>
+```

package/docs/reference/typescript-api/plugin/vendure-plugin.md

@@ -0,0 +1,52 @@
+---
+title: "VendurePlugin"
+generated: true
+---
+<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
+
+
+## VendurePlugin
+
+<GenerationInfo sourceFile="packages/core/src/plugin/vendure-plugin.ts" sourceLine="164" packageName="@vendure/core" />
+
+The VendurePlugin decorator is a means of configuring and/or extending the functionality of the Vendure server. A Vendure plugin is
+a [Nestjs Module](https://docs.nestjs.com/modules), with optional additional metadata defining things like extensions to the GraphQL API, custom
+configuration or new database entities.
+
+As well as configuring the app, a plugin may also extend the GraphQL schema by extending existing types or adding
+entirely new types. Database entities and resolvers can also be defined to handle the extended GraphQL types.
+
+*Example*
+
+```ts
+import { Controller, Get } from '@nestjs/common';
+import { Ctx, PluginCommonModule, ProductService, RequestContext, VendurePlugin } from '@vendure/core';
+
+@Controller('products')
+export class ProductsController {
+    constructor(private productService: ProductService) {}
+
+    @Get()
+    findAll(@Ctx() ctx: RequestContext) {
+        return this.productService.findAll(ctx);
+    }
+}
+
+
+//A simple plugin which adds a REST endpoint for querying products.
+@VendurePlugin({
+    imports: [PluginCommonModule],
+    controllers: [ProductsController],
+})
+export class RestPlugin {}
+```
+
+```ts title="Signature"
+function VendurePlugin(pluginMetadata: VendurePluginMetadata): ClassDecorator
+```
+Parameters
+
+### pluginMetadata
+
+<MemberInfo kind="parameter" type={`<a href='/reference/typescript-api/plugin/vendure-plugin-metadata#vendurepluginmetadata'>VendurePluginMetadata</a>`} />
+

package/docs/reference/typescript-api/products-stock/catalog-options.md

@@ -0,0 +1,70 @@
+---
+title: "CatalogOptions"
+generated: true
+---
+<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
+
+
+## CatalogOptions
+
+<GenerationInfo sourceFile="packages/core/src/config/vendure-config.ts" sourceLine="722" packageName="@vendure/core" />
+
+Options related to products and collections.
+
+```ts title="Signature"
+interface CatalogOptions {
+    collectionFilters?: Array<CollectionFilter<any>>;
+    productVariantPriceSelectionStrategy?: ProductVariantPriceSelectionStrategy;
+    productVariantPriceCalculationStrategy?: ProductVariantPriceCalculationStrategy;
+    productVariantPriceUpdateStrategy?: ProductVariantPriceUpdateStrategy;
+    stockDisplayStrategy?: StockDisplayStrategy;
+    stockLocationStrategy?: StockLocationStrategy;
+}
+```
+
+<div className="members-wrapper">
+
+### collectionFilters
+
+<MemberInfo kind="property" type={`Array&#60;<a href='/reference/typescript-api/configuration/collection-filter#collectionfilter'>CollectionFilter</a>&#60;any&#62;&#62;`} default={`defaultCollectionFilters`}   />
+
+Allows custom <a href='/reference/typescript-api/configuration/collection-filter#collectionfilter'>CollectionFilter</a>s to be defined.
+### productVariantPriceSelectionStrategy
+
+<MemberInfo kind="property" type={`<a href='/reference/typescript-api/configuration/product-variant-price-selection-strategy#productvariantpriceselectionstrategy'>ProductVariantPriceSelectionStrategy</a>`} default={`<a href='/reference/typescript-api/configuration/product-variant-price-selection-strategy#defaultproductvariantpriceselectionstrategy'>DefaultProductVariantPriceSelectionStrategy</a>`}  since="2.0.0"  />
+
+Defines the strategy used to select the price of a ProductVariant, based on factors
+such as the active Channel and active CurrencyCode.
+### productVariantPriceCalculationStrategy
+
+<MemberInfo kind="property" type={`<a href='/reference/typescript-api/products-stock/product-variant-price-calculation-strategy#productvariantpricecalculationstrategy'>ProductVariantPriceCalculationStrategy</a>`} default={`DefaultTaxCalculationStrategy`}   />
+
+Defines the strategy used for calculating the price of ProductVariants based
+on the Channel settings and active tax Zone.
+### productVariantPriceUpdateStrategy
+
+<MemberInfo kind="property" type={`<a href='/reference/typescript-api/configuration/product-variant-price-update-strategy#productvariantpriceupdatestrategy'>ProductVariantPriceUpdateStrategy</a>`} default={`<a href='/reference/typescript-api/configuration/product-variant-price-update-strategy#defaultproductvariantpriceupdatestrategy'>DefaultProductVariantPriceUpdateStrategy</a>`}  since="2.2.0"  />
+
+Defines the strategy which determines what happens to a ProductVariant's prices
+when one of the prices gets updated. For instance, this can be used to synchronize
+prices across multiple Channels.
+### stockDisplayStrategy
+
+<MemberInfo kind="property" type={`<a href='/reference/typescript-api/products-stock/stock-display-strategy#stockdisplaystrategy'>StockDisplayStrategy</a>`} default={`<a href='/reference/typescript-api/products-stock/default-stock-display-strategy#defaultstockdisplaystrategy'>DefaultStockDisplayStrategy</a>`}   />
+
+Defines how the `ProductVariant.stockLevel` value is obtained. It is usually not desirable
+to directly expose stock levels over a public API, as this could be considered a leak of
+sensitive information. However, the storefront will usually want to display _some_ indication
+of whether a given ProductVariant is in stock. The default StockDisplayStrategy will
+display "IN_STOCK", "OUT_OF_STOCK" or "LOW_STOCK" rather than exposing the actual saleable
+stock level.
+### stockLocationStrategy
+
+<MemberInfo kind="property" type={`<a href='/reference/typescript-api/products-stock/stock-location-strategy#stocklocationstrategy'>StockLocationStrategy</a>`} default={`<a href='/reference/typescript-api/products-stock/default-stock-location-strategy#defaultstocklocationstrategy'>DefaultStockLocationStrategy</a>`}  since="2.0.0"  />
+
+Defines the strategy used to determine which StockLocation should be used when performing
+stock operations such as allocating and releasing stock as well as determining the
+amount of stock available for sale.
+
+
+</div>

package/docs/reference/typescript-api/products-stock/default-product-variant-price-calculation-strategy.md

@@ -0,0 +1,38 @@
+---
+title: "DefaultProductVariantPriceCalculationStrategy"
+generated: true
+---
+<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
+
+
+## DefaultProductVariantPriceCalculationStrategy
+
+<GenerationInfo sourceFile="packages/core/src/config/catalog/default-product-variant-price-calculation-strategy.ts" sourceLine="18" packageName="@vendure/core" />
+
+A default ProductVariant price calculation function.
+
+```ts title="Signature"
+class DefaultProductVariantPriceCalculationStrategy implements ProductVariantPriceCalculationStrategy {
+    init(injector: Injector) => ;
+    calculate(args: ProductVariantPriceCalculationArgs) => Promise<PriceCalculationResult>;
+}
+```
+* Implements: <code><a href='/reference/typescript-api/products-stock/product-variant-price-calculation-strategy#productvariantpricecalculationstrategy'>ProductVariantPriceCalculationStrategy</a></code>
+
+
+
+<div className="members-wrapper">
+
+### init
+
+<MemberInfo kind="method" type={`(injector: <a href='/reference/typescript-api/common/injector#injector'>Injector</a>) => `}   />
+
+
+### calculate
+
+<MemberInfo kind="method" type={`(args: <a href='/reference/typescript-api/products-stock/product-variant-price-calculation-strategy#productvariantpricecalculationargs'>ProductVariantPriceCalculationArgs</a>) => Promise&#60;<a href='/reference/typescript-api/common/price-calculation-result#pricecalculationresult'>PriceCalculationResult</a>&#62;`}   />
+
+
+
+
+</div>

package/docs/reference/typescript-api/products-stock/default-stock-display-strategy.md

@@ -0,0 +1,40 @@
+---
+title: "DefaultStockDisplayStrategy"
+generated: true
+---
+<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
+
+
+## DefaultStockDisplayStrategy
+
+<GenerationInfo sourceFile="packages/core/src/config/catalog/default-stock-display-strategy.ts" sourceLine="14" packageName="@vendure/core" />
+
+Displays the `ProductVariant.stockLevel` as either `'IN_STOCK'`, `'OUT_OF_STOCK'` or `'LOW_STOCK'`.
+Low stock is defined as a saleable stock level less than or equal to the `lowStockLevel` as passed in
+to the constructor (defaults to `2`).
+
+```ts title="Signature"
+class DefaultStockDisplayStrategy implements StockDisplayStrategy {
+    constructor(lowStockLevel: number = 2)
+    getStockLevel(ctx: RequestContext, productVariant: ProductVariant, saleableStockLevel: number) => string;
+}
+```
+* Implements: <code><a href='/reference/typescript-api/products-stock/stock-display-strategy#stockdisplaystrategy'>StockDisplayStrategy</a></code>
+
+
+
+<div className="members-wrapper">
+
+### constructor
+
+<MemberInfo kind="method" type={`(lowStockLevel: number = 2) => DefaultStockDisplayStrategy`}   />
+
+
+### getStockLevel
+
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, productVariant: <a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>, saleableStockLevel: number) => string`}   />
+
+
+
+
+</div>

package/docs/reference/typescript-api/products-stock/default-stock-location-strategy.md

@@ -0,0 +1,47 @@
+---
+title: "DefaultStockLocationStrategy"
+generated: true
+---
+<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
+
+
+## DefaultStockLocationStrategy
+
+<GenerationInfo sourceFile="packages/core/src/config/catalog/default-stock-location-strategy.ts" sourceLine="105" packageName="@vendure/core" since="2.0.0" />
+
+The DefaultStockLocationStrategy was the default implementation of the <a href='/reference/typescript-api/products-stock/stock-location-strategy#stocklocationstrategy'>StockLocationStrategy</a>
+prior to the introduction of the <a href='/reference/typescript-api/products-stock/multi-channel-stock-location-strategy#multichannelstocklocationstrategy'>MultiChannelStockLocationStrategy</a>.
+It assumes only a single StockLocation and that all stock is allocated from that location. When
+more than one StockLocation or Channel is used, it will not behave as expected.
+
+```ts title="Signature"
+class DefaultStockLocationStrategy extends BaseStockLocationStrategy {
+    init(injector: Injector) => ;
+    getAvailableStock(ctx: RequestContext, productVariantId: ID, stockLevels: StockLevel[]) => AvailableStock;
+    forAllocation(ctx: RequestContext, stockLocations: StockLocation[], orderLine: OrderLine, quantity: number) => LocationWithQuantity[] | Promise<LocationWithQuantity[]>;
+}
+```
+* Extends: <code>BaseStockLocationStrategy</code>
+
+
+
+<div className="members-wrapper">
+
+### init
+
+<MemberInfo kind="method" type={`(injector: <a href='/reference/typescript-api/common/injector#injector'>Injector</a>) => `}   />
+
+
+### getAvailableStock
+
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, productVariantId: <a href='/reference/typescript-api/common/id#id'>ID</a>, stockLevels: <a href='/reference/typescript-api/entities/stock-level#stocklevel'>StockLevel</a>[]) => <a href='/reference/typescript-api/products-stock/stock-location-strategy#availablestock'>AvailableStock</a>`}   />
+
+
+### forAllocation
+
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, stockLocations: <a href='/reference/typescript-api/entities/stock-location#stocklocation'>StockLocation</a>[], orderLine: <a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</a>, quantity: number) => <a href='/reference/typescript-api/products-stock/stock-location-strategy#locationwithquantity'>LocationWithQuantity</a>[] | Promise&#60;<a href='/reference/typescript-api/products-stock/stock-location-strategy#locationwithquantity'>LocationWithQuantity</a>[]&#62;`}   />
+
+
+
+
+</div>

package/docs/reference/typescript-api/products-stock/index.md

@@ -0,0 +1,5 @@
+---
+title: "Products Stock"
+generated: true
+---
+<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->

package/docs/reference/typescript-api/products-stock/multi-channel-stock-location-strategy.md

@@ -0,0 +1,47 @@
+---
+title: "MultiChannelStockLocationStrategy"
+generated: true
+---
+<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
+
+
+## MultiChannelStockLocationStrategy
+
+<GenerationInfo sourceFile="packages/core/src/config/catalog/multi-channel-stock-location-strategy.ts" sourceLine="32" packageName="@vendure/core" since="3.1.0" />
+
+The MultiChannelStockLocationStrategy is an implementation of the <a href='/reference/typescript-api/products-stock/stock-location-strategy#stocklocationstrategy'>StockLocationStrategy</a>.
+which is suitable for both single- and multichannel setups. It takes into account the active
+channel when determining stock levels, and also ensures that allocations are made only against
+stock locations which are associated with the active channel.
+
+This strategy became the default in Vendure 3.1.0. If you want to use the previous strategy which
+does not take channels into account, update your VendureConfig to use to <a href='/reference/typescript-api/products-stock/default-stock-location-strategy#defaultstocklocationstrategy'>DefaultStockLocationStrategy</a>.
+
+```ts title="Signature"
+class MultiChannelStockLocationStrategy extends BaseStockLocationStrategy {
+    getAvailableStock(ctx: RequestContext, productVariantId: ID, stockLevels: StockLevel[]) => Promise<AvailableStock>;
+    forAllocation(ctx: RequestContext, stockLocations: StockLocation[], orderLine: OrderLine, quantity: number) => Promise<LocationWithQuantity[]>;
+}
+```
+* Extends: <code>BaseStockLocationStrategy</code>
+
+
+
+<div className="members-wrapper">
+
+### getAvailableStock
+
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, productVariantId: <a href='/reference/typescript-api/common/id#id'>ID</a>, stockLevels: <a href='/reference/typescript-api/entities/stock-level#stocklevel'>StockLevel</a>[]) => Promise&#60;<a href='/reference/typescript-api/products-stock/stock-location-strategy#availablestock'>AvailableStock</a>&#62;`}   />
+
+Returns the available stock for the given ProductVariant, taking into account the active Channel.
+### forAllocation
+
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, stockLocations: <a href='/reference/typescript-api/entities/stock-location#stocklocation'>StockLocation</a>[], orderLine: <a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</a>, quantity: number) => Promise&#60;<a href='/reference/typescript-api/products-stock/stock-location-strategy#locationwithquantity'>LocationWithQuantity</a>[]&#62;`}   />
+
+This method takes into account whether the stock location is applicable to the active channel.
+It furthermore respects the `trackInventory` and `outOfStockThreshold` settings of the ProductVariant,
+in order to allocate stock only from locations which are relevant to the active channel and which
+have sufficient stock available.
+
+
+</div>