chore(docs): Generated References (automated) (#11395)
Generated the following references: - `api_key` - `auth` - `cart` - `core_flows` - `currency` - `customer` - `fulfillment` - `inventory_next` - `js_sdk` - `medusa` - `medusa_config` - `modules` - `modules_sdk` - `notification` - `order` - `payment` - `payment_models` - `payment_provider` - `pricing` - `product` - `promotion` - `region` - `sales_channel` - `stock_location_next` - `store` - `tax` - `types` - `user` - `utils` Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com> Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
805 files changed
+304938
-312323
No files matched your search
+1
-1
@@ -44,7 +44,7 @@ const addresses = await cartModuleService.listAddresses(
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableAddressProps](../../../interfaces/cart.FilterableAddressProps/page.mdx)","description":"The filters to apply on the retrieved addresss.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the addresss by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([FilterableAddressProps](../../../interfaces/cart.FilterableAddressProps/page.mdx) \\| [BaseFilterable](../../../interfaces/cart.BaseFilterable/page.mdx)<[FilterableAddressProps](../../../interfaces/cart.FilterableAddressProps/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":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the addresss by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([FilterableAddressProps](../../../interfaces/cart.FilterableAddressProps/page.mdx) \\| [BaseFilterable](../../../interfaces/cart.BaseFilterable/page.mdx)<[FilterableAddressProps](../../../interfaces/cart.FilterableAddressProps/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":"([FilterableAddressProps](../../../interfaces/cart.FilterableAddressProps/page.mdx) \\| [BaseFilterable](../../../interfaces/cart.BaseFilterable/page.mdx)<[FilterableAddressProps](../../../interfaces/cart.FilterableAddressProps/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":"$or","type":"([FilterableAddressProps](../../../interfaces/cart.FilterableAddressProps/page.mdx) \\| [BaseFilterable](../../../interfaces/cart.BaseFilterable/page.mdx)<[FilterableAddressProps](../../../interfaces/cart.FilterableAddressProps/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":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the addresss by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([FilterableAddressProps](../../../interfaces/cart.FilterableAddressProps/page.mdx) \\| [BaseFilterable](../../../interfaces/cart.BaseFilterable/page.mdx)<[FilterableAddressProps](../../../interfaces/cart.FilterableAddressProps/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":"([FilterableAddressProps](../../../interfaces/cart.FilterableAddressProps/page.mdx) \\| [BaseFilterable](../../../interfaces/cart.BaseFilterable/page.mdx)<[FilterableAddressProps](../../../interfaces/cart.FilterableAddressProps/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":"config","type":"[FindConfig](../../../interfaces/cart.FindConfig/page.mdx)<[CartAddressDTO](../../../interfaces/cart.CartAddressDTO/page.mdx)>","description":"The configurations determining how the address is retrieved. Its properties, such as `select` or `relations`, accept the\nattributes or relations associated with a address.","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":"[FindConfigOrder](../../../types/cart.FindConfigOrder/page.mdx)","description":"An object used to specify how to sort the returned records. Its keys are the nameLine truncated
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableAddressProps](../../../interfaces/cart.FilterableAddressProps/page.mdx)","description":"The filters to apply on the retrieved addresss.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the addresss by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([FilterableAddressProps](../../../interfaces/cart.FilterableAddressProps/page.mdx) \\| [BaseFilterable](../../../interfaces/cart.BaseFilterable/page.mdx)<[FilterableAddressProps](../../../interfaces/cart.FilterableAddressProps/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":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the addresss by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([FilterableAddressProps](../../../interfaces/cart.FilterableAddressProps/page.mdx) \\| [BaseFilterable](../../../interfaces/cart.BaseFilterable/page.mdx)<[FilterableAddressProps](../../../interfaces/cart.FilterableAddressProps/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":"([FilterableAddressProps](../../../interfaces/cart.FilterableAddressProps/page.mdx) \\| [BaseFilterable](../../../interfaces/cart.BaseFilterable/page.mdx)<[FilterableAddressProps](../../../interfaces/cart.FilterableAddressProps/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":"$or","type":"([FilterableAddressProps](../../../interfaces/cart.FilterableAddressProps/page.mdx) \\| [BaseFilterable](../../../interfaces/cart.BaseFilterable/page.mdx)<[FilterableAddressProps](../../../interfaces/cart.FilterableAddressProps/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":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the addresss by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([FilterableAddressProps](../../../interfaces/cart.FilterableAddressProps/page.mdx) \\| [BaseFilterable](../../../interfaces/cart.BaseFilterable/page.mdx)<[FilterableAddressProps](../../../interfaces/cart.FilterableAddressProps/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":"([FilterableAddressProps](../../../interfaces/cart.FilterableAddressProps/page.mdx) \\| [BaseFilterable](../../../interfaces/cart.BaseFilterable/page.mdx)<[FilterableAddressProps](../../../interfaces/cart.FilterableAddressProps/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":"config","type":"[FindConfig](../../../interfaces/cart.FindConfig/page.mdx)<[CartAddressDTO](../../../interfaces/cart.CartAddressDTO/page.mdx)>","description":"The configurations determining how the address is retrieved. Its properties, such as `select` or `relations`, accept the\nattributes or relations associated with a address.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"select","type":"(`string` & `object` \\| 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":"[FindConfigOrder](../../../types/cart.FindConfigOrder/page.mdx)","description":"An object used to specify how to sort the returned records. Its keys aLine truncated
|
||||
|
||||
## Returns
|
||||
|
||||
|
||||
+1
-1
@@ -58,7 +58,7 @@ const [carts, count] = await cartModuleService.listAndCountCarts(
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableCartProps](../../../interfaces/cart.FilterableCartProps/page.mdx)","description":"The filters to apply on the retrieved carts.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the carts by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/cart.OperatorMap/page.mdx)<string>","description":"Filter the carts by the ID of their associated sales channel.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"[Query](../../../types/cart.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"[Query](../../../types/cart.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$eq","type":"[ExpandScalar](../../../types/cart.ExpandScalar/page.mdx)<T> \\| [ExpandScalar](../../../types/cart.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ne","type":"[ExpandScalar](../../../types/cart.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$in","type":"[ExpandScalar](../../../types/cart.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$nin","type":"[ExpandScalar](../../../types/cart.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$not","type":"[Query](../../../types/cart.Query/page.mdx)<T>","description":"API wrapper around the remoteQuery","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gt","type":"[ExpandScalar](../../../types/cart.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gte","type":"[ExpandScalar](../../../types/cart.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lt","type":"[ExpandScalar](../../../types/cart.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lte","type":"[ExpandScalar](../../../types/cart.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$like","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$re","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ilike","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$fulltext","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$overlap","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contains","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contained","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$exists","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customer_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/cart.OperatorMap/page.mdx)<string>","description":"Filter the carts by the ID of their associated customer.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"[Query](../../../types/cart.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"[Query](../../../types/cart.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$eq","type":"[ExpandScalar](../../../types/cart.ExpandScalar/page.mdx)<T> \\| [ExpandScalar](../../../types/cart.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ne","type":"[ExpandScalar](../../../types/cart.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$in","type":"[ExpandScalar](../../../types/cart.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$nin","type":"[ExpandScalar](../../../types/cart.ExpandScalar/page.mdx)<T>[]","dLine truncated
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableCartProps](../../../interfaces/cart.FilterableCartProps/page.mdx)","description":"The filters to apply on the retrieved carts.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the carts by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/cart.OperatorMap/page.mdx)<string>","description":"Filter the carts by the ID of their associated sales channel.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"[Query](../../../types/cart.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"[Query](../../../types/cart.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$eq","type":"[ExpandScalar](../../../types/cart.ExpandScalar/page.mdx)<T> \\| [ExpandScalar](../../../types/cart.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ne","type":"[ExpandScalar](../../../types/cart.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$in","type":"[ExpandScalar](../../../types/cart.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$nin","type":"[ExpandScalar](../../../types/cart.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$not","type":"[Query](../../../types/cart.Query/page.mdx)<T>","description":"API wrapper around the remoteQuery","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gt","type":"[ExpandScalar](../../../types/cart.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gte","type":"[ExpandScalar](../../../types/cart.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lt","type":"[ExpandScalar](../../../types/cart.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lte","type":"[ExpandScalar](../../../types/cart.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$like","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$re","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ilike","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$fulltext","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$overlap","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contains","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contained","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$exists","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customer_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/cart.OperatorMap/page.mdx)<string>","description":"Filter the carts by the ID of their associated customer.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"[Query](../../../types/cart.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"[Query](../../../types/cart.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$eq","type":"[ExpandScalar](../../../types/cart.ExpandScalar/page.mdx)<T> \\| [ExpandScalar](../../../types/cart.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ne","type":"[ExpandScalar](../../../types/cart.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$in","type":"[ExpandScalar](../../../types/cart.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$nin","type":"[ExpandScalar](../../../types/cart.ExpandScalar/page.mdx)<T>[]","dLine truncated
|
||||
|
||||
## Returns
|
||||
|
||||
|
||||
+1
-1
@@ -58,7 +58,7 @@ const carts = await cartModuleService.listCarts(
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableCartProps](../../../interfaces/cart.FilterableCartProps/page.mdx)","description":"The filters to apply on the retrieved carts.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the carts by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/cart.OperatorMap/page.mdx)<string>","description":"Filter the carts by the ID of their associated sales channel.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"[Query](../../../types/cart.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"[Query](../../../types/cart.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$eq","type":"[ExpandScalar](../../../types/cart.ExpandScalar/page.mdx)<T> \\| [ExpandScalar](../../../types/cart.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ne","type":"[ExpandScalar](../../../types/cart.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$in","type":"[ExpandScalar](../../../types/cart.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$nin","type":"[ExpandScalar](../../../types/cart.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$not","type":"[Query](../../../types/cart.Query/page.mdx)<T>","description":"API wrapper around the remoteQuery","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gt","type":"[ExpandScalar](../../../types/cart.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gte","type":"[ExpandScalar](../../../types/cart.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lt","type":"[ExpandScalar](../../../types/cart.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lte","type":"[ExpandScalar](../../../types/cart.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$like","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$re","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ilike","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$fulltext","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$overlap","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contains","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contained","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$exists","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customer_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/cart.OperatorMap/page.mdx)<string>","description":"Filter the carts by the ID of their associated customer.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"[Query](../../../types/cart.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"[Query](../../../types/cart.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$eq","type":"[ExpandScalar](../../../types/cart.ExpandScalar/page.mdx)<T> \\| [ExpandScalar](../../../types/cart.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ne","type":"[ExpandScalar](../../../types/cart.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$in","type":"[ExpandScalar](../../../types/cart.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$nin","type":"[ExpandScalar](../../../types/cart.ExpandScalar/page.mdx)<T>[]","dLine truncated
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableCartProps](../../../interfaces/cart.FilterableCartProps/page.mdx)","description":"The filters to apply on the retrieved carts.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the carts by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/cart.OperatorMap/page.mdx)<string>","description":"Filter the carts by the ID of their associated sales channel.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"[Query](../../../types/cart.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"[Query](../../../types/cart.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$eq","type":"[ExpandScalar](../../../types/cart.ExpandScalar/page.mdx)<T> \\| [ExpandScalar](../../../types/cart.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ne","type":"[ExpandScalar](../../../types/cart.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$in","type":"[ExpandScalar](../../../types/cart.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$nin","type":"[ExpandScalar](../../../types/cart.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$not","type":"[Query](../../../types/cart.Query/page.mdx)<T>","description":"API wrapper around the remoteQuery","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gt","type":"[ExpandScalar](../../../types/cart.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gte","type":"[ExpandScalar](../../../types/cart.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lt","type":"[ExpandScalar](../../../types/cart.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lte","type":"[ExpandScalar](../../../types/cart.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$like","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$re","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ilike","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$fulltext","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$overlap","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contains","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contained","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$exists","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customer_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/cart.OperatorMap/page.mdx)<string>","description":"Filter the carts by the ID of their associated customer.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"[Query](../../../types/cart.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"[Query](../../../types/cart.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$eq","type":"[ExpandScalar](../../../types/cart.ExpandScalar/page.mdx)<T> \\| [ExpandScalar](../../../types/cart.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ne","type":"[ExpandScalar](../../../types/cart.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$in","type":"[ExpandScalar](../../../types/cart.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$nin","type":"[ExpandScalar](../../../types/cart.ExpandScalar/page.mdx)<T>[]","dLine truncated
|
||||
|
||||
## Returns
|
||||
|
||||
|
||||
+1
-1
@@ -61,7 +61,7 @@ const lineItemAdjustments =
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableLineItemAdjustmentProps](../../../interfaces/cart.FilterableLineItemAdjustmentProps/page.mdx)","description":"The filters to apply on the retrieved line item adjustments.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the line item adjustments by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string` \\| `string`[]","description":"Filter the adjustments by the ID of their associated line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"promotion_id","type":"`string` \\| `string`[]","description":"Filter the line item adjustments by the ID of their associated promotion.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string` \\| `string`[]","description":"Filter the line item adjustments by the ID of their associated provider.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"[FilterableLineItemProps](../../../interfaces/cart.FilterableLineItemProps/page.mdx)","description":"Filter the adjustments by their associated line item.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the line items by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"cart_id","type":"`string` \\| `string`[]","description":"Filter the line items by the ID of their associated cart.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"Filter the line items by their title.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_id","type":"`string` \\| `string`[]","description":"Filter the line items by the ID of their associated variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`string` \\| `string`[]","description":"Filter the line items by the ID of their associated product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([FilterableLineItemProps](../../../interfaces/cart.FilterableLineItemProps/page.mdx) \\| [BaseFilterable](../../../interfaces/cart.BaseFilterable/page.mdx)<[FilterableLineItemProps](../../../interfaces/cart.FilterableLineItemProps/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":"([FilterableLineItemProps](../../../interfaces/cart.FilterableLineItemProps/page.mdx) \\| [BaseFilterable](../../../interfaces/cart.BaseFilterable/page.mdx)<[FilterableLineItemProps](../../../interfaces/cart.FilterableLineItemProps/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":"([FilterableLineItemAdjustmentProps](../../../interfaces/cart.FilterableLineItemAdjustmentProps/page.mdx) \\| [BaseFilterable](../../../interfaces/cart.BaseFilterable/page.mdx)<[FilterableLineItemAdjustmentProps](../../../interfaces/cart.FilterableLineItemAdjustmentProps/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":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the line item adjustments by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string` \\| `string`[]","description":"Filter the adjustments by the ID of their associated line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"promotion_id","type":"`string` \\| `string`[]","description":"Filter the line item adjustments by the ID of their associated promotion.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string` \\| `string`[]","description":"Filter the line item adjustments by the ID of their associated provider.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"[FilterableLineItemProps](../../../interfaces/cart.FilterableLineItemProps/page.mdx)","description":"Filter the adjustments by their associated line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([FilterableLineItemAdjustmentProps](../../../interfaces/cart.FilterableLineItemAdjustmentProps/page.mdx) \\| [BaseFilterable](../../../interfaces/cart.BaseFilterable/page.mdx)<[FilterableLineItemAdjustmentProps](..Line truncated
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableLineItemAdjustmentProps](../../../interfaces/cart.FilterableLineItemAdjustmentProps/page.mdx)","description":"The filters to apply on the retrieved line item adjustments.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the line item adjustments by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string` \\| `string`[]","description":"Filter the adjustments by the ID of their associated line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"promotion_id","type":"`string` \\| `string`[]","description":"Filter the line item adjustments by the ID of their associated promotion.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string` \\| `string`[]","description":"Filter the line item adjustments by the ID of their associated provider.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"[FilterableLineItemProps](../../../interfaces/cart.FilterableLineItemProps/page.mdx)","description":"Filter the adjustments by their associated line item.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the line items by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"cart_id","type":"`string` \\| `string`[]","description":"Filter the line items by the ID of their associated cart.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"Filter the line items by their title.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_id","type":"`string` \\| `string`[]","description":"Filter the line items by the ID of their associated variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`string` \\| `string`[]","description":"Filter the line items by the ID of their associated product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([FilterableLineItemProps](../../../interfaces/cart.FilterableLineItemProps/page.mdx) \\| [BaseFilterable](../../../interfaces/cart.BaseFilterable/page.mdx)<[FilterableLineItemProps](../../../interfaces/cart.FilterableLineItemProps/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":"([FilterableLineItemProps](../../../interfaces/cart.FilterableLineItemProps/page.mdx) \\| [BaseFilterable](../../../interfaces/cart.BaseFilterable/page.mdx)<[FilterableLineItemProps](../../../interfaces/cart.FilterableLineItemProps/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":"([FilterableLineItemAdjustmentProps](../../../interfaces/cart.FilterableLineItemAdjustmentProps/page.mdx) \\| [BaseFilterable](../../../interfaces/cart.BaseFilterable/page.mdx)<[FilterableLineItemAdjustmentProps](../../../interfaces/cart.FilterableLineItemAdjustmentProps/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":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the line item adjustments by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string` \\| `string`[]","description":"Filter the adjustments by the ID of their associated line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"promotion_id","type":"`string` \\| `string`[]","description":"Filter the line item adjustments by the ID of their associated promotion.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string` \\| `string`[]","description":"Filter the line item adjustments by the ID of their associated provider.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"[FilterableLineItemProps](../../../interfaces/cart.FilterableLineItemProps/page.mdx)","description":"Filter the adjustments by their associated line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([FilterableLineItemAdjustmentProps](../../../interfaces/cart.FilterableLineItemAdjustmentProps/page.mdx) \\| [BaseFilterable](../../../interfaces/cart.BaseFilterable/page.mdx)<[FilterableLineItemAdjustmentProps](..Line truncated
|
||||
|
||||
## Returns
|
||||
|
||||
|
||||
+1
-1
@@ -61,7 +61,7 @@ const lineItemTaxLines =
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableLineItemTaxLineProps](../../../interfaces/cart.FilterableLineItemTaxLineProps/page.mdx)","description":"The filters to apply on the retrieved line item tax lines.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the line item tax lines by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"Filter the line item tax lines by their description.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string` \\| `string`[]","description":"Filter the line item tax lines by their code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate_id","type":"`string` \\| `string`[]","description":"Filter the line item tax lines by the ID of their associated tax rate.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string` \\| `string`[]","description":"Filter the line item tax lines by the ID of their associated provider.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string` \\| `string`[]","description":"Filter the tax lines by the ID of their associated line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"[FilterableLineItemProps](../../../interfaces/cart.FilterableLineItemProps/page.mdx)","description":"Filter the tax lines by their associated line item.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the line items by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"cart_id","type":"`string` \\| `string`[]","description":"Filter the line items by the ID of their associated cart.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"Filter the line items by their title.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_id","type":"`string` \\| `string`[]","description":"Filter the line items by the ID of their associated variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`string` \\| `string`[]","description":"Filter the line items by the ID of their associated product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([FilterableLineItemProps](../../../interfaces/cart.FilterableLineItemProps/page.mdx) \\| [BaseFilterable](../../../interfaces/cart.BaseFilterable/page.mdx)<[FilterableLineItemProps](../../../interfaces/cart.FilterableLineItemProps/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":"([FilterableLineItemProps](../../../interfaces/cart.FilterableLineItemProps/page.mdx) \\| [BaseFilterable](../../../interfaces/cart.BaseFilterable/page.mdx)<[FilterableLineItemProps](../../../interfaces/cart.FilterableLineItemProps/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":"([FilterableLineItemTaxLineProps](../../../interfaces/cart.FilterableLineItemTaxLineProps/page.mdx) \\| [BaseFilterable](../../../interfaces/cart.BaseFilterable/page.mdx)<[FilterableLineItemTaxLineProps](../../../interfaces/cart.FilterableLineItemTaxLineProps/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":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the line item tax lines by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"Filter the line item tax lines by their description.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string` \\| `string`[]","description":"Filter the line item tax lines by their code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate_id","type":"`string` \\| `string`[]","description":"Filter the line item tax lines by the ID of their associated tax rate.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string` \\| `string`[]","description":"Filter the line item tax lines by the ID of their associated provider.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id",Line truncated
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableLineItemTaxLineProps](../../../interfaces/cart.FilterableLineItemTaxLineProps/page.mdx)","description":"The filters to apply on the retrieved line item tax lines.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the line item tax lines by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"Filter the line item tax lines by their description.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string` \\| `string`[]","description":"Filter the line item tax lines by their code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate_id","type":"`string` \\| `string`[]","description":"Filter the line item tax lines by the ID of their associated tax rate.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string` \\| `string`[]","description":"Filter the line item tax lines by the ID of their associated provider.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string` \\| `string`[]","description":"Filter the tax lines by the ID of their associated line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"[FilterableLineItemProps](../../../interfaces/cart.FilterableLineItemProps/page.mdx)","description":"Filter the tax lines by their associated line item.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the line items by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"cart_id","type":"`string` \\| `string`[]","description":"Filter the line items by the ID of their associated cart.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"Filter the line items by their title.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_id","type":"`string` \\| `string`[]","description":"Filter the line items by the ID of their associated variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`string` \\| `string`[]","description":"Filter the line items by the ID of their associated product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([FilterableLineItemProps](../../../interfaces/cart.FilterableLineItemProps/page.mdx) \\| [BaseFilterable](../../../interfaces/cart.BaseFilterable/page.mdx)<[FilterableLineItemProps](../../../interfaces/cart.FilterableLineItemProps/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":"([FilterableLineItemProps](../../../interfaces/cart.FilterableLineItemProps/page.mdx) \\| [BaseFilterable](../../../interfaces/cart.BaseFilterable/page.mdx)<[FilterableLineItemProps](../../../interfaces/cart.FilterableLineItemProps/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":"([FilterableLineItemTaxLineProps](../../../interfaces/cart.FilterableLineItemTaxLineProps/page.mdx) \\| [BaseFilterable](../../../interfaces/cart.BaseFilterable/page.mdx)<[FilterableLineItemTaxLineProps](../../../interfaces/cart.FilterableLineItemTaxLineProps/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":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the line item tax lines by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"Filter the line item tax lines by their description.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string` \\| `string`[]","description":"Filter the line item tax lines by their code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate_id","type":"`string` \\| `string`[]","description":"Filter the line item tax lines by the ID of their associated tax rate.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string` \\| `string`[]","description":"Filter the line item tax lines by the ID of their associated provider.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id",Line truncated
|
||||
|
||||
## Returns
|
||||
|
||||
|
||||
+1
-1
@@ -58,7 +58,7 @@ const lineItems = await cartModuleService.listLineItems(
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableLineItemProps](../../../interfaces/cart.FilterableLineItemProps/page.mdx)","description":"The filters to apply on the retrieved line items.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the line items by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"cart_id","type":"`string` \\| `string`[]","description":"Filter the line items by the ID of their associated cart.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"Filter the line items by their title.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_id","type":"`string` \\| `string`[]","description":"Filter the line items by the ID of their associated variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`string` \\| `string`[]","description":"Filter the line items by the ID of their associated product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([FilterableLineItemProps](../../../interfaces/cart.FilterableLineItemProps/page.mdx) \\| [BaseFilterable](../../../interfaces/cart.BaseFilterable/page.mdx)<[FilterableLineItemProps](../../../interfaces/cart.FilterableLineItemProps/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":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the line items by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"cart_id","type":"`string` \\| `string`[]","description":"Filter the line items by the ID of their associated cart.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"Filter the line items by their title.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_id","type":"`string` \\| `string`[]","description":"Filter the line items by the ID of their associated variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`string` \\| `string`[]","description":"Filter the line items by the ID of their associated product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([FilterableLineItemProps](../../../interfaces/cart.FilterableLineItemProps/page.mdx) \\| [BaseFilterable](../../../interfaces/cart.BaseFilterable/page.mdx)<[FilterableLineItemProps](../../../interfaces/cart.FilterableLineItemProps/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":"([FilterableLineItemProps](../../../interfaces/cart.FilterableLineItemProps/page.mdx) \\| [BaseFilterable](../../../interfaces/cart.BaseFilterable/page.mdx)<[FilterableLineItemProps](../../../interfaces/cart.FilterableLineItemProps/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":"$or","type":"([FilterableLineItemProps](../../../interfaces/cart.FilterableLineItemProps/page.mdx) \\| [BaseFilterable](../../../interfaces/cart.BaseFilterable/page.mdx)<[FilterableLineItemProps](../../../interfaces/cart.FilterableLineItemProps/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":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the line items by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"cart_id","type":"`string` \\| `string`[]","description":"Filter the line items by the ID of their associated cart.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"Filter the line items by their title.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_id","type":"`string` \\| `string`[]","description":"Filter the line items by the ID of their associated variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`string` \\| `string`[]","description":"Filter the line items by the ID of their associated product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([FilterableLineItemProps](../../../interfaces/cart.FilterableLineItemProps/page.mdx) \\| [BLine truncated
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableLineItemProps](../../../interfaces/cart.FilterableLineItemProps/page.mdx)","description":"The filters to apply on the retrieved line items.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the line items by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"cart_id","type":"`string` \\| `string`[]","description":"Filter the line items by the ID of their associated cart.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"Filter the line items by their title.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_id","type":"`string` \\| `string`[]","description":"Filter the line items by the ID of their associated variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`string` \\| `string`[]","description":"Filter the line items by the ID of their associated product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([FilterableLineItemProps](../../../interfaces/cart.FilterableLineItemProps/page.mdx) \\| [BaseFilterable](../../../interfaces/cart.BaseFilterable/page.mdx)<[FilterableLineItemProps](../../../interfaces/cart.FilterableLineItemProps/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":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the line items by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"cart_id","type":"`string` \\| `string`[]","description":"Filter the line items by the ID of their associated cart.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"Filter the line items by their title.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_id","type":"`string` \\| `string`[]","description":"Filter the line items by the ID of their associated variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`string` \\| `string`[]","description":"Filter the line items by the ID of their associated product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([FilterableLineItemProps](../../../interfaces/cart.FilterableLineItemProps/page.mdx) \\| [BaseFilterable](../../../interfaces/cart.BaseFilterable/page.mdx)<[FilterableLineItemProps](../../../interfaces/cart.FilterableLineItemProps/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":"([FilterableLineItemProps](../../../interfaces/cart.FilterableLineItemProps/page.mdx) \\| [BaseFilterable](../../../interfaces/cart.BaseFilterable/page.mdx)<[FilterableLineItemProps](../../../interfaces/cart.FilterableLineItemProps/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":"$or","type":"([FilterableLineItemProps](../../../interfaces/cart.FilterableLineItemProps/page.mdx) \\| [BaseFilterable](../../../interfaces/cart.BaseFilterable/page.mdx)<[FilterableLineItemProps](../../../interfaces/cart.FilterableLineItemProps/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":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the line items by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"cart_id","type":"`string` \\| `string`[]","description":"Filter the line items by the ID of their associated cart.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"Filter the line items by their title.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_id","type":"`string` \\| `string`[]","description":"Filter the line items by the ID of their associated variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`string` \\| `string`[]","description":"Filter the line items by the ID of their associated product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([FilterableLineItemProps](../../../interfaces/cart.FilterableLineItemProps/page.mdx) \\| [BLine truncated
|
||||
|
||||
## Returns
|
||||
|
||||
|
||||
+1
-1
@@ -61,7 +61,7 @@ const shippingMethodAdjustments =
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableShippingMethodAdjustmentProps](../../../interfaces/cart.FilterableShippingMethodAdjustmentProps/page.mdx)","description":"The filters to apply on the retrieved shipping method adjustments.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the shipping method adjustments by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_method_id","type":"`string` \\| `string`[]","description":"Filter the adjustments by the ID of their associated shipping method.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"promotion_id","type":"`string` \\| `string`[]","description":"Filter the shipping method adjustments by the ID of their associated promotion.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string` \\| `string`[]","description":"Filter the shipping method adjustments by the ID of their associated provider.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_method","type":"[FilterableShippingMethodProps](../../../interfaces/cart.FilterableShippingMethodProps/page.mdx)","description":"Filter the adjustments by their associated shipping method.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the shipping methods by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"cart_id","type":"`string` \\| `string`[]","description":"Filter the shipping methods by the ID of their associated cart.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"Filter the shipping methods by their name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/cart.OperatorMap/page.mdx)<string>","description":"Filter the shipping methods by the ID of their associated shipping option.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([FilterableShippingMethodProps](../../../interfaces/cart.FilterableShippingMethodProps/page.mdx) \\| [BaseFilterable](../../../interfaces/cart.BaseFilterable/page.mdx)<[FilterableShippingMethodProps](../../../interfaces/cart.FilterableShippingMethodProps/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":"([FilterableShippingMethodProps](../../../interfaces/cart.FilterableShippingMethodProps/page.mdx) \\| [BaseFilterable](../../../interfaces/cart.BaseFilterable/page.mdx)<[FilterableShippingMethodProps](../../../interfaces/cart.FilterableShippingMethodProps/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":"([FilterableShippingMethodAdjustmentProps](../../../interfaces/cart.FilterableShippingMethodAdjustmentProps/page.mdx) \\| [BaseFilterable](../../../interfaces/cart.BaseFilterable/page.mdx)<[FilterableShippingMethodAdjustmentProps](../../../interfaces/cart.FilterableShippingMethodAdjustmentProps/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":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the shipping method adjustments by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_method_id","type":"`string` \\| `string`[]","description":"Filter the adjustments by the ID of their associated shipping method.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"promotion_id","type":"`string` \\| `string`[]","description":"Filter the shipping method adjustments by the ID of their associated promotion.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string` \\| `string`[]","description":"Filter the shipping method adjustments by the ID of their associated provider.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_method","type":"[FilterableShippingMethodProps](../../../interfaces/cart.FilterableShippingMethodProps/page.mdx)","description":"Filter the adjustments by their associated shipping method.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([FilterableShippingMethodAdjustmentProps](../../../interfaces/cart.FilterableShippingLine truncated
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableShippingMethodAdjustmentProps](../../../interfaces/cart.FilterableShippingMethodAdjustmentProps/page.mdx)","description":"The filters to apply on the retrieved shipping method adjustments.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the shipping method adjustments by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_method_id","type":"`string` \\| `string`[]","description":"Filter the adjustments by the ID of their associated shipping method.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"promotion_id","type":"`string` \\| `string`[]","description":"Filter the shipping method adjustments by the ID of their associated promotion.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string` \\| `string`[]","description":"Filter the shipping method adjustments by the ID of their associated provider.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_method","type":"[FilterableShippingMethodProps](../../../interfaces/cart.FilterableShippingMethodProps/page.mdx)","description":"Filter the adjustments by their associated shipping method.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the shipping methods by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"cart_id","type":"`string` \\| `string`[]","description":"Filter the shipping methods by the ID of their associated cart.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"Filter the shipping methods by their name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/cart.OperatorMap/page.mdx)<string>","description":"Filter the shipping methods by the ID of their associated shipping option.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([FilterableShippingMethodProps](../../../interfaces/cart.FilterableShippingMethodProps/page.mdx) \\| [BaseFilterable](../../../interfaces/cart.BaseFilterable/page.mdx)<[FilterableShippingMethodProps](../../../interfaces/cart.FilterableShippingMethodProps/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":"([FilterableShippingMethodProps](../../../interfaces/cart.FilterableShippingMethodProps/page.mdx) \\| [BaseFilterable](../../../interfaces/cart.BaseFilterable/page.mdx)<[FilterableShippingMethodProps](../../../interfaces/cart.FilterableShippingMethodProps/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":"([FilterableShippingMethodAdjustmentProps](../../../interfaces/cart.FilterableShippingMethodAdjustmentProps/page.mdx) \\| [BaseFilterable](../../../interfaces/cart.BaseFilterable/page.mdx)<[FilterableShippingMethodAdjustmentProps](../../../interfaces/cart.FilterableShippingMethodAdjustmentProps/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":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the shipping method adjustments by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_method_id","type":"`string` \\| `string`[]","description":"Filter the adjustments by the ID of their associated shipping method.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"promotion_id","type":"`string` \\| `string`[]","description":"Filter the shipping method adjustments by the ID of their associated promotion.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string` \\| `string`[]","description":"Filter the shipping method adjustments by the ID of their associated provider.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_method","type":"[FilterableShippingMethodProps](../../../interfaces/cart.FilterableShippingMethodProps/page.mdx)","description":"Filter the adjustments by their associated shipping method.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([FilterableShippingMethodAdjustmentProps](../../../interfaces/cart.FilterableShippingLine truncated
|
||||
|
||||
## Returns
|
||||
|
||||
|
||||
+1
-1
@@ -61,7 +61,7 @@ const shippingMethodTaxLines =
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableShippingMethodTaxLineProps](../../../interfaces/cart.FilterableShippingMethodTaxLineProps/page.mdx)","description":"The filters to apply on the retrieved shipping method tax lines.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the shipping method tax lines by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"Filter the shipping method tax lines by their description.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string` \\| `string`[]","description":"Filter the shipping method tax lines by their code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate_id","type":"`string` \\| `string`[]","description":"Filter the shipping method tax lines by the ID of their associated tax rate.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string` \\| `string`[]","description":"Filter the shipping method tax lines by the ID of their associated provider.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_method_id","type":"`string` \\| `string`[]","description":"Filter the tax lines by the ID of their associated shipping method.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_method","type":"[FilterableShippingMethodProps](../../../interfaces/cart.FilterableShippingMethodProps/page.mdx)","description":"Filter the tax lines by their associated shipping method.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the shipping methods by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"cart_id","type":"`string` \\| `string`[]","description":"Filter the shipping methods by the ID of their associated cart.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"Filter the shipping methods by their name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/cart.OperatorMap/page.mdx)<string>","description":"Filter the shipping methods by the ID of their associated shipping option.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([FilterableShippingMethodProps](../../../interfaces/cart.FilterableShippingMethodProps/page.mdx) \\| [BaseFilterable](../../../interfaces/cart.BaseFilterable/page.mdx)<[FilterableShippingMethodProps](../../../interfaces/cart.FilterableShippingMethodProps/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":"([FilterableShippingMethodProps](../../../interfaces/cart.FilterableShippingMethodProps/page.mdx) \\| [BaseFilterable](../../../interfaces/cart.BaseFilterable/page.mdx)<[FilterableShippingMethodProps](../../../interfaces/cart.FilterableShippingMethodProps/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":"([FilterableShippingMethodTaxLineProps](../../../interfaces/cart.FilterableShippingMethodTaxLineProps/page.mdx) \\| [BaseFilterable](../../../interfaces/cart.BaseFilterable/page.mdx)<[FilterableShippingMethodTaxLineProps](../../../interfaces/cart.FilterableShippingMethodTaxLineProps/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":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the shipping method tax lines by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"Filter the shipping method tax lines by their description.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string` \\| `string`[]","description":"Filter the shipping method tax lines by their code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate_id","type":"`string` \\| `string`[]","description":"Filter the shipping method tax lines by the ID of their associated tax rate.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string` \\| `string`[]","description":"Filter the shipping method tax lines by the ID of theLine truncated
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableShippingMethodTaxLineProps](../../../interfaces/cart.FilterableShippingMethodTaxLineProps/page.mdx)","description":"The filters to apply on the retrieved shipping method tax lines.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the shipping method tax lines by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"Filter the shipping method tax lines by their description.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string` \\| `string`[]","description":"Filter the shipping method tax lines by their code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate_id","type":"`string` \\| `string`[]","description":"Filter the shipping method tax lines by the ID of their associated tax rate.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string` \\| `string`[]","description":"Filter the shipping method tax lines by the ID of their associated provider.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_method_id","type":"`string` \\| `string`[]","description":"Filter the tax lines by the ID of their associated shipping method.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_method","type":"[FilterableShippingMethodProps](../../../interfaces/cart.FilterableShippingMethodProps/page.mdx)","description":"Filter the tax lines by their associated shipping method.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the shipping methods by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"cart_id","type":"`string` \\| `string`[]","description":"Filter the shipping methods by the ID of their associated cart.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"Filter the shipping methods by their name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/cart.OperatorMap/page.mdx)<string>","description":"Filter the shipping methods by the ID of their associated shipping option.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([FilterableShippingMethodProps](../../../interfaces/cart.FilterableShippingMethodProps/page.mdx) \\| [BaseFilterable](../../../interfaces/cart.BaseFilterable/page.mdx)<[FilterableShippingMethodProps](../../../interfaces/cart.FilterableShippingMethodProps/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":"([FilterableShippingMethodProps](../../../interfaces/cart.FilterableShippingMethodProps/page.mdx) \\| [BaseFilterable](../../../interfaces/cart.BaseFilterable/page.mdx)<[FilterableShippingMethodProps](../../../interfaces/cart.FilterableShippingMethodProps/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":"([FilterableShippingMethodTaxLineProps](../../../interfaces/cart.FilterableShippingMethodTaxLineProps/page.mdx) \\| [BaseFilterable](../../../interfaces/cart.BaseFilterable/page.mdx)<[FilterableShippingMethodTaxLineProps](../../../interfaces/cart.FilterableShippingMethodTaxLineProps/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":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the shipping method tax lines by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"Filter the shipping method tax lines by their description.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string` \\| `string`[]","description":"Filter the shipping method tax lines by their code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate_id","type":"`string` \\| `string`[]","description":"Filter the shipping method tax lines by the ID of their associated tax rate.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string` \\| `string`[]","description":"Filter the shipping method tax lines by the ID of theLine truncated
|
||||
|
||||
## Returns
|
||||
|
||||
|
||||
+1
-1
@@ -64,7 +64,7 @@ const shippingMethods =
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableShippingMethodProps](../../../interfaces/cart.FilterableShippingMethodProps/page.mdx)","description":"The filters to apply on the retrieved shipping methods.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the shipping methods by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"cart_id","type":"`string` \\| `string`[]","description":"Filter the shipping methods by the ID of their associated cart.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"Filter the shipping methods by their name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/cart.OperatorMap/page.mdx)<string>","description":"Filter the shipping methods by the ID of their associated shipping option.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"[Query](../../../types/cart.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"[Query](../../../types/cart.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$eq","type":"[ExpandScalar](../../../types/cart.ExpandScalar/page.mdx)<T> \\| [ExpandScalar](../../../types/cart.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ne","type":"[ExpandScalar](../../../types/cart.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$in","type":"[ExpandScalar](../../../types/cart.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$nin","type":"[ExpandScalar](../../../types/cart.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$not","type":"[Query](../../../types/cart.Query/page.mdx)<T>","description":"API wrapper around the remoteQuery","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gt","type":"[ExpandScalar](../../../types/cart.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gte","type":"[ExpandScalar](../../../types/cart.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lt","type":"[ExpandScalar](../../../types/cart.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lte","type":"[ExpandScalar](../../../types/cart.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$like","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$re","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ilike","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$fulltext","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$overlap","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contains","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contained","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$exists","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$and","type":"([FilterableShippingMethodProps](../../../interfaces/cart.FilterableShippingMethodProps/page.mdx) \\| [BaseFilterable](../../../interfaces/cart.BaseFilterable/page.mdx)<[FilterableShippingMethodProps](../../../interfaces/cart.FilterableShippingMethodProps/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":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the shipping methods by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"cart_id","type":"`string` \\| `string`[]","description":"Filter the shipping methods by the ID of their associated cart.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"Line truncated
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableShippingMethodProps](../../../interfaces/cart.FilterableShippingMethodProps/page.mdx)","description":"The filters to apply on the retrieved shipping methods.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the shipping methods by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"cart_id","type":"`string` \\| `string`[]","description":"Filter the shipping methods by the ID of their associated cart.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"Filter the shipping methods by their name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/cart.OperatorMap/page.mdx)<string>","description":"Filter the shipping methods by the ID of their associated shipping option.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"[Query](../../../types/cart.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"[Query](../../../types/cart.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$eq","type":"[ExpandScalar](../../../types/cart.ExpandScalar/page.mdx)<T> \\| [ExpandScalar](../../../types/cart.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ne","type":"[ExpandScalar](../../../types/cart.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$in","type":"[ExpandScalar](../../../types/cart.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$nin","type":"[ExpandScalar](../../../types/cart.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$not","type":"[Query](../../../types/cart.Query/page.mdx)<T>","description":"API wrapper around the remoteQuery","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gt","type":"[ExpandScalar](../../../types/cart.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gte","type":"[ExpandScalar](../../../types/cart.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lt","type":"[ExpandScalar](../../../types/cart.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lte","type":"[ExpandScalar](../../../types/cart.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$like","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$re","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ilike","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$fulltext","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$overlap","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contains","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contained","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$exists","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$and","type":"([FilterableShippingMethodProps](../../../interfaces/cart.FilterableShippingMethodProps/page.mdx) \\| [BaseFilterable](../../../interfaces/cart.BaseFilterable/page.mdx)<[FilterableShippingMethodProps](../../../interfaces/cart.FilterableShippingMethodProps/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":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the shipping methods by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"cart_id","type":"`string` \\| `string`[]","description":"Filter the shipping methods by the ID of their associated cart.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"Line truncated
|
||||
|
||||
## Returns
|
||||
|
||||
|
||||
+1
-1
@@ -36,7 +36,7 @@ const cart = await cartModuleService.retrieveCart("cart_123", {
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"cartId","type":"`string`","description":"The cart's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../../interfaces/cart.FindConfig/page.mdx)<[CartDTO](../../../interfaces/cart.CartDTO/page.mdx)>","description":"The configurations determining how the cart is retrieved. Its properties, such as `select` or `relations`, accept the\nattributes or relations associated with a cart.","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":"[FindConfigOrder](../../../types/cart.FindConfigOrder/page.mdx)","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":"sharedContext","type":"[Context](../../../interfaces/cart.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/cart.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 idempotencyKey of the parent workflow execution.","Line truncated
|
||||
<TypeList types={[{"name":"cartId","type":"`string`","description":"The cart's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../../interfaces/cart.FindConfig/page.mdx)<[CartDTO](../../../interfaces/cart.CartDTO/page.mdx)>","description":"The configurations determining how the cart is retrieved. Its properties, such as `select` or `relations`, accept the\nattributes or relations associated with a cart.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"select","type":"(`string` & `object` \\| 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":"[FindConfigOrder](../../../types/cart.FindConfigOrder/page.mdx)","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":"sharedContext","type":"[Context](../../../interfaces/cart.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/cart.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 idempotencyKey of the parent workflow exLine truncated
|
||||
|
||||
## Returns
|
||||
|
||||
|
||||
+1
-1
@@ -40,7 +40,7 @@ const lineItem = await cartModuleService.retrieveLineItem(
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"itemId","type":"`string`","description":"The item's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../../interfaces/cart.FindConfig/page.mdx)<[CartLineItemDTO](../../../interfaces/cart.CartLineItemDTO/page.mdx)>","description":"The configurations determining how the line item is retrieved. Its properties, such as `select` or `relations`, accept the\nattributes or relations associated with a line item.","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":"[FindConfigOrder](../../../types/cart.FindConfigOrder/page.mdx)","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":"sharedContext","type":"[Context](../../../interfaces/cart.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/cart.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 idempotencyKey of the parLine truncated
|
||||
<TypeList types={[{"name":"itemId","type":"`string`","description":"The item's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../../interfaces/cart.FindConfig/page.mdx)<[CartLineItemDTO](../../../interfaces/cart.CartLineItemDTO/page.mdx)>","description":"The configurations determining how the line item is retrieved. Its properties, such as `select` or `relations`, accept the\nattributes or relations associated with a line item.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"select","type":"(`string` & `object` \\| 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":"[FindConfigOrder](../../../types/cart.FindConfigOrder/page.mdx)","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":"sharedContext","type":"[Context](../../../interfaces/cart.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/cart.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 idempotencyKeyLine truncated
|
||||
|
||||
## Returns
|
||||
|
||||
|
||||
-4
@@ -5,7 +5,3 @@ displayed_sidebar: cartReference
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# clearMessages
|
||||
|
||||
## Returns
|
||||
|
||||
<TypeList types={[]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="clearMessages"/>
|
||||
-4
@@ -9,7 +9,3 @@ import { TypeList } from "docs-ui"
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"msg","type":"[Message](../../../types/cart.Message/page.mdx) \\| [Message](../../../types/cart.Message/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"TData","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[EventMetadata](../../../types/cart.EventMetadata/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"eventGroupId","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="save"/>
|
||||
|
||||
## Returns
|
||||
|
||||
<TypeList types={[]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="save"/>
|
||||
-4
@@ -9,7 +9,3 @@ import { TypeList } from "docs-ui"
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"messageData","type":"[RawMessageFormat](../../../types/cart.RawMessageFormat/page.mdx)<T> \\| [RawMessageFormat](../../../types/cart.RawMessageFormat/page.mdx)<T>[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"eventName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"TData","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"source","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"action","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"Pick<[Context](../../../interfaces/cart.Context/page.mdx), \"eventGroupId\">","description":"","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":"options","type":"`Record<string, any>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="saveRawMessageData"/>
|
||||
|
||||
## Returns
|
||||
|
||||
<TypeList types={[]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="saveRawMessageData"/>
|
||||
@@ -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/learn/fundamentals/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":"[FindConfigOrder](../../types/cart.FindConfigOrder/page.mdx)","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/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="FindConfig"/>
|
||||
<TypeList types={[{"name":"select","type":"(`string` & `object` \\| 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":"[FindConfigOrder](../../types/cart.FindConfigOrder/page.mdx)","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/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="FindConfig"/>
|
||||
Reference in new issue
Block a user