chore(docs): Generated References (automated) (#13206)
Generated the following references: - `api_key_models` - `auth_models` - `cart_models` - `core_flows` - `currency_models` - `customer_models` - `fulfillment_models` - `inventory_next_models` - `js_sdk` - `order` - `order_models` - `payment_models` - `pricing_models` - `product` - `product_models` - `promotion` - `promotion_models` - `region_models` - `sales_channel_models` - `stock_location_next_models` - `store_models` - `tax_models` - `user_models` Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
This commit is contained in:
1 parent
f0f3847f27
commit
623cf05fab
529 files changed
+199093
-198816
No files matched your search
+1
-1
@@ -67,7 +67,7 @@ const [options, count] =
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/page.mdx)","description":"The filters applied on the retrieved product option values.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/page.mdx) \\| [BaseFilterable](../../../interfaces/product.BaseFilterable/page.mdx)<[FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/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":"([FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/page.mdx) \\| [BaseFilterable](../../../interfaces/product.BaseFilterable/page.mdx)<[FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/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":"([FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/page.mdx) \\| [BaseFilterable](../../../interfaces/product.BaseFilterable/page.mdx)<[FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/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":"Search through the option values' values.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter product options by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string` \\| `string`[]","description":"The values to filter product options by.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/page.mdx) \\| [BaseFilterable](../../../interfaces/product.BaseFilterable/page.mdx)<[FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/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":"([FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/page.mdx) \\| [BaseFilterable](../../../interfaces/product.BaseFilterable/page.mdx)<[FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/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":"([FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/page.mdx) \\| [BaseFilterable](../../../interfaces/product.BaseFilterable/page.mdx)<[FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/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":"Search through the option values' values.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter product options by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string` \\| `string`[]","description":"The values to filter product options by.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"q","type":"`string`","description":"Search through the option values' values.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter product options by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string` \\| `string`[]","description":"The values to filter product options by.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"config","type":"[FindConfig](../../../interfaces/product.FindConfig/page.mdx)<Line truncated
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/page.mdx)","description":"The filters applied on the retrieved product option values.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/page.mdx) \\| [BaseFilterable](../../../interfaces/product.BaseFilterable/page.mdx)<[FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/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":"([FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/page.mdx) \\| [BaseFilterable](../../../interfaces/product.BaseFilterable/page.mdx)<[FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/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":"([FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/page.mdx) \\| [BaseFilterable](../../../interfaces/product.BaseFilterable/page.mdx)<[FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/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":"Search through the option values' values.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter product options by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string` \\| `string`[]","description":"The values to filter product options by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"option_id","type":"`string` \\| `string`[]","description":"The Product Option IDs to filter product option values by.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/page.mdx) \\| [BaseFilterable](../../../interfaces/product.BaseFilterable/page.mdx)<[FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/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":"([FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/page.mdx) \\| [BaseFilterable](../../../interfaces/product.BaseFilterable/page.mdx)<[FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/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":"([FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/page.mdx) \\| [BaseFilterable](../../../interfaces/product.BaseFilterable/page.mdx)<[FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/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":"Search through the option values' values.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter product options by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string` \\| `string`[]","description":"The values to filter product options by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"option_id","type":"`string` \\| `string`[]","description":"The Product Option IDs to filter product option values by.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"q","type":"`string`","description":"Search through the option values' values.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[Line truncated
|
||||
|
||||
## Returns
|
||||
|
||||
|
||||
+1
-1
@@ -61,7 +61,7 @@ const options = await productModuleService.listProductOptionValues(
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/page.mdx)","description":"The filters applied on the retrieved product option values.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/page.mdx) \\| [BaseFilterable](../../../interfaces/product.BaseFilterable/page.mdx)<[FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/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":"([FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/page.mdx) \\| [BaseFilterable](../../../interfaces/product.BaseFilterable/page.mdx)<[FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/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":"([FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/page.mdx) \\| [BaseFilterable](../../../interfaces/product.BaseFilterable/page.mdx)<[FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/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":"Search through the option values' values.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter product options by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string` \\| `string`[]","description":"The values to filter product options by.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/page.mdx) \\| [BaseFilterable](../../../interfaces/product.BaseFilterable/page.mdx)<[FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/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":"([FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/page.mdx) \\| [BaseFilterable](../../../interfaces/product.BaseFilterable/page.mdx)<[FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/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":"([FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/page.mdx) \\| [BaseFilterable](../../../interfaces/product.BaseFilterable/page.mdx)<[FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/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":"Search through the option values' values.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter product options by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string` \\| `string`[]","description":"The values to filter product options by.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"q","type":"`string`","description":"Search through the option values' values.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter product options by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string` \\| `string`[]","description":"The values to filter product options by.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"config","type":"[FindConfig](../../../interfaces/product.FindConfig/page.mdx)<Line truncated
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/page.mdx)","description":"The filters applied on the retrieved product option values.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/page.mdx) \\| [BaseFilterable](../../../interfaces/product.BaseFilterable/page.mdx)<[FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/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":"([FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/page.mdx) \\| [BaseFilterable](../../../interfaces/product.BaseFilterable/page.mdx)<[FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/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":"([FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/page.mdx) \\| [BaseFilterable](../../../interfaces/product.BaseFilterable/page.mdx)<[FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/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":"Search through the option values' values.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter product options by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string` \\| `string`[]","description":"The values to filter product options by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"option_id","type":"`string` \\| `string`[]","description":"The Product Option IDs to filter product option values by.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/page.mdx) \\| [BaseFilterable](../../../interfaces/product.BaseFilterable/page.mdx)<[FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/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":"([FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/page.mdx) \\| [BaseFilterable](../../../interfaces/product.BaseFilterable/page.mdx)<[FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/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":"([FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/page.mdx) \\| [BaseFilterable](../../../interfaces/product.BaseFilterable/page.mdx)<[FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/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":"Search through the option values' values.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter product options by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string` \\| `string`[]","description":"The values to filter product options by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"option_id","type":"`string` \\| `string`[]","description":"The Product Option IDs to filter product option values by.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"q","type":"`string`","description":"Search through the option values' values.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[Line truncated
|
||||
|
||||
## Returns
|
||||
|
||||
|
||||
+1
-1
@@ -58,7 +58,7 @@ const options = await productModuleService.updateProductOptionValues(
|
||||
|
||||
### Parameters
|
||||
|
||||
<TypeList types={[{"name":"selector","type":"[FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/page.mdx)","description":"The filters specifying which options to update.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/page.mdx) \\| [BaseFilterable](../../../interfaces/product.BaseFilterable/page.mdx)<[FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/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":"([FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/page.mdx) \\| [BaseFilterable](../../../interfaces/product.BaseFilterable/page.mdx)<[FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/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":"([FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/page.mdx) \\| [BaseFilterable](../../../interfaces/product.BaseFilterable/page.mdx)<[FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/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":"Search through the option values' values.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter product options by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string` \\| `string`[]","description":"The values to filter product options by.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/page.mdx) \\| [BaseFilterable](../../../interfaces/product.BaseFilterable/page.mdx)<[FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/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":"([FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/page.mdx) \\| [BaseFilterable](../../../interfaces/product.BaseFilterable/page.mdx)<[FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/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":"([FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/page.mdx) \\| [BaseFilterable](../../../interfaces/product.BaseFilterable/page.mdx)<[FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/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":"Search through the option values' values.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter product options by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string` \\| `string`[]","description":"The values to filter product options by.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"q","type":"`string`","description":"Search through the option values' values.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter product options by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string` \\| `string`[]","description":"The values to filter product options by.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"data","type":"[UpdateProductOptionValueDTO](../../../interfaces/product.UpdateProductOptionVLine truncated
|
||||
<TypeList types={[{"name":"selector","type":"[FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/page.mdx)","description":"The filters specifying which options to update.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/page.mdx) \\| [BaseFilterable](../../../interfaces/product.BaseFilterable/page.mdx)<[FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/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":"([FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/page.mdx) \\| [BaseFilterable](../../../interfaces/product.BaseFilterable/page.mdx)<[FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/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":"([FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/page.mdx) \\| [BaseFilterable](../../../interfaces/product.BaseFilterable/page.mdx)<[FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/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":"Search through the option values' values.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter product options by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string` \\| `string`[]","description":"The values to filter product options by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"option_id","type":"`string` \\| `string`[]","description":"The Product Option IDs to filter product option values by.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/page.mdx) \\| [BaseFilterable](../../../interfaces/product.BaseFilterable/page.mdx)<[FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/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":"([FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/page.mdx) \\| [BaseFilterable](../../../interfaces/product.BaseFilterable/page.mdx)<[FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/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":"([FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/page.mdx) \\| [BaseFilterable](../../../interfaces/product.BaseFilterable/page.mdx)<[FilterableProductOptionValueProps](../../../interfaces/product.FilterableProductOptionValueProps/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":"Search through the option values' values.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter product options by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string` \\| `string`[]","description":"The values to filter product options by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"option_id","type":"`string` \\| `string`[]","description":"The Product Option IDs to filter product option values by.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"q","type":"`string`","description":"Search through the option values' values.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","descriLine truncated
|
||||
|
||||
### Returns
|
||||
|
||||
|
||||
+1
-1
@@ -8,4 +8,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
The filters to apply on retrieved product option values.
|
||||
|
||||
<TypeList types={[{"name":"$and","type":"([FilterableProductOptionValueProps](./page.mdx) \\| [BaseFilterable](../product.BaseFilterable/page.mdx)<[FilterableProductOptionValueProps](./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":"([FilterableProductOptionValueProps](./page.mdx) \\| [BaseFilterable](../product.BaseFilterable/page.mdx)<[FilterableProductOptionValueProps](./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":"([FilterableProductOptionValueProps](./page.mdx) \\| [BaseFilterable](../product.BaseFilterable/page.mdx)<[FilterableProductOptionValueProps](./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":"([FilterableProductOptionValueProps](./page.mdx) \\| [BaseFilterable](../product.BaseFilterable/page.mdx)<[FilterableProductOptionValueProps](./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":"Search through the option values' values.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter product options by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string` \\| `string`[]","description":"The values to filter product options by.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableProductOptionValueProps](./page.mdx) \\| [BaseFilterable](../product.BaseFilterable/page.mdx)<[FilterableProductOptionValueProps](./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":"([FilterableProductOptionValueProps](./page.mdx) \\| [BaseFilterable](../product.BaseFilterable/page.mdx)<[FilterableProductOptionValueProps](./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":"([FilterableProductOptionValueProps](./page.mdx) \\| [BaseFilterable](../product.BaseFilterable/page.mdx)<[FilterableProductOptionValueProps](./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":"Search through the option values' values.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter product options by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string` \\| `string`[]","description":"The values to filter product options by.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"q","type":"`string`","description":"Search through the option values' values.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter product options by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string` \\| `string`[]","description":"The values to filter product options by.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableProductOptionValueProps](./page.mdx) \\| [BaseFilterable](../product.BaseFilterable/page.mdx)<[FilterableProductOptionValueProps](./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":"([FilterableProductOptionValueProps](./page.mdx) \\| [BaseFilterable](../product.BaseFilterable/page.mdx)<[FilterableProductOptionValueProps](./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":"([FilterableProductOptionLine truncated
|
||||
<TypeList types={[{"name":"$and","type":"([FilterableProductOptionValueProps](./page.mdx) \\| [BaseFilterable](../product.BaseFilterable/page.mdx)<[FilterableProductOptionValueProps](./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":"([FilterableProductOptionValueProps](./page.mdx) \\| [BaseFilterable](../product.BaseFilterable/page.mdx)<[FilterableProductOptionValueProps](./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":"([FilterableProductOptionValueProps](./page.mdx) \\| [BaseFilterable](../product.BaseFilterable/page.mdx)<[FilterableProductOptionValueProps](./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":"([FilterableProductOptionValueProps](./page.mdx) \\| [BaseFilterable](../product.BaseFilterable/page.mdx)<[FilterableProductOptionValueProps](./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":"Search through the option values' values.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter product options by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string` \\| `string`[]","description":"The values to filter product options by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"option_id","type":"`string` \\| `string`[]","description":"The Product Option IDs to filter product option values by.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableProductOptionValueProps](./page.mdx) \\| [BaseFilterable](../product.BaseFilterable/page.mdx)<[FilterableProductOptionValueProps](./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":"([FilterableProductOptionValueProps](./page.mdx) \\| [BaseFilterable](../product.BaseFilterable/page.mdx)<[FilterableProductOptionValueProps](./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":"([FilterableProductOptionValueProps](./page.mdx) \\| [BaseFilterable](../product.BaseFilterable/page.mdx)<[FilterableProductOptionValueProps](./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":"Search through the option values' values.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter product options by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string` \\| `string`[]","description":"The values to filter product options by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"option_id","type":"`string` \\| `string`[]","description":"The Product Option IDs to filter product option values by.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"q","type":"`string`","description":"Search through the option values' values.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter product options by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string` \\| `string`[]","description":"The values to filter product options by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"option_id","type":"`string` \\| `string`[]","description":"The Product Option IDs to filter product option values by.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableProductOptionValueProps](./page.mdx) \\| [BaseFilterable](../product.BaseFilterable/page.mdx)<[FilterableProductOptionValueProps](./page.mdx)>)[]","description":"An array of filtLine truncated
|
||||
Reference in new issue
Block a user