docs: add additional data description in generated references (#10944)
This commit is contained in:
1 parent
1b86c17b72
commit
2a2b387bc3
917 files changed
+15807
-15158
No files matched your search
+1
-1
@@ -46,7 +46,7 @@ const [salesChannels, count] =
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableSalesChannelProps](../../../interfaces/sales_channel.FilterableSalesChannelProps/page.mdx)","description":"The filters to apply on the retrieved sales channels.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableSalesChannelProps](../../../interfaces/sales_channel.FilterableSalesChannelProps/page.mdx) \\| [BaseFilterable](../../../interfaces/sales_channel.BaseFilterable/page.mdx)<[FilterableSalesChannelProps](../../../interfaces/sales_channel.FilterableSalesChannelProps/page.mdx)>)[]","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":"([FilterableSalesChannelProps](../../../interfaces/sales_channel.FilterableSalesChannelProps/page.mdx) \\| [BaseFilterable](../../../interfaces/sales_channel.BaseFilterable/page.mdx)<[FilterableSalesChannelProps](../../../interfaces/sales_channel.FilterableSalesChannelProps/page.mdx)>)[]","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":"([FilterableSalesChannelProps](../../../interfaces/sales_channel.FilterableSalesChannelProps/page.mdx) \\| [BaseFilterable](../../../interfaces/sales_channel.BaseFilterable/page.mdx)<[FilterableSalesChannelProps](../../../interfaces/sales_channel.FilterableSalesChannelProps/page.mdx)>)[]","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":"Find sales channels by their name or description through this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the sales channel by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[]","description":"Filter sales channels by their names.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_disabled","type":"`boolean`","description":"Filter sales channels by whether they're disabled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/sales_channel.BaseFilterable/page.mdx)<T> \\| 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/sales_channel.BaseFilterable/page.mdx)<T> \\| 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":"([FilterableSalesChannelProps](../../../interfaces/sales_channel.FilterableSalesChannelProps/page.mdx) \\| [BaseFilterable](../../../interfaces/sales_channel.BaseFilterable/page.mdx)<[FilterableSalesChannelProps](../../../interfaces/sales_channel.FilterableSalesChannelProps/page.mdx)>)[]","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":"([FilterableSalesChannelProps](../../../interfaces/sales_channel.FilterableSalesChannelProps/page.mdx) \\| [BaseFilterable](../../../interfaces/sales_channel.BaseFilterable/page.mdx)<[FilterableSalesChannelProps](../../../interfaces/sales_channel.FilterableSalesChannelProps/page.mdx)>)[]","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":"([FilterableSalesChannelProps](../../../interfaces/sales_channel.FilterableSalesChannelProps/page.mdx) \\| [BaseFilterable](../../../interfaces/sales_channel.BaseFilterable/page.mdx)<[FilterableSalesChannelProps](../../../interfaces/sales_channel.FilterableSalesChannelProps/page.mdx)>)[]","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":"Find sales channels by their name or description through this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the sales channel by.","optional":trLine truncated
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableSalesChannelProps](../../../interfaces/sales_channel.FilterableSalesChannelProps/page.mdx)","description":"The filters to apply on the retrieved sales channels.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableSalesChannelProps](../../../interfaces/sales_channel.FilterableSalesChannelProps/page.mdx) \\| [BaseFilterable](../../../interfaces/sales_channel.BaseFilterable/page.mdx)<[FilterableSalesChannelProps](../../../interfaces/sales_channel.FilterableSalesChannelProps/page.mdx)>)[]","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":"([FilterableSalesChannelProps](../../../interfaces/sales_channel.FilterableSalesChannelProps/page.mdx) \\| [BaseFilterable](../../../interfaces/sales_channel.BaseFilterable/page.mdx)<[FilterableSalesChannelProps](../../../interfaces/sales_channel.FilterableSalesChannelProps/page.mdx)>)[]","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":"([FilterableSalesChannelProps](../../../interfaces/sales_channel.FilterableSalesChannelProps/page.mdx) \\| [BaseFilterable](../../../interfaces/sales_channel.BaseFilterable/page.mdx)<[FilterableSalesChannelProps](../../../interfaces/sales_channel.FilterableSalesChannelProps/page.mdx)>)[]","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":"Find sales channels by their name or description through this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the sales channel by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[]","description":"Filter sales channels by their names.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_disabled","type":"`boolean`","description":"Filter sales channels by whether they're disabled.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableSalesChannelProps](../../../interfaces/sales_channel.FilterableSalesChannelProps/page.mdx) \\| [BaseFilterable](../../../interfaces/sales_channel.BaseFilterable/page.mdx)<[FilterableSalesChannelProps](../../../interfaces/sales_channel.FilterableSalesChannelProps/page.mdx)>)[]","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":"([FilterableSalesChannelProps](../../../interfaces/sales_channel.FilterableSalesChannelProps/page.mdx) \\| [BaseFilterable](../../../interfaces/sales_channel.BaseFilterable/page.mdx)<[FilterableSalesChannelProps](../../../interfaces/sales_channel.FilterableSalesChannelProps/page.mdx)>)[]","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":"([FilterableSalesChannelProps](../../../interfaces/sales_channel.FilterableSalesChannelProps/page.mdx) \\| [BaseFilterable](../../../interfaces/sales_channel.BaseFilterable/page.mdx)<[FilterableSalesChannelProps](../../../interfaces/sales_channel.FilterableSalesChannelProps/page.mdx)>)[]","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":"Find sales channels by their name or description through this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the sales channel by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[]","description":"Filter sales channels by their names.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_disabled","type":"`boolean`","description":"Filter sales channels by whether they're disabled.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"q","type":"`string`","description":"Find sales channels by their name or description through this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `sLine truncated
|
||||
|
||||
## Returns
|
||||
|
||||
|
||||
+1
-1
@@ -44,7 +44,7 @@ const salesChannels = await salesChannelModuleService.listSalesChannels(
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableSalesChannelProps](../../../interfaces/sales_channel.FilterableSalesChannelProps/page.mdx)","description":"The filters to apply on the retrieved sales channels.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableSalesChannelProps](../../../interfaces/sales_channel.FilterableSalesChannelProps/page.mdx) \\| [BaseFilterable](../../../interfaces/sales_channel.BaseFilterable/page.mdx)<[FilterableSalesChannelProps](../../../interfaces/sales_channel.FilterableSalesChannelProps/page.mdx)>)[]","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":"([FilterableSalesChannelProps](../../../interfaces/sales_channel.FilterableSalesChannelProps/page.mdx) \\| [BaseFilterable](../../../interfaces/sales_channel.BaseFilterable/page.mdx)<[FilterableSalesChannelProps](../../../interfaces/sales_channel.FilterableSalesChannelProps/page.mdx)>)[]","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":"([FilterableSalesChannelProps](../../../interfaces/sales_channel.FilterableSalesChannelProps/page.mdx) \\| [BaseFilterable](../../../interfaces/sales_channel.BaseFilterable/page.mdx)<[FilterableSalesChannelProps](../../../interfaces/sales_channel.FilterableSalesChannelProps/page.mdx)>)[]","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":"Find sales channels by their name or description through this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the sales channel by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[]","description":"Filter sales channels by their names.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_disabled","type":"`boolean`","description":"Filter sales channels by whether they're disabled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/sales_channel.BaseFilterable/page.mdx)<T> \\| 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/sales_channel.BaseFilterable/page.mdx)<T> \\| 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":"([FilterableSalesChannelProps](../../../interfaces/sales_channel.FilterableSalesChannelProps/page.mdx) \\| [BaseFilterable](../../../interfaces/sales_channel.BaseFilterable/page.mdx)<[FilterableSalesChannelProps](../../../interfaces/sales_channel.FilterableSalesChannelProps/page.mdx)>)[]","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":"([FilterableSalesChannelProps](../../../interfaces/sales_channel.FilterableSalesChannelProps/page.mdx) \\| [BaseFilterable](../../../interfaces/sales_channel.BaseFilterable/page.mdx)<[FilterableSalesChannelProps](../../../interfaces/sales_channel.FilterableSalesChannelProps/page.mdx)>)[]","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":"([FilterableSalesChannelProps](../../../interfaces/sales_channel.FilterableSalesChannelProps/page.mdx) \\| [BaseFilterable](../../../interfaces/sales_channel.BaseFilterable/page.mdx)<[FilterableSalesChannelProps](../../../interfaces/sales_channel.FilterableSalesChannelProps/page.mdx)>)[]","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":"Find sales channels by their name or description through this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the sales channel by.","optional":trLine truncated
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableSalesChannelProps](../../../interfaces/sales_channel.FilterableSalesChannelProps/page.mdx)","description":"The filters to apply on the retrieved sales channels.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableSalesChannelProps](../../../interfaces/sales_channel.FilterableSalesChannelProps/page.mdx) \\| [BaseFilterable](../../../interfaces/sales_channel.BaseFilterable/page.mdx)<[FilterableSalesChannelProps](../../../interfaces/sales_channel.FilterableSalesChannelProps/page.mdx)>)[]","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":"([FilterableSalesChannelProps](../../../interfaces/sales_channel.FilterableSalesChannelProps/page.mdx) \\| [BaseFilterable](../../../interfaces/sales_channel.BaseFilterable/page.mdx)<[FilterableSalesChannelProps](../../../interfaces/sales_channel.FilterableSalesChannelProps/page.mdx)>)[]","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":"([FilterableSalesChannelProps](../../../interfaces/sales_channel.FilterableSalesChannelProps/page.mdx) \\| [BaseFilterable](../../../interfaces/sales_channel.BaseFilterable/page.mdx)<[FilterableSalesChannelProps](../../../interfaces/sales_channel.FilterableSalesChannelProps/page.mdx)>)[]","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":"Find sales channels by their name or description through this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the sales channel by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[]","description":"Filter sales channels by their names.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_disabled","type":"`boolean`","description":"Filter sales channels by whether they're disabled.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableSalesChannelProps](../../../interfaces/sales_channel.FilterableSalesChannelProps/page.mdx) \\| [BaseFilterable](../../../interfaces/sales_channel.BaseFilterable/page.mdx)<[FilterableSalesChannelProps](../../../interfaces/sales_channel.FilterableSalesChannelProps/page.mdx)>)[]","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":"([FilterableSalesChannelProps](../../../interfaces/sales_channel.FilterableSalesChannelProps/page.mdx) \\| [BaseFilterable](../../../interfaces/sales_channel.BaseFilterable/page.mdx)<[FilterableSalesChannelProps](../../../interfaces/sales_channel.FilterableSalesChannelProps/page.mdx)>)[]","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":"([FilterableSalesChannelProps](../../../interfaces/sales_channel.FilterableSalesChannelProps/page.mdx) \\| [BaseFilterable](../../../interfaces/sales_channel.BaseFilterable/page.mdx)<[FilterableSalesChannelProps](../../../interfaces/sales_channel.FilterableSalesChannelProps/page.mdx)>)[]","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":"Find sales channels by their name or description through this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the sales channel by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[]","description":"Filter sales channels by their names.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_disabled","type":"`boolean`","description":"Filter sales channels by whether they're disabled.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"q","type":"`string`","description":"Find sales channels by their name or description through this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `sLine truncated
|
||||
|
||||
## Returns
|
||||
|
||||
|
||||
+1
-1
@@ -58,7 +58,7 @@ const salesChannels = await salesChannelModuleService.updateSalesChannels(
|
||||
|
||||
### Parameters
|
||||
|
||||
<TypeList types={[{"name":"selector","type":"[FilterableSalesChannelProps](../../../interfaces/sales_channel.FilterableSalesChannelProps/page.mdx)","description":"The filters specifying which sales channels to update.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableSalesChannelProps](../../../interfaces/sales_channel.FilterableSalesChannelProps/page.mdx) \\| [BaseFilterable](../../../interfaces/sales_channel.BaseFilterable/page.mdx)<[FilterableSalesChannelProps](../../../interfaces/sales_channel.FilterableSalesChannelProps/page.mdx)>)[]","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":"([FilterableSalesChannelProps](../../../interfaces/sales_channel.FilterableSalesChannelProps/page.mdx) \\| [BaseFilterable](../../../interfaces/sales_channel.BaseFilterable/page.mdx)<[FilterableSalesChannelProps](../../../interfaces/sales_channel.FilterableSalesChannelProps/page.mdx)>)[]","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":"([FilterableSalesChannelProps](../../../interfaces/sales_channel.FilterableSalesChannelProps/page.mdx) \\| [BaseFilterable](../../../interfaces/sales_channel.BaseFilterable/page.mdx)<[FilterableSalesChannelProps](../../../interfaces/sales_channel.FilterableSalesChannelProps/page.mdx)>)[]","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":"Find sales channels by their name or description through this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the sales channel by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[]","description":"Filter sales channels by their names.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_disabled","type":"`boolean`","description":"Filter sales channels by whether they're disabled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/sales_channel.BaseFilterable/page.mdx)<T> \\| 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/sales_channel.BaseFilterable/page.mdx)<T> \\| 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":"([FilterableSalesChannelProps](../../../interfaces/sales_channel.FilterableSalesChannelProps/page.mdx) \\| [BaseFilterable](../../../interfaces/sales_channel.BaseFilterable/page.mdx)<[FilterableSalesChannelProps](../../../interfaces/sales_channel.FilterableSalesChannelProps/page.mdx)>)[]","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":"([FilterableSalesChannelProps](../../../interfaces/sales_channel.FilterableSalesChannelProps/page.mdx) \\| [BaseFilterable](../../../interfaces/sales_channel.BaseFilterable/page.mdx)<[FilterableSalesChannelProps](../../../interfaces/sales_channel.FilterableSalesChannelProps/page.mdx)>)[]","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":"([FilterableSalesChannelProps](../../../interfaces/sales_channel.FilterableSalesChannelProps/page.mdx) \\| [BaseFilterable](../../../interfaces/sales_channel.BaseFilterable/page.mdx)<[FilterableSalesChannelProps](../../../interfaces/sales_channel.FilterableSalesChannelProps/page.mdx)>)[]","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":"Find sales channels by their name or description through this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the sales channel by.","optional"Line truncated
|
||||
<TypeList types={[{"name":"selector","type":"[FilterableSalesChannelProps](../../../interfaces/sales_channel.FilterableSalesChannelProps/page.mdx)","description":"The filters specifying which sales channels to update.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableSalesChannelProps](../../../interfaces/sales_channel.FilterableSalesChannelProps/page.mdx) \\| [BaseFilterable](../../../interfaces/sales_channel.BaseFilterable/page.mdx)<[FilterableSalesChannelProps](../../../interfaces/sales_channel.FilterableSalesChannelProps/page.mdx)>)[]","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":"([FilterableSalesChannelProps](../../../interfaces/sales_channel.FilterableSalesChannelProps/page.mdx) \\| [BaseFilterable](../../../interfaces/sales_channel.BaseFilterable/page.mdx)<[FilterableSalesChannelProps](../../../interfaces/sales_channel.FilterableSalesChannelProps/page.mdx)>)[]","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":"([FilterableSalesChannelProps](../../../interfaces/sales_channel.FilterableSalesChannelProps/page.mdx) \\| [BaseFilterable](../../../interfaces/sales_channel.BaseFilterable/page.mdx)<[FilterableSalesChannelProps](../../../interfaces/sales_channel.FilterableSalesChannelProps/page.mdx)>)[]","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":"Find sales channels by their name or description through this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the sales channel by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[]","description":"Filter sales channels by their names.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_disabled","type":"`boolean`","description":"Filter sales channels by whether they're disabled.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableSalesChannelProps](../../../interfaces/sales_channel.FilterableSalesChannelProps/page.mdx) \\| [BaseFilterable](../../../interfaces/sales_channel.BaseFilterable/page.mdx)<[FilterableSalesChannelProps](../../../interfaces/sales_channel.FilterableSalesChannelProps/page.mdx)>)[]","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":"([FilterableSalesChannelProps](../../../interfaces/sales_channel.FilterableSalesChannelProps/page.mdx) \\| [BaseFilterable](../../../interfaces/sales_channel.BaseFilterable/page.mdx)<[FilterableSalesChannelProps](../../../interfaces/sales_channel.FilterableSalesChannelProps/page.mdx)>)[]","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":"([FilterableSalesChannelProps](../../../interfaces/sales_channel.FilterableSalesChannelProps/page.mdx) \\| [BaseFilterable](../../../interfaces/sales_channel.BaseFilterable/page.mdx)<[FilterableSalesChannelProps](../../../interfaces/sales_channel.FilterableSalesChannelProps/page.mdx)>)[]","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":"Find sales channels by their name or description through this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the sales channel by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[]","description":"Filter sales channels by their names.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_disabled","type":"`boolean`","description":"Filter sales channels by whether they're disabled.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"q","type":"`string`","description":"Find sales channels by their name or description through this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\|Line truncated
|
||||
|
||||
### Returns
|
||||
|
||||
|
||||
Reference in new issue
Block a user