chore(docs): Generated References (#8573)
Generated the following references: - `cart` - `core_flows` - `dml` - `fulfillment` - `helper_steps` - `inventory_next` - `modules` - `order` - `order_models` - `payment` - `pricing` - `promotion` - `tax` - `types` - `utils` - `workflows` Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
github-actions[bot]andShahed Nasser authored and 
GitHub committed
1 parent
a013c4edc5
commit
e5909d4aad
1396 files changed
+807029
-736282
No files matched your search
+2
-2
@@ -26,7 +26,7 @@ const transaction = await orderModuleService.addTransactions({
|
||||
|
||||
### Parameters
|
||||
|
||||
<TypeList types={[{"name":"data","type":"[CreateOrderTransactionDTO](../../../interfaces/order.CreateOrderTransactionDTO/page.mdx)","description":"The transaction to be created.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The amount of the transaction.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../types/order.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"currency_code","type":"`string`","description":"The currency code of the transaction.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the transaction.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`string`","description":"The data model this transaction references.\nFor example, `payment`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the data model's record referenced.\nFor example, `pay_132`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"The internal note of the transaction.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"The user or customer that created this\ntransaction.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","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":[]}]}]} sectionTitle="addTransactions"/>
|
||||
<TypeList types={[{"name":"data","type":"[CreateOrderTransactionDTO](../../../interfaces/order.CreateOrderTransactionDTO/page.mdx)","description":"The transaction to be created.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The amount of the transaction.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../types/order.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"currency_code","type":"`string`","description":"The currency code of the transaction.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The associated claim's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The associated exchange's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`string`","description":"The data model this transaction references.\nFor example, `payment`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the data model's record referenced.\nFor example, `pay_132`.","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":[]}]}]} sectionTitle="addTransactions"/>
|
||||
|
||||
### Returns
|
||||
|
||||
@@ -48,7 +48,7 @@ const transactions = await orderModuleService.addTransactions([{
|
||||
|
||||
### Parameters
|
||||
|
||||
<TypeList types={[{"name":"data","type":"[CreateOrderTransactionDTO](../../../interfaces/order.CreateOrderTransactionDTO/page.mdx)[]","description":"The order transactions to be created.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The amount of the transaction.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../types/order.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"currency_code","type":"`string`","description":"The currency code of the transaction.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the transaction.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`string`","description":"The data model this transaction references.\nFor example, `payment`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the data model's record referenced.\nFor example, `pay_132`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"The internal note of the transaction.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"The user or customer that created this\ntransaction.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","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":[]}]}]} sectionTitle="addTransactions"/>
|
||||
<TypeList types={[{"name":"data","type":"[CreateOrderTransactionDTO](../../../interfaces/order.CreateOrderTransactionDTO/page.mdx)[]","description":"The order transactions to be created.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The amount of the transaction.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../types/order.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"currency_code","type":"`string`","description":"The currency code of the transaction.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The associated claim's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The associated exchange's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`string`","description":"The data model this transaction references.\nFor example, `payment`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the data model's record referenced.\nFor example, `pay_132`.","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":[]}]}]} sectionTitle="addTransactions"/>
|
||||
|
||||
### Returns
|
||||
|
||||
|
||||
+2
-2
@@ -31,7 +31,7 @@ const orders = await orderModuleService.createOrders([{
|
||||
|
||||
### Parameters
|
||||
|
||||
<TypeList types={[{"name":"data","type":"[CreateOrderDTO](../../../interfaces/order.CreateOrderDTO/page.mdx)[]","description":"The order to be created.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"region_id","type":"`string`","description":"The associated region's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string`","description":"The associated customer's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`string`","description":"The associated sales channel's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"`string`","description":"The status of the order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`string`","description":"The email of the customer that placed the order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency code of the order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The associated shipping address's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"billing_address_id","type":"`string`","description":"The associated billing address's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"[UpdateOrderAddressDTO](../../../interfaces/order.UpdateOrderAddressDTO/page.mdx) \\| [CreateOrderAddressDTO](../../../interfaces/order.CreateOrderAddressDTO/page.mdx)","description":"The shipping address of the order.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string`","description":"The associated customer's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`string`","description":"The company name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The first name of the customer.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The last name of the customer.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`string`","description":"The address 1 of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string`","description":"The address 2 of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`string`","description":"The city of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"The country code of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`string`","description":"The province of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`string`","description":"The postal code of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string`","description":"The phone of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string`","description":"The associated customer's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`string`","description":"The company name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The first name of the customer.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The last name of the customer.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`string`","description":"The address 1 of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string`","description":"The address 2 of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`string`","description":"The city of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"The country code of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{Line truncated
|
||||
<TypeList types={[{"name":"data","type":"[CreateOrderDTO](../../../interfaces/order.CreateOrderDTO/page.mdx)[]","description":"The order to be created.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"region_id","type":"`string`","description":"The associated region's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string`","description":"The associated customer's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`string`","description":"The associated sales channel's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"`string`","description":"The status of the order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`string`","description":"The email of the customer that placed the order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency code of the order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The associated shipping address's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"billing_address_id","type":"`string`","description":"The associated billing address's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"[UpdateOrderAddressDTO](../../../interfaces/order.UpdateOrderAddressDTO/page.mdx) \\| [CreateOrderAddressDTO](../../../interfaces/order.CreateOrderAddressDTO/page.mdx)","description":"The shipping address of the order.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string`","description":"The associated customer's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`string`","description":"The company name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The first name of the customer.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The last name of the customer.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`string`","description":"The address 1 of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string`","description":"The address 2 of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`string`","description":"The city of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"The country code of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`string`","description":"The province of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`string`","description":"The postal code of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string`","description":"The phone of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string`","description":"The associated customer's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`string`","description":"The company name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The first name of the customer.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The last name of the customer.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`string`","description":"The address 1 of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string`","description":"The address 2 of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`string`","description":"The city of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"The country code of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{Line truncated
|
||||
|
||||
### Returns
|
||||
|
||||
@@ -58,7 +58,7 @@ const order = await orderModuleService.createOrders({
|
||||
|
||||
### Parameters
|
||||
|
||||
<TypeList types={[{"name":"data","type":"[CreateOrderDTO](../../../interfaces/order.CreateOrderDTO/page.mdx)","description":"The order to be created.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"region_id","type":"`string`","description":"The associated region's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string`","description":"The associated customer's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`string`","description":"The associated sales channel's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"`string`","description":"The status of the order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`string`","description":"The email of the customer that placed the order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency code of the order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The associated shipping address's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"billing_address_id","type":"`string`","description":"The associated billing address's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"[UpdateOrderAddressDTO](../../../interfaces/order.UpdateOrderAddressDTO/page.mdx) \\| [CreateOrderAddressDTO](../../../interfaces/order.CreateOrderAddressDTO/page.mdx)","description":"The shipping address of the order.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string`","description":"The associated customer's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`string`","description":"The company name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The first name of the customer.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The last name of the customer.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`string`","description":"The address 1 of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string`","description":"The address 2 of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`string`","description":"The city of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"The country code of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`string`","description":"The province of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`string`","description":"The postal code of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string`","description":"The phone of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string`","description":"The associated customer's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`string`","description":"The company name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The first name of the customer.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The last name of the customer.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`string`","description":"The address 1 of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string`","description":"The address 2 of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`string`","description":"The city of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"The country code of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"nLine truncated
|
||||
<TypeList types={[{"name":"data","type":"[CreateOrderDTO](../../../interfaces/order.CreateOrderDTO/page.mdx)","description":"The order to be created.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"region_id","type":"`string`","description":"The associated region's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string`","description":"The associated customer's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`string`","description":"The associated sales channel's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"`string`","description":"The status of the order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`string`","description":"The email of the customer that placed the order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency code of the order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The associated shipping address's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"billing_address_id","type":"`string`","description":"The associated billing address's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"[UpdateOrderAddressDTO](../../../interfaces/order.UpdateOrderAddressDTO/page.mdx) \\| [CreateOrderAddressDTO](../../../interfaces/order.CreateOrderAddressDTO/page.mdx)","description":"The shipping address of the order.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string`","description":"The associated customer's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`string`","description":"The company name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The first name of the customer.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The last name of the customer.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`string`","description":"The address 1 of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string`","description":"The address 2 of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`string`","description":"The city of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"The country code of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`string`","description":"The province of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`string`","description":"The postal code of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string`","description":"The phone of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string`","description":"The associated customer's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`string`","description":"The company name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The first name of the customer.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The last name of the customer.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`string`","description":"The address 1 of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string`","description":"The address 2 of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`string`","description":"The city of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"The country code of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"nLine truncated
|
||||
|
||||
### Returns
|
||||
|
||||
|
||||
+53
@@ -0,0 +1,53 @@
|
||||
---
|
||||
displayed_sidebar: orderReference
|
||||
slug: /references/order/listOrderChanges
|
||||
sidebar_label: listOrderChanges
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# listOrderChanges - Order Module Reference
|
||||
|
||||
This documentation provides a reference to the `listOrderChanges` method. This belongs to the Order Module.
|
||||
|
||||
This method retrieves a paginated list of order changes based on optional filters and configuration.
|
||||
|
||||
## Example
|
||||
|
||||
To retrieve a list of order changes using their IDs:
|
||||
|
||||
```ts
|
||||
const orderChanges = await orderModuleService.listOrderChanges({
|
||||
id: ["123", "321"]
|
||||
})
|
||||
```
|
||||
|
||||
To specify relations that should be retrieved within the exchange:
|
||||
|
||||
```ts
|
||||
const orderChanges = await orderModuleService.listOrderChanges({
|
||||
id: ["123", "321"]
|
||||
}, {
|
||||
relations: ["actions"]
|
||||
})
|
||||
```
|
||||
|
||||
By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
|
||||
|
||||
```ts
|
||||
const orderChanges = await orderModuleService.listOrderChanges({
|
||||
id: ["123", "321"]
|
||||
}, {
|
||||
relations: ["actions"],
|
||||
take: 20,
|
||||
skip: 2
|
||||
})
|
||||
```
|
||||
|
||||
## 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":"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":true,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"[OperatorMap](../../../types/order.OperatorMap/page.mdx)<string>","description":"Filter the order changes by their cancelation date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the arrayLine truncated
|
||||
|
||||
## Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[OrderChangeDTO](../../../interfaces/order.OrderChangeDTO/page.mdx)[]>","optional":false,"defaultValue":"","description":"The list of order changes.","expandable":false,"children":[{"name":"OrderChangeDTO[]","type":"[OrderChangeDTO](../../../interfaces/order.OrderChangeDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"OrderChangeDTO","type":"`object`","description":"The order change details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} sectionTitle="listOrderChanges"/>
|
||||
+1
-1
@@ -46,7 +46,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":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the return reasons by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string` \\| `string`[]","description":"Filter the return reason by their value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"Filter the return reason by their label.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"Filter the return reason by their description.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([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":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the return reasons by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string` \\| `string`[]","description":"Filter the return reason by their value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`sLine 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":"$and","type":"([BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([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 Line truncated
|
||||
|
||||
## Returns
|
||||
|
||||
|
||||
+3
-3
@@ -24,7 +24,7 @@ const orderChange = await orderModuleService.updateOrderChanges({
|
||||
|
||||
### Parameters
|
||||
|
||||
<TypeList types={[{"name":"data","type":"[UpdateOrderChangeDTO](../../../interfaces/order.UpdateOrderChangeDTO/page.mdx)","description":"The attributes to update in the order change.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order change.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"`string`","description":"The status of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"The internal note of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_by","type":"`null` \\| `string`","description":"The user or customer that requested the\norder change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_at","type":"`null` \\| `Date`","description":"The date the order change was requested.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_by","type":"`null` \\| `string`","description":"The user or customer that confirmed the\norder change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_at","type":"`null` \\| `Date`","description":"The date the order change was confirmed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_by","type":"`null` \\| `string`","description":"The user or customer that declined\nthe order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_reason","type":"`null` \\| `string`","description":"The reason that the order change was declined.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_at","type":"`null` \\| `Date`","description":"The date that the order change was declined.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_by","type":"`null` \\| `string`","description":"The user or customer that canceled the\norder change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`null` \\| `Date`","description":"The date that the order change was canceled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","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 indicatLine truncated
|
||||
<TypeList types={[{"name":"data","type":"[UpdateOrderChangeDTO](../../../interfaces/order.UpdateOrderChangeDTO/page.mdx)","description":"The attributes to update in the order change.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order change.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"`string`","description":"The status of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`null` \\| `string`","description":"The associated return's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"The internal note of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_by","type":"`null` \\| `string`","description":"The user or customer that requested the\norder change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_at","type":"`null` \\| `Date`","description":"The date the order change was requested.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_by","type":"`null` \\| `string`","description":"The user or customer that confirmed the\norder change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_at","type":"`null` \\| `Date`","description":"The date the order change was confirmed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_by","type":"`null` \\| `string`","description":"The user or customer that declined\nthe order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_reason","type":"`null` \\| `string`","description":"The reason that the order change was declined.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_at","type":"`null` \\| `Date`","description":"The date that the order change was declined.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_by","type":"`null` \\| `string`","description":"The user or customer that canceled the\norder change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`null` \\| `Date`","description":"The date that the order change was canceled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","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 theLine truncated
|
||||
|
||||
### Returns
|
||||
|
||||
@@ -44,7 +44,7 @@ const orderChanges = await orderModuleService.updateOrderChanges([{
|
||||
|
||||
### Parameters
|
||||
|
||||
<TypeList types={[{"name":"data","type":"[UpdateOrderChangeDTO](../../../interfaces/order.UpdateOrderChangeDTO/page.mdx)[]","description":"The order changes to be updated.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order change.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"`string`","description":"The status of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"The internal note of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_by","type":"`null` \\| `string`","description":"The user or customer that requested the\norder change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_at","type":"`null` \\| `Date`","description":"The date the order change was requested.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_by","type":"`null` \\| `string`","description":"The user or customer that confirmed the\norder change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_at","type":"`null` \\| `Date`","description":"The date the order change was confirmed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_by","type":"`null` \\| `string`","description":"The user or customer that declined\nthe order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_reason","type":"`null` \\| `string`","description":"The reason that the order change was declined.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_at","type":"`null` \\| `Date`","description":"The date that the order change was declined.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_by","type":"`null` \\| `string`","description":"The user or customer that canceled the\norder change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`null` \\| `Date`","description":"The date that the order change was canceled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","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 ideLine truncated
|
||||
<TypeList types={[{"name":"data","type":"[UpdateOrderChangeDTO](../../../interfaces/order.UpdateOrderChangeDTO/page.mdx)[]","description":"The order changes to be updated.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order change.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"`string`","description":"The status of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`null` \\| `string`","description":"The associated return's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"The internal note of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_by","type":"`null` \\| `string`","description":"The user or customer that requested the\norder change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_at","type":"`null` \\| `Date`","description":"The date the order change was requested.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_by","type":"`null` \\| `string`","description":"The user or customer that confirmed the\norder change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_at","type":"`null` \\| `Date`","description":"The date the order change was confirmed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_by","type":"`null` \\| `string`","description":"The user or customer that declined\nthe order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_reason","type":"`null` \\| `string`","description":"The reason that the order change was declined.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_at","type":"`null` \\| `Date`","description":"The date that the order change was declined.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_by","type":"`null` \\| `string`","description":"The user or customer that canceled the\norder change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`null` \\| `Date`","description":"The date that the order change was canceled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","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 reLine truncated
|
||||
|
||||
### Returns
|
||||
|
||||
@@ -64,7 +64,7 @@ const orderChanges = await orderModuleService.updateOrderChanges([{
|
||||
|
||||
### Parameters
|
||||
|
||||
<TypeList types={[{"name":"data","type":"[UpdateOrderChangeDTO](../../../interfaces/order.UpdateOrderChangeDTO/page.mdx) \\| [UpdateOrderChangeDTO](../../../interfaces/order.UpdateOrderChangeDTO/page.mdx)[]","description":"The data to update in each order change.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order change.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The ID of the order change.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"`string`","description":"The status of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"The internal note of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_by","type":"`null` \\| `string`","description":"The user or customer that requested the\norder change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_at","type":"`null` \\| `Date`","description":"The date the order change was requested.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_by","type":"`null` \\| `string`","description":"The user or customer that confirmed the\norder change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_at","type":"`null` \\| `Date`","description":"The date the order change was confirmed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_by","type":"`null` \\| `string`","description":"The user or customer that declined\nthe order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_reason","type":"`null` \\| `string`","description":"The reason that the order change was declined.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_at","type":"`null` \\| `Date`","description":"The date that the order change was declined.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_by","type":"`null` \\| `string`","description":"The user or customer that canceled the\norder change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`null` \\| `Date`","description":"The date that the order change was canceled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"`string`","description":"The status of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"The internal note of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_by","type":"`null` \\| `string`","description":"The user or customer that requested the\norder change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_at","type":"`null` \\| `Date`","description":"The date the order change was requested.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_by","type":"`null` \\| `string`","description":"The user or customer that confirmed the\norder change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_at","type":"`null` \\| `Date`","description":"The date the order change was confirmed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_by","type":"`null` \\| `string`","description":"The user or customer that declined\nthe order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_reason","type":"`null` \\| `string`","description":"The reason that the order change was declined.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_at","type":"`null` \\| `Date`","description":"The date that the order change was declined.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_by","type":"`null` \\| `string`","description":"The user or customer that canceled the\norder change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`null` \\| `Date`","description":"The date that the order chaLine truncated
|
||||
<TypeList types={[{"name":"data","type":"[UpdateOrderChangeDTO](../../../interfaces/order.UpdateOrderChangeDTO/page.mdx) \\| [UpdateOrderChangeDTO](../../../interfaces/order.UpdateOrderChangeDTO/page.mdx)[]","description":"The data to update in each order change.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order change.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The ID of the order change.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"`string`","description":"The status of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`null` \\| `string`","description":"The associated return's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"The internal note of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_by","type":"`null` \\| `string`","description":"The user or customer that requested the\norder change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_at","type":"`null` \\| `Date`","description":"The date the order change was requested.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_by","type":"`null` \\| `string`","description":"The user or customer that confirmed the\norder change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_at","type":"`null` \\| `Date`","description":"The date the order change was confirmed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_by","type":"`null` \\| `string`","description":"The user or customer that declined\nthe order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_reason","type":"`null` \\| `string`","description":"The reason that the order change was declined.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_at","type":"`null` \\| `Date`","description":"The date that the order change was declined.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_by","type":"`null` \\| `string`","description":"The user or customer that canceled the\norder change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`null` \\| `Date`","description":"The date that the order change was canceled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"`string`","description":"The status of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`null` \\| `string`","description":"The associated return's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"The internal note of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_by","type":"`null` \\| `string`","description":"The user or customer that requested the\norder change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_at","type":"`null` \\| `Date`","description":"The date the order change was requested.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_by","type":"`null` \\| `string`","description":"The user or customer that confirmed the\norder change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_at","type":"`null` \\| `Date`","description":"The date the order change was confirmed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_by","type":"`null` \\| `string`","description":"The user or customer that declined\nthe order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_reason","type":"`null` \\| `string`","description":"The reason that the order change was declined.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_at","type":"`null` \\| `Date`","description":"The date that the order change was declined.","optional":true,"defaultVaLine truncated
|
||||
|
||||
### Returns
|
||||
|
||||
|
||||
+1
-1
@@ -26,7 +26,7 @@ const returnReasons = await orderModuleService.updateReturnReasons({
|
||||
|
||||
### Parameters
|
||||
|
||||
<TypeList types={[{"name":"selector","type":"Partial<[FilterableOrderReturnReasonProps](../../../interfaces/order.FilterableOrderReturnReasonProps/page.mdx)>","description":"The filters specifying which return reason to delete.","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":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the return reasons by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string` \\| `string`[]","description":"Filter the return reason by their value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"Filter the return reason by their label.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"Filter the return reason by their description.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([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":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the return reasons by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string` \\| `string`[]","description":"Filter the return reason by their value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":Line truncated
|
||||
<TypeList types={[{"name":"selector","type":"Partial<[FilterableOrderReturnReasonProps](../../../interfaces/order.FilterableOrderReturnReasonProps/page.mdx)>","description":"The filters specifying which return reason to delete.","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":"$and","type":"([BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/order.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([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 eLine truncated
|
||||
|
||||
### Returns
|
||||
|
||||
|
||||
Reference in new issue
Block a user