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
@@ -52,7 +52,7 @@ const [claims, count] = await orderModuleService.listAndCountOrderClaims({
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx)","description":"The filters to apply on the retrieved order claims.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/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":"([FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/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 orders by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter orders by their associated sales channel's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter orders by their associated customer's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter orders by their associated region's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter the orders by their creation date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"[OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter orders by their update date.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/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":"([FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/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":"([FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/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 orders by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter orders by their associated sales channel's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<Line truncated
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx)","description":"The filters to apply on the retrieved order claims.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/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":"([FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/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 orders by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter orders by their associated sales channel's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter orders by their associated customer's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter orders by their associated region's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter the orders by their creation date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"[OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter orders by their update date.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/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":"([FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/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":"([FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/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 orders by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter orders by their associated sales channel's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<Line truncated
|
||||
|
||||
## Returns
|
||||
|
||||
|
||||
+1
-1
@@ -52,7 +52,7 @@ const [exchanges, count] = await orderModuleService.listOrderExchanges({
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx)","description":"The filters to apply on the retrieved exchanges.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/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":"([FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/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 orders by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter orders by their associated sales channel's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter orders by their associated customer's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter orders by their associated region's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter the orders by their creation date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"[OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter orders by their update date.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/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":"([FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/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":"([FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/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 orders by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter orders by their associated sales channel's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<strLine truncated
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx)","description":"The filters to apply on the retrieved exchanges.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/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":"([FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/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 orders by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter orders by their associated sales channel's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter orders by their associated customer's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter orders by their associated region's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter the orders by their creation date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"[OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter orders by their update date.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/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":"([FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/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":"([FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/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 orders by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter orders by their associated sales channel's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<strLine truncated
|
||||
|
||||
## Returns
|
||||
|
||||
|
||||
+1
-1
@@ -52,7 +52,7 @@ const [orders, count] = await orderModuleService.listAndCountOrders({
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx)","description":"The filters to apply on the retrieved order.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/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":"([FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/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 orders by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter orders by their associated sales channel's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter orders by their associated customer's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter orders by their associated region's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter the orders by their creation date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"[OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter orders by their update date.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/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":"([FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/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":"([FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/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 orders by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter orders by their associated sales channel's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string&Line truncated
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx)","description":"The filters to apply on the retrieved order.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/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":"([FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/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 orders by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter orders by their associated sales channel's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter orders by their associated customer's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter orders by their associated region's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter the orders by their creation date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"[OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter orders by their update date.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/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":"([FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/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":"([FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/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 orders by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter orders by their associated sales channel's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string&Line truncated
|
||||
|
||||
## Returns
|
||||
|
||||
|
||||
+1
-1
@@ -52,7 +52,7 @@ const [returns, count] = await orderModuleService.listAndCountReturns({
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx)","description":"The filters to apply on the retrieved returns.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/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":"([FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/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 orders by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter orders by their associated sales channel's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter orders by their associated customer's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter orders by their associated region's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter the orders by their creation date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"[OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter orders by their update date.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/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":"([FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/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":"([FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/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 orders by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter orders by their associated sales channel's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<strinLine truncated
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx)","description":"The filters to apply on the retrieved returns.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/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":"([FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/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 orders by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter orders by their associated sales channel's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter orders by their associated customer's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter orders by their associated region's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter the orders by their creation date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"[OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter orders by their update date.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/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":"([FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/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":"([FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/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 orders by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter orders by their associated sales channel's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<strinLine truncated
|
||||
|
||||
## Returns
|
||||
|
||||
|
||||
+1
-1
@@ -41,7 +41,7 @@ const addresses = await orderModuleService.listOrderAddresses({
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableOrderAddressProps](../../../interfaces/order.FilterableOrderAddressProps/page.mdx)","description":"The filters to apply on the retrieved order addresss.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableOrderAddressProps](../../../interfaces/order.FilterableOrderAddressProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderAddressProps](../../../interfaces/order.FilterableOrderAddressProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableOrderAddressProps](../../../interfaces/order.FilterableOrderAddressProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderAddressProps](../../../interfaces/order.FilterableOrderAddressProps/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":"([FilterableOrderAddressProps](../../../interfaces/order.FilterableOrderAddressProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderAddressProps](../../../interfaces/order.FilterableOrderAddressProps/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 order addresss by.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableOrderAddressProps](../../../interfaces/order.FilterableOrderAddressProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderAddressProps](../../../interfaces/order.FilterableOrderAddressProps/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":"([FilterableOrderAddressProps](../../../interfaces/order.FilterableOrderAddressProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderAddressProps](../../../interfaces/order.FilterableOrderAddressProps/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":"([FilterableOrderAddressProps](../../../interfaces/order.FilterableOrderAddressProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderAddressProps](../../../interfaces/order.FilterableOrderAddressProps/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 order addresss by.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the order addresss by.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"config","type":"[FindConfig](../../../interfaces/order.FindConfig/page.mdx)<[OrderAddressDTO](../../../interfaces/order.OrderAddressDTO/page.mdx)>","description":"The configurations determining how the order address is retrieved. Its properties, such as `select` or `relations`, accept the\nattributes or relations associated with a order 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":Line truncated
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableOrderAddressProps](../../../interfaces/order.FilterableOrderAddressProps/page.mdx)","description":"The filters to apply on the retrieved order addresss.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableOrderAddressProps](../../../interfaces/order.FilterableOrderAddressProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderAddressProps](../../../interfaces/order.FilterableOrderAddressProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableOrderAddressProps](../../../interfaces/order.FilterableOrderAddressProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderAddressProps](../../../interfaces/order.FilterableOrderAddressProps/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":"([FilterableOrderAddressProps](../../../interfaces/order.FilterableOrderAddressProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderAddressProps](../../../interfaces/order.FilterableOrderAddressProps/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 order addresss by.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableOrderAddressProps](../../../interfaces/order.FilterableOrderAddressProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderAddressProps](../../../interfaces/order.FilterableOrderAddressProps/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":"([FilterableOrderAddressProps](../../../interfaces/order.FilterableOrderAddressProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderAddressProps](../../../interfaces/order.FilterableOrderAddressProps/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":"([FilterableOrderAddressProps](../../../interfaces/order.FilterableOrderAddressProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderAddressProps](../../../interfaces/order.FilterableOrderAddressProps/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 order addresss by.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the order addresss by.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"config","type":"[FindConfig](../../../interfaces/order.FindConfig/page.mdx)<[OrderAddressDTO](../../../interfaces/order.OrderAddressDTO/page.mdx)>","description":"The configurations determining how the order address is retrieved. Its properties, such as `select` or `relations`, accept the\nattributes or relations associated with a order 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,Line truncated
|
||||
|
||||
## Returns
|
||||
|
||||
|
||||
+1
-1
@@ -52,7 +52,7 @@ const orderChangeActions = await orderModuleService.listOrderChangeActions({
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableOrderChangeActionProps](../../../interfaces/order.FilterableOrderChangeActionProps/page.mdx)","description":"The filters to apply on the retrieved order change action.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableOrderChangeActionProps](../../../interfaces/order.FilterableOrderChangeActionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderChangeActionProps](../../../interfaces/order.FilterableOrderChangeActionProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableOrderChangeActionProps](../../../interfaces/order.FilterableOrderChangeActionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderChangeActionProps](../../../interfaces/order.FilterableOrderChangeActionProps/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":"([FilterableOrderChangeActionProps](../../../interfaces/order.FilterableOrderChangeActionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderChangeActionProps](../../../interfaces/order.FilterableOrderChangeActionProps/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`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"The IDs to filter the order change actions by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_change_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter the actions by their associated order change's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter the actions by their reference.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter the actions by their reference ID.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableOrderChangeActionProps](../../../interfaces/order.FilterableOrderChangeActionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderChangeActionProps](../../../interfaces/order.FilterableOrderChangeActionProps/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":"([FilterableOrderChangeActionProps](../../../interfaces/order.FilterableOrderChangeActionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderChangeActionProps](../../../interfaces/order.FilterableOrderChangeActionProps/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":"([FilterableOrderChangeActionProps](../../../interfaces/order.FilterableOrderChangeActionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderChangeActionProps](../../../interfaces/order.FilterableOrderChangeActionProps/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`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"The IDs to filter the order change actions by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_change_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter the actions by their associated order change's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`string` \\| `string`[] \\| [OperatorMap](../../..Line truncated
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableOrderChangeActionProps](../../../interfaces/order.FilterableOrderChangeActionProps/page.mdx)","description":"The filters to apply on the retrieved order change action.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableOrderChangeActionProps](../../../interfaces/order.FilterableOrderChangeActionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderChangeActionProps](../../../interfaces/order.FilterableOrderChangeActionProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableOrderChangeActionProps](../../../interfaces/order.FilterableOrderChangeActionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderChangeActionProps](../../../interfaces/order.FilterableOrderChangeActionProps/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":"([FilterableOrderChangeActionProps](../../../interfaces/order.FilterableOrderChangeActionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderChangeActionProps](../../../interfaces/order.FilterableOrderChangeActionProps/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`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"The IDs to filter the order change actions by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_change_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter the actions by their associated order change's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter the actions by their reference.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter the actions by their reference ID.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableOrderChangeActionProps](../../../interfaces/order.FilterableOrderChangeActionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderChangeActionProps](../../../interfaces/order.FilterableOrderChangeActionProps/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":"([FilterableOrderChangeActionProps](../../../interfaces/order.FilterableOrderChangeActionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderChangeActionProps](../../../interfaces/order.FilterableOrderChangeActionProps/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":"([FilterableOrderChangeActionProps](../../../interfaces/order.FilterableOrderChangeActionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderChangeActionProps](../../../interfaces/order.FilterableOrderChangeActionProps/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`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"The IDs to filter the order change actions by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_change_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter the actions by their associated order change's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`string` \\| `string`[] \\| [OperatorMap](../../..Line truncated
|
||||
|
||||
## Returns
|
||||
|
||||
|
||||
+1
-1
@@ -52,7 +52,7 @@ const orderChanges = await orderModuleService.listOrderChanges({
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableOrderChangeProps](../../../interfaces/order.FilterableOrderChangeProps/page.mdx)","description":"The filters to apply on the retrieved order changes.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableOrderChangeProps](../../../interfaces/order.FilterableOrderChangeProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderChangeProps](../../../interfaces/order.FilterableOrderChangeProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableOrderChangeProps](../../../interfaces/order.FilterableOrderChangeProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderChangeProps](../../../interfaces/order.FilterableOrderChangeProps/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":"([FilterableOrderChangeProps](../../../interfaces/order.FilterableOrderChangeProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderChangeProps](../../../interfaces/order.FilterableOrderChangeProps/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`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"The IDs to filter the order changes by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter the changes by their associated order's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter the changes by their associated return's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter the changes by their associated claim's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter the changes by their associated exchange's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter the order changes by their status.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_by","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter the order changes by who requested them.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_by","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter the order changes by who confirmed them.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_by","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter the order changes by who declined them.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_by","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter the order changes by who canceled them.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter the order changes by their creation date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"[OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter the order changes by their update date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"[OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter the order changes by their deletion date.","optional":truLine truncated
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableOrderChangeProps](../../../interfaces/order.FilterableOrderChangeProps/page.mdx)","description":"The filters to apply on the retrieved order changes.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableOrderChangeProps](../../../interfaces/order.FilterableOrderChangeProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderChangeProps](../../../interfaces/order.FilterableOrderChangeProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableOrderChangeProps](../../../interfaces/order.FilterableOrderChangeProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderChangeProps](../../../interfaces/order.FilterableOrderChangeProps/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":"([FilterableOrderChangeProps](../../../interfaces/order.FilterableOrderChangeProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderChangeProps](../../../interfaces/order.FilterableOrderChangeProps/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`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"The IDs to filter the order changes by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter the changes by their associated order's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter the changes by their associated return's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter the changes by their associated claim's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter the changes by their associated exchange's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter the order changes by their status.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_by","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter the order changes by who requested them.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_by","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter the order changes by who confirmed them.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_by","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter the order changes by who declined them.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_by","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter the order changes by who canceled them.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter the order changes by their creation date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"[OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter the order changes by their update date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"[OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter the order changes by their deletion date.","optional":truLine truncated
|
||||
|
||||
## Returns
|
||||
|
||||
|
||||
+1
-1
@@ -52,7 +52,7 @@ const claims = await orderModuleService.listOrderClaims({
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx)","description":"The filters to apply on the retrieved order claims.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/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":"([FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/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 orders by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter orders by their associated sales channel's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter orders by their associated customer's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter orders by their associated region's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter the orders by their creation date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"[OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter orders by their update date.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/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":"([FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/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":"([FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/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 orders by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter orders by their associated sales channel's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<Line truncated
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx)","description":"The filters to apply on the retrieved order claims.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/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":"([FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/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 orders by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter orders by their associated sales channel's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter orders by their associated customer's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter orders by their associated region's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter the orders by their creation date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"[OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter orders by their update date.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/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":"([FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/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":"([FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/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 orders by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter orders by their associated sales channel's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<Line truncated
|
||||
|
||||
## Returns
|
||||
|
||||
|
||||
+1
-1
@@ -52,7 +52,7 @@ const exchanges = await orderModuleService.listOrderExchanges({
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx)","description":"The filters to apply on the retrieved exchanges.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/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":"([FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/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 orders by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter orders by their associated sales channel's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter orders by their associated customer's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter orders by their associated region's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter the orders by their creation date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"[OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter orders by their update date.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/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":"([FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/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":"([FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/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 orders by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter orders by their associated sales channel's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<strLine truncated
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx)","description":"The filters to apply on the retrieved exchanges.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/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":"([FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/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 orders by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter orders by their associated sales channel's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter orders by their associated customer's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter orders by their associated region's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter the orders by their creation date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"[OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter orders by their update date.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/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":"([FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/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":"([FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/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 orders by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter orders by their associated sales channel's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<strLine truncated
|
||||
|
||||
## Returns
|
||||
|
||||
|
||||
+1
-1
@@ -52,7 +52,7 @@ const lineItemAdjustment = await orderModuleService.listOrderLineItemAdjustments
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableOrderLineItemAdjustmentProps](../../../interfaces/order.FilterableOrderLineItemAdjustmentProps/page.mdx)","description":"The filters to apply on the retrieved line item adjustment.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableOrderLineItemAdjustmentProps](../../../interfaces/order.FilterableOrderLineItemAdjustmentProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderLineItemAdjustmentProps](../../../interfaces/order.FilterableOrderLineItemAdjustmentProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableOrderLineItemAdjustmentProps](../../../interfaces/order.FilterableOrderLineItemAdjustmentProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderLineItemAdjustmentProps](../../../interfaces/order.FilterableOrderLineItemAdjustmentProps/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":"([FilterableOrderLineItemAdjustmentProps](../../../interfaces/order.FilterableOrderLineItemAdjustmentProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderLineItemAdjustmentProps](../../../interfaces/order.FilterableOrderLineItemAdjustmentProps/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 item adjustments by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string` \\| `string`[]","description":"Filter adjustments by their associated item's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"promotion_id","type":"`string` \\| `string`[]","description":"Filter adjustments by their associated promotion's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string` \\| `string`[]","description":"Filter adjustments by their associated provider's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"[FilterableOrderLineItemProps](../../../interfaces/order.FilterableOrderLineItemProps/page.mdx)","description":"The filters to apply on the associated line items.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableOrderLineItemAdjustmentProps](../../../interfaces/order.FilterableOrderLineItemAdjustmentProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderLineItemAdjustmentProps](../../../interfaces/order.FilterableOrderLineItemAdjustmentProps/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":"([FilterableOrderLineItemAdjustmentProps](../../../interfaces/order.FilterableOrderLineItemAdjustmentProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderLineItemAdjustmentProps](../../../interfaces/order.FilterableOrderLineItemAdjustmentProps/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":"([FilterableOrderLineItemAdjustmentProps](../../../interfaces/order.FilterableOrderLineItemAdjustmentProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderLineItemAdjustmentProps](../../../interfaces/order.FilterableOrderLineItemAdjustmentProps/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 item adjustments by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string` \\| `string`[]","description":"Filter adjustments by their associated item's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"promotion_id","type":"`string` \\| `string`[]","description":"Filter adjustments by their associated promotion's ID.",Line truncated
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableOrderLineItemAdjustmentProps](../../../interfaces/order.FilterableOrderLineItemAdjustmentProps/page.mdx)","description":"The filters to apply on the retrieved line item adjustment.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableOrderLineItemAdjustmentProps](../../../interfaces/order.FilterableOrderLineItemAdjustmentProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderLineItemAdjustmentProps](../../../interfaces/order.FilterableOrderLineItemAdjustmentProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableOrderLineItemAdjustmentProps](../../../interfaces/order.FilterableOrderLineItemAdjustmentProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderLineItemAdjustmentProps](../../../interfaces/order.FilterableOrderLineItemAdjustmentProps/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":"([FilterableOrderLineItemAdjustmentProps](../../../interfaces/order.FilterableOrderLineItemAdjustmentProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderLineItemAdjustmentProps](../../../interfaces/order.FilterableOrderLineItemAdjustmentProps/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 item adjustments by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string` \\| `string`[]","description":"Filter adjustments by their associated item's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"promotion_id","type":"`string` \\| `string`[]","description":"Filter adjustments by their associated promotion's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string` \\| `string`[]","description":"Filter adjustments by their associated provider's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"[FilterableOrderLineItemProps](../../../interfaces/order.FilterableOrderLineItemProps/page.mdx)","description":"The filters to apply on the associated line items.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableOrderLineItemAdjustmentProps](../../../interfaces/order.FilterableOrderLineItemAdjustmentProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderLineItemAdjustmentProps](../../../interfaces/order.FilterableOrderLineItemAdjustmentProps/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":"([FilterableOrderLineItemAdjustmentProps](../../../interfaces/order.FilterableOrderLineItemAdjustmentProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderLineItemAdjustmentProps](../../../interfaces/order.FilterableOrderLineItemAdjustmentProps/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":"([FilterableOrderLineItemAdjustmentProps](../../../interfaces/order.FilterableOrderLineItemAdjustmentProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderLineItemAdjustmentProps](../../../interfaces/order.FilterableOrderLineItemAdjustmentProps/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 item adjustments by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string` \\| `string`[]","description":"Filter adjustments by their associated item's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"promotion_id","type":"`string` \\| `string`[]","description":"Filter adjustments by their associated promotion's ID.",Line truncated
|
||||
|
||||
## Returns
|
||||
|
||||
|
||||
+1
-1
@@ -55,7 +55,7 @@ const lineItemTaxLines = await orderModuleService
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableOrderLineItemTaxLineProps](../../../interfaces/order.FilterableOrderLineItemTaxLineProps/page.mdx)","description":"The filters to apply on the retrieved line item tax line.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableOrderLineItemTaxLineProps](../../../interfaces/order.FilterableOrderLineItemTaxLineProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderLineItemTaxLineProps](../../../interfaces/order.FilterableOrderLineItemTaxLineProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableOrderLineItemTaxLineProps](../../../interfaces/order.FilterableOrderLineItemTaxLineProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderLineItemTaxLineProps](../../../interfaces/order.FilterableOrderLineItemTaxLineProps/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":"([FilterableOrderLineItemTaxLineProps](../../../interfaces/order.FilterableOrderLineItemTaxLineProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderLineItemTaxLineProps](../../../interfaces/order.FilterableOrderLineItemTaxLineProps/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 item tax lines by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"Filter line item tax lines by their description.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string` \\| `string`[]","description":"Filter line item tax lines by their code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate_id","type":"`string` \\| `string`[]","description":"Filter the tax lines by their associated tax rate's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string` \\| `string`[]","description":"Filter the tax lines by their associated provider's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string` \\| `string`[]","description":"Filter the tax lines by their associated item's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"[FilterableOrderLineItemProps](../../../interfaces/order.FilterableOrderLineItemProps/page.mdx)","description":"The filters to apply on the associated line items.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableOrderLineItemTaxLineProps](../../../interfaces/order.FilterableOrderLineItemTaxLineProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderLineItemTaxLineProps](../../../interfaces/order.FilterableOrderLineItemTaxLineProps/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":"([FilterableOrderLineItemTaxLineProps](../../../interfaces/order.FilterableOrderLineItemTaxLineProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderLineItemTaxLineProps](../../../interfaces/order.FilterableOrderLineItemTaxLineProps/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":"([FilterableOrderLineItemTaxLineProps](../../../interfaces/order.FilterableOrderLineItemTaxLineProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderLineItemTaxLineProps](../../../interfaces/order.FilterableOrderLineItemTaxLineProps/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 item tax lines by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","descLine truncated
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableOrderLineItemTaxLineProps](../../../interfaces/order.FilterableOrderLineItemTaxLineProps/page.mdx)","description":"The filters to apply on the retrieved line item tax line.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableOrderLineItemTaxLineProps](../../../interfaces/order.FilterableOrderLineItemTaxLineProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderLineItemTaxLineProps](../../../interfaces/order.FilterableOrderLineItemTaxLineProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableOrderLineItemTaxLineProps](../../../interfaces/order.FilterableOrderLineItemTaxLineProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderLineItemTaxLineProps](../../../interfaces/order.FilterableOrderLineItemTaxLineProps/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":"([FilterableOrderLineItemTaxLineProps](../../../interfaces/order.FilterableOrderLineItemTaxLineProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderLineItemTaxLineProps](../../../interfaces/order.FilterableOrderLineItemTaxLineProps/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 item tax lines by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"Filter line item tax lines by their description.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string` \\| `string`[]","description":"Filter line item tax lines by their code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate_id","type":"`string` \\| `string`[]","description":"Filter the tax lines by their associated tax rate's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string` \\| `string`[]","description":"Filter the tax lines by their associated provider's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string` \\| `string`[]","description":"Filter the tax lines by their associated item's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"[FilterableOrderLineItemProps](../../../interfaces/order.FilterableOrderLineItemProps/page.mdx)","description":"The filters to apply on the associated line items.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableOrderLineItemTaxLineProps](../../../interfaces/order.FilterableOrderLineItemTaxLineProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderLineItemTaxLineProps](../../../interfaces/order.FilterableOrderLineItemTaxLineProps/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":"([FilterableOrderLineItemTaxLineProps](../../../interfaces/order.FilterableOrderLineItemTaxLineProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderLineItemTaxLineProps](../../../interfaces/order.FilterableOrderLineItemTaxLineProps/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":"([FilterableOrderLineItemTaxLineProps](../../../interfaces/order.FilterableOrderLineItemTaxLineProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderLineItemTaxLineProps](../../../interfaces/order.FilterableOrderLineItemTaxLineProps/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 item tax lines by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","descLine truncated
|
||||
|
||||
## Returns
|
||||
|
||||
|
||||
+1
-1
@@ -52,7 +52,7 @@ const lineItems = await orderModuleService.listOrderLineItems({
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableOrderLineItemProps](../../../interfaces/order.FilterableOrderLineItemProps/page.mdx)","description":"The filters to apply on the retrieved line item.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableOrderLineItemProps](../../../interfaces/order.FilterableOrderLineItemProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderLineItemProps](../../../interfaces/order.FilterableOrderLineItemProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableOrderLineItemProps](../../../interfaces/order.FilterableOrderLineItemProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderLineItemProps](../../../interfaces/order.FilterableOrderLineItemProps/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":"([FilterableOrderLineItemProps](../../../interfaces/order.FilterableOrderLineItemProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderLineItemProps](../../../interfaces/order.FilterableOrderLineItemProps/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 order line items by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string` \\| `string`[]","description":"Filter line items by their associated order's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"Filter by line items' title.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_id","type":"`string` \\| `string`[]","description":"Filter line items by their associated variant's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`string` \\| `string`[]","description":"Filter line items by their associated product's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableOrderLineItemProps](../../../interfaces/order.FilterableOrderLineItemProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderLineItemProps](../../../interfaces/order.FilterableOrderLineItemProps/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":"([FilterableOrderLineItemProps](../../../interfaces/order.FilterableOrderLineItemProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderLineItemProps](../../../interfaces/order.FilterableOrderLineItemProps/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":"([FilterableOrderLineItemProps](../../../interfaces/order.FilterableOrderLineItemProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderLineItemProps](../../../interfaces/order.FilterableOrderLineItemProps/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 order line items by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string` \\| `string`[]","description":"Filter line items by their associated order's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"Filter by line items' title.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_id","type":"`string` \\| `string`[]","description":"Filter line items by their associated variant's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`string` \\| `string`[]","description":"Filter line items by their associated product's ID.","optional":true,"defaultValue":"","expandable":false,"children"Line truncated
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableOrderLineItemProps](../../../interfaces/order.FilterableOrderLineItemProps/page.mdx)","description":"The filters to apply on the retrieved line item.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableOrderLineItemProps](../../../interfaces/order.FilterableOrderLineItemProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderLineItemProps](../../../interfaces/order.FilterableOrderLineItemProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableOrderLineItemProps](../../../interfaces/order.FilterableOrderLineItemProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderLineItemProps](../../../interfaces/order.FilterableOrderLineItemProps/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":"([FilterableOrderLineItemProps](../../../interfaces/order.FilterableOrderLineItemProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderLineItemProps](../../../interfaces/order.FilterableOrderLineItemProps/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 order line items by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string` \\| `string`[]","description":"Filter line items by their associated order's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"Filter by line items' title.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_id","type":"`string` \\| `string`[]","description":"Filter line items by their associated variant's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`string` \\| `string`[]","description":"Filter line items by their associated product's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableOrderLineItemProps](../../../interfaces/order.FilterableOrderLineItemProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderLineItemProps](../../../interfaces/order.FilterableOrderLineItemProps/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":"([FilterableOrderLineItemProps](../../../interfaces/order.FilterableOrderLineItemProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderLineItemProps](../../../interfaces/order.FilterableOrderLineItemProps/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":"([FilterableOrderLineItemProps](../../../interfaces/order.FilterableOrderLineItemProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderLineItemProps](../../../interfaces/order.FilterableOrderLineItemProps/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 order line items by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string` \\| `string`[]","description":"Filter line items by their associated order's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"Filter by line items' title.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_id","type":"`string` \\| `string`[]","description":"Filter line items by their associated variant's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`string` \\| `string`[]","description":"Filter line items by their associated product's ID.","optional":true,"defaultValue":"","expandable":false,"children"Line truncated
|
||||
|
||||
## Returns
|
||||
|
||||
|
||||
+1
-1
@@ -55,7 +55,7 @@ const shippingMethodAdjustments = await orderModuleService
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableOrderShippingMethodAdjustmentProps](../../../interfaces/order.FilterableOrderShippingMethodAdjustmentProps/page.mdx)","description":"The filters to apply on the retrieved shipping method adjustment.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableOrderShippingMethodAdjustmentProps](../../../interfaces/order.FilterableOrderShippingMethodAdjustmentProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderShippingMethodAdjustmentProps](../../../interfaces/order.FilterableOrderShippingMethodAdjustmentProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableOrderShippingMethodAdjustmentProps](../../../interfaces/order.FilterableOrderShippingMethodAdjustmentProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderShippingMethodAdjustmentProps](../../../interfaces/order.FilterableOrderShippingMethodAdjustmentProps/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":"([FilterableOrderShippingMethodAdjustmentProps](../../../interfaces/order.FilterableOrderShippingMethodAdjustmentProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderShippingMethodAdjustmentProps](../../../interfaces/order.FilterableOrderShippingMethodAdjustmentProps/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 shipping method adjustments by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_method_id","type":"`string` \\| `string`[]","description":"Filter the adjustments by their associated shipping method's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"promotion_id","type":"`string` \\| `string`[]","description":"Filter the adjustments by their associated promotion's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string` \\| `string`[]","description":"Filter the adjustments by their associated provider's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_method","type":"[FilterableOrderShippingMethodProps](../../../interfaces/order.FilterableOrderShippingMethodProps/page.mdx)","description":"The filters to apply on the associated shipping methods.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableOrderShippingMethodAdjustmentProps](../../../interfaces/order.FilterableOrderShippingMethodAdjustmentProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderShippingMethodAdjustmentProps](../../../interfaces/order.FilterableOrderShippingMethodAdjustmentProps/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":"([FilterableOrderShippingMethodAdjustmentProps](../../../interfaces/order.FilterableOrderShippingMethodAdjustmentProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderShippingMethodAdjustmentProps](../../../interfaces/order.FilterableOrderShippingMethodAdjustmentProps/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":"([FilterableOrderShippingMethodAdjustmentProps](../../../interfaces/order.FilterableOrderShippingMethodAdjustmentProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderShippingMethodAdjustmentProps](../../../interfaces/order.FilterableOrderShippingMethodAdjustmentProps/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 shipping method adjustments by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_method_id","type":"`string` \\| `string`[]","description"Line truncated
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableOrderShippingMethodAdjustmentProps](../../../interfaces/order.FilterableOrderShippingMethodAdjustmentProps/page.mdx)","description":"The filters to apply on the retrieved shipping method adjustment.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableOrderShippingMethodAdjustmentProps](../../../interfaces/order.FilterableOrderShippingMethodAdjustmentProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderShippingMethodAdjustmentProps](../../../interfaces/order.FilterableOrderShippingMethodAdjustmentProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableOrderShippingMethodAdjustmentProps](../../../interfaces/order.FilterableOrderShippingMethodAdjustmentProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderShippingMethodAdjustmentProps](../../../interfaces/order.FilterableOrderShippingMethodAdjustmentProps/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":"([FilterableOrderShippingMethodAdjustmentProps](../../../interfaces/order.FilterableOrderShippingMethodAdjustmentProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderShippingMethodAdjustmentProps](../../../interfaces/order.FilterableOrderShippingMethodAdjustmentProps/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 shipping method adjustments by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_method_id","type":"`string` \\| `string`[]","description":"Filter the adjustments by their associated shipping method's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"promotion_id","type":"`string` \\| `string`[]","description":"Filter the adjustments by their associated promotion's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string` \\| `string`[]","description":"Filter the adjustments by their associated provider's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_method","type":"[FilterableOrderShippingMethodProps](../../../interfaces/order.FilterableOrderShippingMethodProps/page.mdx)","description":"The filters to apply on the associated shipping methods.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableOrderShippingMethodAdjustmentProps](../../../interfaces/order.FilterableOrderShippingMethodAdjustmentProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderShippingMethodAdjustmentProps](../../../interfaces/order.FilterableOrderShippingMethodAdjustmentProps/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":"([FilterableOrderShippingMethodAdjustmentProps](../../../interfaces/order.FilterableOrderShippingMethodAdjustmentProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderShippingMethodAdjustmentProps](../../../interfaces/order.FilterableOrderShippingMethodAdjustmentProps/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":"([FilterableOrderShippingMethodAdjustmentProps](../../../interfaces/order.FilterableOrderShippingMethodAdjustmentProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderShippingMethodAdjustmentProps](../../../interfaces/order.FilterableOrderShippingMethodAdjustmentProps/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 shipping method adjustments by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_method_id","type":"`string` \\| `string`[]","description"Line truncated
|
||||
|
||||
## Returns
|
||||
|
||||
|
||||
+1
-1
@@ -55,7 +55,7 @@ const shippingMethodTaxLines = await orderModuleService
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableOrderShippingMethodTaxLineProps](../../../interfaces/order.FilterableOrderShippingMethodTaxLineProps/page.mdx)","description":"The filters to apply on the retrieved shipping method tax line.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableOrderShippingMethodTaxLineProps](../../../interfaces/order.FilterableOrderShippingMethodTaxLineProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderShippingMethodTaxLineProps](../../../interfaces/order.FilterableOrderShippingMethodTaxLineProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableOrderShippingMethodTaxLineProps](../../../interfaces/order.FilterableOrderShippingMethodTaxLineProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderShippingMethodTaxLineProps](../../../interfaces/order.FilterableOrderShippingMethodTaxLineProps/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":"([FilterableOrderShippingMethodTaxLineProps](../../../interfaces/order.FilterableOrderShippingMethodTaxLineProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderShippingMethodTaxLineProps](../../../interfaces/order.FilterableOrderShippingMethodTaxLineProps/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 order shipping method tax lines by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"Filter the tax lines by their description","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string` \\| `string`[]","description":"Filter the tax lines by their code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate_id","type":"`string` \\| `string`[]","description":"Filter the tax lines by their associated tax rate's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string` \\| `string`[]","description":"Filter the tax lines by their associated provider's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_method_id","type":"`string` \\| `string`[]","description":"Filter the tax lines by their associated shipping method's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_method","type":"[FilterableOrderShippingMethodProps](../../../interfaces/order.FilterableOrderShippingMethodProps/page.mdx)","description":"The filters to apply on the retrieved associated shipping methods.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableOrderShippingMethodTaxLineProps](../../../interfaces/order.FilterableOrderShippingMethodTaxLineProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderShippingMethodTaxLineProps](../../../interfaces/order.FilterableOrderShippingMethodTaxLineProps/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":"([FilterableOrderShippingMethodTaxLineProps](../../../interfaces/order.FilterableOrderShippingMethodTaxLineProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderShippingMethodTaxLineProps](../../../interfaces/order.FilterableOrderShippingMethodTaxLineProps/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":"([FilterableOrderShippingMethodTaxLineProps](../../../interfaces/order.FilterableOrderShippingMethodTaxLineProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderShippingMethodTaxLineProps](../../../interfaces/order.FilterableOrderShippingMethodTaxLineProps/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":[]}Line truncated
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableOrderShippingMethodTaxLineProps](../../../interfaces/order.FilterableOrderShippingMethodTaxLineProps/page.mdx)","description":"The filters to apply on the retrieved shipping method tax line.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableOrderShippingMethodTaxLineProps](../../../interfaces/order.FilterableOrderShippingMethodTaxLineProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderShippingMethodTaxLineProps](../../../interfaces/order.FilterableOrderShippingMethodTaxLineProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableOrderShippingMethodTaxLineProps](../../../interfaces/order.FilterableOrderShippingMethodTaxLineProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderShippingMethodTaxLineProps](../../../interfaces/order.FilterableOrderShippingMethodTaxLineProps/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":"([FilterableOrderShippingMethodTaxLineProps](../../../interfaces/order.FilterableOrderShippingMethodTaxLineProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderShippingMethodTaxLineProps](../../../interfaces/order.FilterableOrderShippingMethodTaxLineProps/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 order shipping method tax lines by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"Filter the tax lines by their description","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string` \\| `string`[]","description":"Filter the tax lines by their code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate_id","type":"`string` \\| `string`[]","description":"Filter the tax lines by their associated tax rate's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string` \\| `string`[]","description":"Filter the tax lines by their associated provider's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_method_id","type":"`string` \\| `string`[]","description":"Filter the tax lines by their associated shipping method's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_method","type":"[FilterableOrderShippingMethodProps](../../../interfaces/order.FilterableOrderShippingMethodProps/page.mdx)","description":"The filters to apply on the retrieved associated shipping methods.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableOrderShippingMethodTaxLineProps](../../../interfaces/order.FilterableOrderShippingMethodTaxLineProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderShippingMethodTaxLineProps](../../../interfaces/order.FilterableOrderShippingMethodTaxLineProps/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":"([FilterableOrderShippingMethodTaxLineProps](../../../interfaces/order.FilterableOrderShippingMethodTaxLineProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderShippingMethodTaxLineProps](../../../interfaces/order.FilterableOrderShippingMethodTaxLineProps/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":"([FilterableOrderShippingMethodTaxLineProps](../../../interfaces/order.FilterableOrderShippingMethodTaxLineProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderShippingMethodTaxLineProps](../../../interfaces/order.FilterableOrderShippingMethodTaxLineProps/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":[]}Line truncated
|
||||
|
||||
## Returns
|
||||
|
||||
|
||||
+1
-1
@@ -52,7 +52,7 @@ const shippingMethods = await orderModuleService.listOrderShippingMethods({
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableOrderShippingMethodProps](../../../interfaces/order.FilterableOrderShippingMethodProps/page.mdx)","description":"The filters to apply on the retrieved shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableOrderShippingMethodProps](../../../interfaces/order.FilterableOrderShippingMethodProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderShippingMethodProps](../../../interfaces/order.FilterableOrderShippingMethodProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableOrderShippingMethodProps](../../../interfaces/order.FilterableOrderShippingMethodProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderShippingMethodProps](../../../interfaces/order.FilterableOrderShippingMethodProps/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":"([FilterableOrderShippingMethodProps](../../../interfaces/order.FilterableOrderShippingMethodProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderShippingMethodProps](../../../interfaces/order.FilterableOrderShippingMethodProps/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 shipping methods by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string` \\| `string`[]","description":"Filter the shipping methods by their associated order's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"Filter shipping methods by their name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_id","type":"`string` \\| `string`[]","description":"Filter the shipping methods by their associated shipping option's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableOrderShippingMethodProps](../../../interfaces/order.FilterableOrderShippingMethodProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderShippingMethodProps](../../../interfaces/order.FilterableOrderShippingMethodProps/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":"([FilterableOrderShippingMethodProps](../../../interfaces/order.FilterableOrderShippingMethodProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderShippingMethodProps](../../../interfaces/order.FilterableOrderShippingMethodProps/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":"([FilterableOrderShippingMethodProps](../../../interfaces/order.FilterableOrderShippingMethodProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderShippingMethodProps](../../../interfaces/order.FilterableOrderShippingMethodProps/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 shipping methods by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string` \\| `string`[]","description":"Filter the shipping methods by their associated order's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"Filter shipping methods by their name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_id","type":"`string` \\| `string`[]","description":"Filter the shipping methods by their associated shipping option's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the shipping methods by.","optional":true,Line truncated
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableOrderShippingMethodProps](../../../interfaces/order.FilterableOrderShippingMethodProps/page.mdx)","description":"The filters to apply on the retrieved shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableOrderShippingMethodProps](../../../interfaces/order.FilterableOrderShippingMethodProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderShippingMethodProps](../../../interfaces/order.FilterableOrderShippingMethodProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableOrderShippingMethodProps](../../../interfaces/order.FilterableOrderShippingMethodProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderShippingMethodProps](../../../interfaces/order.FilterableOrderShippingMethodProps/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":"([FilterableOrderShippingMethodProps](../../../interfaces/order.FilterableOrderShippingMethodProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderShippingMethodProps](../../../interfaces/order.FilterableOrderShippingMethodProps/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 shipping methods by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string` \\| `string`[]","description":"Filter the shipping methods by their associated order's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"Filter shipping methods by their name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_id","type":"`string` \\| `string`[]","description":"Filter the shipping methods by their associated shipping option's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableOrderShippingMethodProps](../../../interfaces/order.FilterableOrderShippingMethodProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderShippingMethodProps](../../../interfaces/order.FilterableOrderShippingMethodProps/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":"([FilterableOrderShippingMethodProps](../../../interfaces/order.FilterableOrderShippingMethodProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderShippingMethodProps](../../../interfaces/order.FilterableOrderShippingMethodProps/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":"([FilterableOrderShippingMethodProps](../../../interfaces/order.FilterableOrderShippingMethodProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderShippingMethodProps](../../../interfaces/order.FilterableOrderShippingMethodProps/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 shipping methods by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string` \\| `string`[]","description":"Filter the shipping methods by their associated order's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"Filter shipping methods by their name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_id","type":"`string` \\| `string`[]","description":"Filter the shipping methods by their associated shipping option's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the shipping methods by.","optional":true,Line truncated
|
||||
|
||||
## Returns
|
||||
|
||||
|
||||
+1
-1
@@ -52,7 +52,7 @@ const transactions = await orderModuleService.listOrderTransactions({
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableOrderTransactionProps](../../../interfaces/order.FilterableOrderTransactionProps/page.mdx)","description":"The filters to apply on the retrieved transactions.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableOrderTransactionProps](../../../interfaces/order.FilterableOrderTransactionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderTransactionProps](../../../interfaces/order.FilterableOrderTransactionProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableOrderTransactionProps](../../../interfaces/order.FilterableOrderTransactionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderTransactionProps](../../../interfaces/order.FilterableOrderTransactionProps/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":"([FilterableOrderTransactionProps](../../../interfaces/order.FilterableOrderTransactionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderTransactionProps](../../../interfaces/order.FilterableOrderTransactionProps/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`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"The IDs to filter the transactions by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter the transactions by their associated order's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter the transactions by their currency code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter the transactions by their reference.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter the transactions by their associated reference's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter the transactions by their creation date.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableOrderTransactionProps](../../../interfaces/order.FilterableOrderTransactionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderTransactionProps](../../../interfaces/order.FilterableOrderTransactionProps/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":"([FilterableOrderTransactionProps](../../../interfaces/order.FilterableOrderTransactionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderTransactionProps](../../../interfaces/order.FilterableOrderTransactionProps/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":"([FilterableOrderTransactionProps](../../../interfaces/order.FilterableOrderTransactionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderTransactionProps](../../../interfaces/order.FilterableOrderTransactionProps/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`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description"Line truncated
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableOrderTransactionProps](../../../interfaces/order.FilterableOrderTransactionProps/page.mdx)","description":"The filters to apply on the retrieved transactions.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableOrderTransactionProps](../../../interfaces/order.FilterableOrderTransactionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderTransactionProps](../../../interfaces/order.FilterableOrderTransactionProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableOrderTransactionProps](../../../interfaces/order.FilterableOrderTransactionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderTransactionProps](../../../interfaces/order.FilterableOrderTransactionProps/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":"([FilterableOrderTransactionProps](../../../interfaces/order.FilterableOrderTransactionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderTransactionProps](../../../interfaces/order.FilterableOrderTransactionProps/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`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"The IDs to filter the transactions by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter the transactions by their associated order's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter the transactions by their currency code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter the transactions by their reference.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter the transactions by their associated reference's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter the transactions by their creation date.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableOrderTransactionProps](../../../interfaces/order.FilterableOrderTransactionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderTransactionProps](../../../interfaces/order.FilterableOrderTransactionProps/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":"([FilterableOrderTransactionProps](../../../interfaces/order.FilterableOrderTransactionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderTransactionProps](../../../interfaces/order.FilterableOrderTransactionProps/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":"([FilterableOrderTransactionProps](../../../interfaces/order.FilterableOrderTransactionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderTransactionProps](../../../interfaces/order.FilterableOrderTransactionProps/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`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description"Line truncated
|
||||
|
||||
## Returns
|
||||
|
||||
|
||||
+1
-1
@@ -52,7 +52,7 @@ const orders = await orderModuleService.listOrders({
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx)","description":"The filters to apply on the retrieved order.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/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":"([FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/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 orders by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter orders by their associated sales channel's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter orders by their associated customer's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter orders by their associated region's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter the orders by their creation date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"[OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter orders by their update date.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/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":"([FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/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":"([FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/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 orders by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter orders by their associated sales channel's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string&Line truncated
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx)","description":"The filters to apply on the retrieved order.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/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":"([FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/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 orders by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter orders by their associated sales channel's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter orders by their associated customer's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter orders by their associated region's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter the orders by their creation date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"[OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter orders by their update date.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/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":"([FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/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":"([FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/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 orders by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter orders by their associated sales channel's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string&Line truncated
|
||||
|
||||
## Returns
|
||||
|
||||
|
||||
+1
-1
@@ -52,7 +52,7 @@ const returnReasons = await orderModuleService.listReturnReasons({
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableOrderReturnReasonProps](../../../interfaces/order.FilterableOrderReturnReasonProps/page.mdx)","description":"The filters to apply on the retrieved return reasons.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableOrderReturnReasonProps](../../../interfaces/order.FilterableOrderReturnReasonProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderReturnReasonProps](../../../interfaces/order.FilterableOrderReturnReasonProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableOrderReturnReasonProps](../../../interfaces/order.FilterableOrderReturnReasonProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderReturnReasonProps](../../../interfaces/order.FilterableOrderReturnReasonProps/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":"([FilterableOrderReturnReasonProps](../../../interfaces/order.FilterableOrderReturnReasonProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderReturnReasonProps](../../../interfaces/order.FilterableOrderReturnReasonProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Find return reasons through this search term","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string \\| string[]>","description":"The IDs to filter the return reasons by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string \\| string[]>","description":"Filter the return reason by their value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string` \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter the return reason by their label.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string` \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter the return reason by their description.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableOrderReturnReasonProps](../../../interfaces/order.FilterableOrderReturnReasonProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderReturnReasonProps](../../../interfaces/order.FilterableOrderReturnReasonProps/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":"([FilterableOrderReturnReasonProps](../../../interfaces/order.FilterableOrderReturnReasonProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderReturnReasonProps](../../../interfaces/order.FilterableOrderReturnReasonProps/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":"([FilterableOrderReturnReasonProps](../../../interfaces/order.FilterableOrderReturnReasonProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderReturnReasonProps](../../../interfaces/order.FilterableOrderReturnReasonProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Find return reasons through this search term","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string \\| string[]>","description":"The IDs to filter the return reasons by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string` \\| `string`[] \\| [OperatorMap](..Line truncated
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableOrderReturnReasonProps](../../../interfaces/order.FilterableOrderReturnReasonProps/page.mdx)","description":"The filters to apply on the retrieved return reasons.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableOrderReturnReasonProps](../../../interfaces/order.FilterableOrderReturnReasonProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderReturnReasonProps](../../../interfaces/order.FilterableOrderReturnReasonProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableOrderReturnReasonProps](../../../interfaces/order.FilterableOrderReturnReasonProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderReturnReasonProps](../../../interfaces/order.FilterableOrderReturnReasonProps/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":"([FilterableOrderReturnReasonProps](../../../interfaces/order.FilterableOrderReturnReasonProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderReturnReasonProps](../../../interfaces/order.FilterableOrderReturnReasonProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Find return reasons through this search term","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string \\| string[]>","description":"The IDs to filter the return reasons by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string \\| string[]>","description":"Filter the return reason by their value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string` \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter the return reason by their label.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string` \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter the return reason by their description.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableOrderReturnReasonProps](../../../interfaces/order.FilterableOrderReturnReasonProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderReturnReasonProps](../../../interfaces/order.FilterableOrderReturnReasonProps/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":"([FilterableOrderReturnReasonProps](../../../interfaces/order.FilterableOrderReturnReasonProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderReturnReasonProps](../../../interfaces/order.FilterableOrderReturnReasonProps/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":"([FilterableOrderReturnReasonProps](../../../interfaces/order.FilterableOrderReturnReasonProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderReturnReasonProps](../../../interfaces/order.FilterableOrderReturnReasonProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Find return reasons through this search term","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string \\| string[]>","description":"The IDs to filter the return reasons by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string` \\| `string`[] \\| [OperatorMap](..Line truncated
|
||||
|
||||
## Returns
|
||||
|
||||
|
||||
+1
-1
@@ -52,7 +52,7 @@ const returns = await orderModuleService.listReturns({
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx)","description":"The filters to apply on the retrieved returns.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/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":"([FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/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 orders by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter orders by their associated sales channel's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter orders by their associated customer's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter orders by their associated region's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter the orders by their creation date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"[OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter orders by their update date.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/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":"([FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/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":"([FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/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 orders by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter orders by their associated sales channel's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<strinLine truncated
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx)","description":"The filters to apply on the retrieved returns.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/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":"([FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/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 orders by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter orders by their associated sales channel's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter orders by their associated customer's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter orders by their associated region's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter the orders by their creation date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"[OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter orders by their update date.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/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":"([FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/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":"([FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderProps](../../../interfaces/order.FilterableOrderProps/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 orders by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter orders by their associated sales channel's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/order.OperatorMap/page.mdx)<strinLine truncated
|
||||
|
||||
## Returns
|
||||
|
||||
|
||||
+1
-1
@@ -41,7 +41,7 @@ const order = await orderModuleService.retrieveOrder(
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"orderId","type":"`string`","description":"The order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../../interfaces/order.FindConfig/page.mdx)<[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)>","description":"The configurations determining how the order is retrieved. Its properties, such as `select` or `relations`, accept the\nattributes or relations associated with a order.","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/order.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/order.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/order.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
|
||||
<TypeList types={[{"name":"orderId","type":"`string`","description":"The order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../../interfaces/order.FindConfig/page.mdx)<[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)>","description":"The configurations determining how the order is retrieved. Its properties, such as `select` or `relations`, accept the\nattributes or relations associated with a order.","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/order.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/order.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/order.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 Line truncated
|
||||
|
||||
## Returns
|
||||
|
||||
|
||||
+1
-1
@@ -41,7 +41,7 @@ const orderChange = await orderModuleService.retrieveOrderChange(
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"orderChangeId","type":"`string`","description":"The order change ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../../interfaces/order.FindConfig/page.mdx)<[OrderChangeDTO](../../../interfaces/order.OrderChangeDTO/page.mdx)>","description":"The configurations determining how the order change is retrieved. Its properties, such as `select` or `relations`, accept the\nattributes or relations associated with a order change.","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/order.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/order.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/order.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 ideLine truncated
|
||||
<TypeList types={[{"name":"orderChangeId","type":"`string`","description":"The order change ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../../interfaces/order.FindConfig/page.mdx)<[OrderChangeDTO](../../../interfaces/order.OrderChangeDTO/page.mdx)>","description":"The configurations determining how the order change is retrieved. Its properties, such as `select` or `relations`, accept the\nattributes or relations associated with a order change.","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/order.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/order.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/order.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 indicatLine truncated
|
||||
|
||||
## Returns
|
||||
|
||||
|
||||
+1
-1
@@ -41,7 +41,7 @@ const orderChangeAction = await orderModuleService.retrieveOrderChangeAction(
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"actionId","type":"`string`","description":"The order change action's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../../interfaces/order.FindConfig/page.mdx)<[OrderChangeActionDTO](../../../interfaces/order.OrderChangeActionDTO/page.mdx)>","description":"The configurations determining how the order change action is retrieved. Its properties, such as `select` or `relations`, accept the\nattributes or relations associated with an order change action.","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/order.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/order.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/order.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`","descriptioLine truncated
|
||||
<TypeList types={[{"name":"actionId","type":"`string`","description":"The order change action's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../../interfaces/order.FindConfig/page.mdx)<[OrderChangeActionDTO](../../../interfaces/order.OrderChangeActionDTO/page.mdx)>","description":"The configurations determining how the order change action is retrieved. Its properties, such as `select` or `relations`, accept the\nattributes or relations associated with an order change action.","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/order.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/order.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/order.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`",Line truncated
|
||||
|
||||
## Returns
|
||||
|
||||
|
||||
+1
-1
@@ -41,7 +41,7 @@ const claim = await orderModuleService.retrieveOrderClaim(
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"claimId","type":"`string`","description":"The claim's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../../interfaces/order.FindConfig/page.mdx)<[OrderClaimDTO](../../../interfaces/order.OrderClaimDTO/page.mdx)>","description":"The configurations determining how the order claim is retrieved. Its properties, such as `select` or `relations`, accept the\nattributes or relations associated with a order claim.","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/order.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/order.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/order.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 Line truncated
|
||||
<TypeList types={[{"name":"claimId","type":"`string`","description":"The claim's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../../interfaces/order.FindConfig/page.mdx)<[OrderClaimDTO](../../../interfaces/order.OrderClaimDTO/page.mdx)>","description":"The configurations determining how the order claim is retrieved. Its properties, such as `select` or `relations`, accept the\nattributes or relations associated with a order claim.","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/order.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/order.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/order.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 idempotLine truncated
|
||||
|
||||
## Returns
|
||||
|
||||
|
||||
+1
-1
@@ -41,7 +41,7 @@ const exchange = await orderModuleService.retrieveOrderExchange(
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"exchangeId","type":"`string`","description":"The exchange's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../../interfaces/order.FindConfig/page.mdx)<[OrderExchangeDTO](../../../interfaces/order.OrderExchangeDTO/page.mdx)>","description":"The configurations determining how the order exchange is retrieved. Its properties, such as `select` or `relations`, accept the\nattributes or relations associated with a order exchange.","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/order.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/order.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/order.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 Line truncated
|
||||
<TypeList types={[{"name":"exchangeId","type":"`string`","description":"The exchange's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../../interfaces/order.FindConfig/page.mdx)<[OrderExchangeDTO](../../../interfaces/order.OrderExchangeDTO/page.mdx)>","description":"The configurations determining how the order exchange is retrieved. Its properties, such as `select` or `relations`, accept the\nattributes or relations associated with a order exchange.","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/order.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/order.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/order.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 indiLine truncated
|
||||
|
||||
## Returns
|
||||
|
||||
|
||||
+1
-1
@@ -39,7 +39,7 @@ const lineItem = await orderModuleService.retrieveOrderLineItem(
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"itemId","type":"`string`","description":"The item's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../../interfaces/order.FindConfig/page.mdx)<[OrderLineItemDTO](../../../interfaces/order.OrderLineItemDTO/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/order.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/order.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/order.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 Line truncated
|
||||
<TypeList types={[{"name":"itemId","type":"`string`","description":"The item's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../../interfaces/order.FindConfig/page.mdx)<[OrderLineItemDTO](../../../interfaces/order.OrderLineItemDTO/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/order.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/order.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/order.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 idempotLine truncated
|
||||
|
||||
## Returns
|
||||
|
||||
|
||||
+1
-1
@@ -41,7 +41,7 @@ const orderReturn = await orderModuleService.retrieveReturn(
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"returnId","type":"`string`","description":"The return's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../../interfaces/order.FindConfig/page.mdx)<[ReturnDTO](../../../interfaces/order.ReturnDTO/page.mdx)>","description":"The configurations determining how the return is retrieved. Its properties, such as `select` or `relations`, accept the\nattributes or relations associated with a return.","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/order.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/order.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/order.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 workfLine truncated
|
||||
<TypeList types={[{"name":"returnId","type":"`string`","description":"The return's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../../interfaces/order.FindConfig/page.mdx)<[ReturnDTO](../../../interfaces/order.ReturnDTO/page.mdx)>","description":"The configurations determining how the return is retrieved. Its properties, such as `select` or `relations`, accept the\nattributes or relations associated with a return.","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/order.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/order.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/order.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 pLine truncated
|
||||
|
||||
## Returns
|
||||
|
||||
|
||||
+1
-1
@@ -41,7 +41,7 @@ const returnReason = await orderModuleService.retrieveReturnReason(
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"reasonId","type":"`string`","description":"The return reason's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../../interfaces/order.FindConfig/page.mdx)<[OrderReturnReasonDTO](../../../interfaces/order.OrderReturnReasonDTO/page.mdx)>","description":"The configurations determining how the return reason is retrieved. Its properties, such as `select` or `relations`, accept the\nattributes or relations associated with a return reason.","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/order.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/order.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/order.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 indicaLine truncated
|
||||
<TypeList types={[{"name":"reasonId","type":"`string`","description":"The return reason's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../../interfaces/order.FindConfig/page.mdx)<[OrderReturnReasonDTO](../../../interfaces/order.OrderReturnReasonDTO/page.mdx)>","description":"The configurations determining how the return reason is retrieved. Its properties, such as `select` or `relations`, accept the\nattributes or relations associated with a return reason.","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/order.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/order.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/order.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 stLine truncated
|
||||
|
||||
## Returns
|
||||
|
||||
|
||||
Reference in new issue
Block a user