chore(docs): Generated References (#9551)

Generated the following references: - `api_key` - `auth` - `cart` - `core_flows` - `currency` - `customer` - `fulfillment` - `inventory_next` - `modules` - `modules_sdk` - `order` - `order_models` - `payment` - `payment_provider` - `pricing` - `product` - `promotion` - `region` - `sales_channel` - `search` - `stock_location_next` - `store` - `tax` - `types` - `user` - `utils` - `workflows` Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
2024-10-14 10:33:21 +00:00
1 parent 089d4af301
commit 224e530453
@@ -55,7 +55,7 @@ const [stockLocations, count] =

 ## Parameters

-<TypeList types={[{"name":"selector","type":"[FilterableStockLocationProps](../../../interfaces/stock_location_next.FilterableStockLocationProps/page.mdx)","description":"The filters to apply on the retrieved stock locations.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableStockLocationProps](../../../interfaces/stock_location_next.FilterableStockLocationProps/page.mdx) \\| [BaseFilterable](../../../interfaces/stock_location_next.BaseFilterable/page.mdx)&#60;[FilterableStockLocationProps](../../../interfaces/stock_location_next.FilterableStockLocationProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableStockLocationProps](../../../interfaces/stock_location_next.FilterableStockLocationProps/page.mdx) \\| [BaseFilterable](../../../interfaces/stock_location_next.BaseFilterable/page.mdx)&#60;[FilterableStockLocationProps](../../../interfaces/stock_location_next.FilterableStockLocationProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableStockLocationProps](../../../interfaces/stock_location_next.FilterableStockLocationProps/page.mdx) \\| [BaseFilterable](../../../interfaces/stock_location_next.BaseFilterable/page.mdx)&#60;[FilterableStockLocationProps](../../../interfaces/stock_location_next.FilterableStockLocationProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Search parameter for stock location names","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter stock locations by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/stock_location_next.OperatorMap/page.mdx)&#60;string&#62;","description":"The names to filter stock locations by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/stock_location_next.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/stock_location_next.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableStockLocationProps](../../../interfaces/stock_location_next.FilterableStockLocationProps/page.mdx) \\| [BaseFilterable](../../../interfaces/stock_location_next.BaseFilterable/page.mdx)&#60;[FilterableStockLocationProps](../../../interfaces/stock_location_next.FilterableStockLocationProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableStockLocationProps](../../../interfaces/stock_location_next.FilterableStockLocationProps/page.mdx) \\| [BaseFilterable](../../../interfaces/stock_location_next.BaseFilterable/page.mdx)&#60;[FilterableStockLocationProps](../../../interfaces/stock_location_next.FilterableStockLocationProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableStockLocationProps](../../../interfaces/stock_location_next.FilterableStockLocationProps/page.mdx) \\| [BaseFilterable](../../../interfaces/stock_location_next.BaseFilterable/page.mdx)&#60;[FilterableStockLocationProps](../../../interfaces/stock_location_next.FilterableStockLocationProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Search parameter for stock location names","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter stock locations by.","optional":Line truncated
+<TypeList types={[{"name":"selector","type":"[FilterableStockLocationProps](../../../interfaces/stock_location_next.FilterableStockLocationProps/page.mdx)","description":"The filters to apply on the retrieved stock locations.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableStockLocationProps](../../../interfaces/stock_location_next.FilterableStockLocationProps/page.mdx) \\| [BaseFilterable](../../../interfaces/stock_location_next.BaseFilterable/page.mdx)&#60;[FilterableStockLocationProps](../../../interfaces/stock_location_next.FilterableStockLocationProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableStockLocationProps](../../../interfaces/stock_location_next.FilterableStockLocationProps/page.mdx) \\| [BaseFilterable](../../../interfaces/stock_location_next.BaseFilterable/page.mdx)&#60;[FilterableStockLocationProps](../../../interfaces/stock_location_next.FilterableStockLocationProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableStockLocationProps](../../../interfaces/stock_location_next.FilterableStockLocationProps/page.mdx) \\| [BaseFilterable](../../../interfaces/stock_location_next.BaseFilterable/page.mdx)&#60;[FilterableStockLocationProps](../../../interfaces/stock_location_next.FilterableStockLocationProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Search parameter for stock location names","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter stock locations by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/stock_location_next.OperatorMap/page.mdx)&#60;string&#62;","description":"The names to filter stock locations by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/stock_location_next.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/stock_location_next.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableStockLocationProps](../../../interfaces/stock_location_next.FilterableStockLocationProps/page.mdx) \\| [BaseFilterable](../../../interfaces/stock_location_next.BaseFilterable/page.mdx)&#60;[FilterableStockLocationProps](../../../interfaces/stock_location_next.FilterableStockLocationProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableStockLocationProps](../../../interfaces/stock_location_next.FilterableStockLocationProps/page.mdx) \\| [BaseFilterable](../../../interfaces/stock_location_next.BaseFilterable/page.mdx)&#60;[FilterableStockLocationProps](../../../interfaces/stock_location_next.FilterableStockLocationProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableStockLocationProps](../../../interfaces/stock_location_next.FilterableStockLocationProps/page.mdx) \\| [BaseFilterable](../../../interfaces/stock_location_next.BaseFilterable/page.mdx)&#60;[FilterableStockLocationProps](../../../interfaces/stock_location_next.FilterableStockLocationProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Search parameter for stock location names","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter stock locations by.","optional":Line truncated

 ## Returns

@@ -52,7 +52,7 @@ const stockLocations = await stockLocationModuleService.listStockLocations(

 ## Parameters

-<TypeList types={[{"name":"selector","type":"[FilterableStockLocationProps](../../../interfaces/stock_location_next.FilterableStockLocationProps/page.mdx)","description":"The filters to apply on the retrieved stock locations.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableStockLocationProps](../../../interfaces/stock_location_next.FilterableStockLocationProps/page.mdx) \\| [BaseFilterable](../../../interfaces/stock_location_next.BaseFilterable/page.mdx)&#60;[FilterableStockLocationProps](../../../interfaces/stock_location_next.FilterableStockLocationProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableStockLocationProps](../../../interfaces/stock_location_next.FilterableStockLocationProps/page.mdx) \\| [BaseFilterable](../../../interfaces/stock_location_next.BaseFilterable/page.mdx)&#60;[FilterableStockLocationProps](../../../interfaces/stock_location_next.FilterableStockLocationProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableStockLocationProps](../../../interfaces/stock_location_next.FilterableStockLocationProps/page.mdx) \\| [BaseFilterable](../../../interfaces/stock_location_next.BaseFilterable/page.mdx)&#60;[FilterableStockLocationProps](../../../interfaces/stock_location_next.FilterableStockLocationProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Search parameter for stock location names","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter stock locations by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/stock_location_next.OperatorMap/page.mdx)&#60;string&#62;","description":"The names to filter stock locations by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/stock_location_next.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/stock_location_next.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableStockLocationProps](../../../interfaces/stock_location_next.FilterableStockLocationProps/page.mdx) \\| [BaseFilterable](../../../interfaces/stock_location_next.BaseFilterable/page.mdx)&#60;[FilterableStockLocationProps](../../../interfaces/stock_location_next.FilterableStockLocationProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableStockLocationProps](../../../interfaces/stock_location_next.FilterableStockLocationProps/page.mdx) \\| [BaseFilterable](../../../interfaces/stock_location_next.BaseFilterable/page.mdx)&#60;[FilterableStockLocationProps](../../../interfaces/stock_location_next.FilterableStockLocationProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableStockLocationProps](../../../interfaces/stock_location_next.FilterableStockLocationProps/page.mdx) \\| [BaseFilterable](../../../interfaces/stock_location_next.BaseFilterable/page.mdx)&#60;[FilterableStockLocationProps](../../../interfaces/stock_location_next.FilterableStockLocationProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Search parameter for stock location names","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter stock locations by.","optional":Line truncated
+<TypeList types={[{"name":"selector","type":"[FilterableStockLocationProps](../../../interfaces/stock_location_next.FilterableStockLocationProps/page.mdx)","description":"The filters to apply on the retrieved stock locations.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableStockLocationProps](../../../interfaces/stock_location_next.FilterableStockLocationProps/page.mdx) \\| [BaseFilterable](../../../interfaces/stock_location_next.BaseFilterable/page.mdx)&#60;[FilterableStockLocationProps](../../../interfaces/stock_location_next.FilterableStockLocationProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableStockLocationProps](../../../interfaces/stock_location_next.FilterableStockLocationProps/page.mdx) \\| [BaseFilterable](../../../interfaces/stock_location_next.BaseFilterable/page.mdx)&#60;[FilterableStockLocationProps](../../../interfaces/stock_location_next.FilterableStockLocationProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableStockLocationProps](../../../interfaces/stock_location_next.FilterableStockLocationProps/page.mdx) \\| [BaseFilterable](../../../interfaces/stock_location_next.BaseFilterable/page.mdx)&#60;[FilterableStockLocationProps](../../../interfaces/stock_location_next.FilterableStockLocationProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Search parameter for stock location names","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter stock locations by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/stock_location_next.OperatorMap/page.mdx)&#60;string&#62;","description":"The names to filter stock locations by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/stock_location_next.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/stock_location_next.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableStockLocationProps](../../../interfaces/stock_location_next.FilterableStockLocationProps/page.mdx) \\| [BaseFilterable](../../../interfaces/stock_location_next.BaseFilterable/page.mdx)&#60;[FilterableStockLocationProps](../../../interfaces/stock_location_next.FilterableStockLocationProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableStockLocationProps](../../../interfaces/stock_location_next.FilterableStockLocationProps/page.mdx) \\| [BaseFilterable](../../../interfaces/stock_location_next.BaseFilterable/page.mdx)&#60;[FilterableStockLocationProps](../../../interfaces/stock_location_next.FilterableStockLocationProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableStockLocationProps](../../../interfaces/stock_location_next.FilterableStockLocationProps/page.mdx) \\| [BaseFilterable](../../../interfaces/stock_location_next.BaseFilterable/page.mdx)&#60;[FilterableStockLocationProps](../../../interfaces/stock_location_next.FilterableStockLocationProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Search parameter for stock location names","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter stock locations by.","optional":Line truncated

 ## Returns

@@ -21,7 +21,7 @@ const stockLocation =

 ## Parameters

-<TypeList types={[{"name":"id","type":"`string`","description":"The ID of the stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../../interfaces/stock_location_next.FindConfig/page.mdx)&#60;[StockLocationDTO](../../../types/stock_location_next.StockLocationDTO/page.mdx)&#62;","description":"The configurations determining how the stock location is retrieved. Its properties, such as `select` or `relations`, accept the\nattributes or relations associated with a stock location.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"select","type":"(`string` \\| keyof Entity)[]","description":"An array of strings, each being attribute names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"skip","type":"`null` \\| `number`","description":"A number indicating the number of records to skip before retrieving the results.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`null` \\| `number`","description":"A number indicating the number of records to return in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relations","type":"`string`[]","description":"An array of strings, each being relation names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`object`","description":"An object used to specify how to sort the returned records. Its keys are the names of attributes of the entity, and a key's value can either be `ASC`\nto sort retrieved records in an ascending order, or `DESC` to sort retrieved records in a descending order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"withDeleted","type":"`boolean`","description":"A boolean indicating whether deleted records should also be retrieved as part of the result. This only works if the entity extends the\n`SoftDeletableEntity` class.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"filters","type":"`Record<string, any>`","description":"Enable ORM specific defined filters","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record<string, any>`","description":"Enable ORM specific defined options","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"context","type":"[Context](../../../interfaces/stock_location_next.Context/page.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"transactionManager","type":"TManager","description":"An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"manager","type":"TManager","description":"An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationLevel","type":"`string`","description":"A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"enableNestedTransactions","type":"`boolean`","description":"A boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"eventGroupId","type":"`string`","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionId","type":"`string`","description":"A string indicating the ID of the current transaction.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"messageAggregator","type":"[IMessageAggregator](../../../interfaces/stock_location_next.IMessageAggregator/page.mdx)","description":"An instance of a message aggregator, which is used to aggregate messages to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"`string`","description":"A string indicating the ID of the current request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotencyKey","type":"`string`","description":"A string indicating the idempotencyKey of the current workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parentStepIdempotencyKey","type":"`string`","description":"A string indicating the idempoteLine truncated
+<TypeList types={[{"name":"id","type":"`string`","description":"The ID of the stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../../interfaces/stock_location_next.FindConfig/page.mdx)&#60;[StockLocationDTO](../../../types/stock_location_next.StockLocationDTO/page.mdx)&#62;","description":"The configurations determining how the stock location is retrieved. Its properties, such as `select` or `relations`, accept the\nattributes or relations associated with a stock location.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"select","type":"(`string` \\| keyof Entity)[]","description":"An array of strings, each being attribute names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"skip","type":"`null` \\| `number`","description":"A number indicating the number of records to skip before retrieving the results.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`null` \\| `number`","description":"A number indicating the number of records to return in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relations","type":"`string`[]","description":"An array of strings, each being relation names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`Record<string, \"ASC\" \\| \"DESC\" \\| string & object>`","description":"An object used to specify how to sort the returned records. Its keys are the names of attributes of the entity, and a key's value can either be `ASC`\nto sort retrieved records in an ascending order, or `DESC` to sort retrieved records in a descending order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"withDeleted","type":"`boolean`","description":"A boolean indicating whether deleted records should also be retrieved as part of the result. This only works if the entity extends the\n`SoftDeletableEntity` class.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"filters","type":"`Record<string, any>`","description":"Enable ORM specific defined filters","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record<string, any>`","description":"Enable ORM specific defined options","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"context","type":"[Context](../../../interfaces/stock_location_next.Context/page.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"transactionManager","type":"TManager","description":"An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"manager","type":"TManager","description":"An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationLevel","type":"`string`","description":"A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"enableNestedTransactions","type":"`boolean`","description":"A boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"eventGroupId","type":"`string`","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionId","type":"`string`","description":"A string indicating the ID of the current transaction.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"messageAggregator","type":"[IMessageAggregator](../../../interfaces/stock_location_next.IMessageAggregator/page.mdx)","description":"An instance of a message aggregator, which is used to aggregate messages to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"`string`","description":"A string indicating the ID of the current request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotencyKey","type":"`string`","description":"A string indicating the idempotencyKey of the current workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parentStepIdempotencyKey","type":"`stringLine truncated

 ## Returns

@@ -13,4 +13,4 @@ which provides correct typing of field names in its properties.

 <TypeList types={[{"name":"Entity","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="FindConfig"/>

-<TypeList types={[{"name":"select","type":"(`string` \\| keyof Entity)[]","description":"An array of strings, each being attribute names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"skip","type":"`null` \\| `number`","description":"A number indicating the number of records to skip before retrieving the results.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`null` \\| `number`","description":"A number indicating the number of records to return in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relations","type":"`string`[]","description":"An array of strings, each being relation names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`object`","description":"An object used to specify how to sort the returned records. Its keys are the names of attributes of the entity, and a key's value can either be `ASC`\nto sort retrieved records in an ascending order, or `DESC` to sort retrieved records in a descending order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"withDeleted","type":"`boolean`","description":"A boolean indicating whether deleted records should also be retrieved as part of the result. This only works if the entity extends the\n`SoftDeletableEntity` class.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"filters","type":"`Record<string, any>`","description":"Enable ORM specific defined filters","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record<string, any>`","description":"Enable ORM specific defined options","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="FindConfig"/>
+<TypeList types={[{"name":"select","type":"(`string` \\| keyof Entity)[]","description":"An array of strings, each being attribute names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"skip","type":"`null` \\| `number`","description":"A number indicating the number of records to skip before retrieving the results.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`null` \\| `number`","description":"A number indicating the number of records to return in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relations","type":"`string`[]","description":"An array of strings, each being relation names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`Record<string, \"ASC\" \\| \"DESC\" \\| string & object>`","description":"An object used to specify how to sort the returned records. Its keys are the names of attributes of the entity, and a key's value can either be `ASC`\nto sort retrieved records in an ascending order, or `DESC` to sort retrieved records in a descending order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"withDeleted","type":"`boolean`","description":"A boolean indicating whether deleted records should also be retrieved as part of the result. This only works if the entity extends the\n`SoftDeletableEntity` class.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"filters","type":"`Record<string, any>`","description":"Enable ORM specific defined filters","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record<string, any>`","description":"Enable ORM specific defined options","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="FindConfig"/>