docs: generated references after collapse types improvement (#11889)

This commit is contained in:
Shahed Nasser authored and GitHub committed 2025-03-18 16:48:43 +02:00
1 parent d0ca0f5ce0
commit ac24749bd3
774 files changed
+1612 -1628

No files matched your search

@@ -36,7 +36,7 @@ const orderChangeAction = await orderModuleService.addOrderAction({
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderChangeActionDTO](../../../interfaces/order.OrderChangeActionDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The order change action added.","expandable":false,"children":[{"name":"OrderChangeActionDTO","type":"[OrderChangeActionDTO](../../../interfaces/order.OrderChangeActionDTO/page.mdx)","optional":false,"defaultValue":"","description":"The order change action details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order change action","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_change_id","type":"`null` \\| `string`","description":"The ID of the associated order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_change","type":"`null` \\| [OrderChangeDTO](../../../interfaces/order.OrderChangeDTO/page.mdx)","description":"The associated order change","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the associated order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The ID of the associated return order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The ID of the associated exchange order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The ID of the associated claim order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)","description":"The associated order","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"return_order","type":"[ReturnDTO](../../../interfaces/order.ReturnDTO/page.mdx)","description":"The associated return order","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"exchange","type":"[OrderExchangeDTO](../../../interfaces/order.OrderExchangeDTO/page.mdx)","description":"The associated exchange order","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"claim","type":"[OrderClaimDTO](../../../interfaces/order.OrderClaimDTO/page.mdx)","description":"The associated claim order","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"actions","type":"[OrderChangeActionDTO](../../../interfaces/order.OrderChangeActionDTO/page.mdx)[]","description":"The actions of the order change","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"status","type":"[OrderChangeStatus](../../../types/order.OrderChangeStatus/page.mdx)","description":"The status of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_by","type":"`null` \\| `string`","description":"The requested by of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_at","type":"`null` \\| `string` \\| `Date`","description":"When the order change was requested","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_by","type":"`null` \\| `string`","description":"The confirmed by of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_at","type":"`null` \\| `string` \\| `Date`","description":"When the order change was confirmed","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_by","type":"`null` \\| `string`","description":"The declined by of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_reason","type":"`null` \\| `string`","description":"The declined reason of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"The metadata of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_at","type":"`null` \\| `string` \\| `Date`","description":"When the order change was declined","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_by","type":"`null` \\| `string`","description":"The canceled by of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`null` \\| `string` \\| `Date`","description":"When the order change was canceled","optional":false,"defaultValue":"","expandable":false,"children":[]},Line truncated
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderChangeActionDTO](../../../interfaces/order.OrderChangeActionDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The order change action added.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order change action","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_change_id","type":"`null` \\| `string`","description":"The ID of the associated order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_change","type":"`null` \\| [OrderChangeDTO](../../../interfaces/order.OrderChangeDTO/page.mdx)","description":"The associated order change","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the associated order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The ID of the associated return order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The ID of the associated exchange order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The ID of the associated claim order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)","description":"The associated order","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"return_order","type":"[ReturnDTO](../../../interfaces/order.ReturnDTO/page.mdx)","description":"The associated return order","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"exchange","type":"[OrderExchangeDTO](../../../interfaces/order.OrderExchangeDTO/page.mdx)","description":"The associated exchange order","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"claim","type":"[OrderClaimDTO](../../../interfaces/order.OrderClaimDTO/page.mdx)","description":"The associated claim order","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"actions","type":"[OrderChangeActionDTO](../../../interfaces/order.OrderChangeActionDTO/page.mdx)[]","description":"The actions of the order change","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"status","type":"[OrderChangeStatus](../../../types/order.OrderChangeStatus/page.mdx)","description":"The status of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_by","type":"`null` \\| `string`","description":"The requested by of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_at","type":"`null` \\| `string` \\| `Date`","description":"When the order change was requested","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_by","type":"`null` \\| `string`","description":"The confirmed by of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_at","type":"`null` \\| `string` \\| `Date`","description":"When the order change was confirmed","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_by","type":"`null` \\| `string`","description":"The declined by of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_reason","type":"`null` \\| `string`","description":"The declined reason of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"The metadata of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_at","type":"`null` \\| `string` \\| `Date`","description":"When the order change was declined","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_by","type":"`null` \\| `string`","description":"The canceled by of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`null` \\| `string` \\| `Date`","description":"When the order change was canceled","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the order change was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"WLine truncated
## addOrderAction(data, sharedContext?): Promise&#60;[OrderChangeActionDTO](../../../interfaces/order.OrderChangeActionDTO/page.mdx)[]&#62;
@@ -58,4 +58,4 @@ const orderChangeActions = await orderModuleService.addOrderAction([{
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderChangeActionDTO](../../../interfaces/order.OrderChangeActionDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The created order change actions.","expandable":false,"children":[{"name":"OrderChangeActionDTO[]","type":"[OrderChangeActionDTO](../../../interfaces/order.OrderChangeActionDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"OrderChangeActionDTO","type":"`object`","description":"The order change action details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="addOrderAction"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderChangeActionDTO](../../../interfaces/order.OrderChangeActionDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The created order change actions.","expandable":false,"children":[{"name":"OrderChangeActionDTO[]","type":"[OrderChangeActionDTO](../../../interfaces/order.OrderChangeActionDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order change action","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_change_id","type":"`null` \\| `string`","description":"The ID of the associated order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_change","type":"`null` \\| [OrderChangeDTO](../../../interfaces/order.OrderChangeDTO/page.mdx)","description":"The associated order change","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the associated order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The ID of the associated return order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The ID of the associated exchange order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The ID of the associated claim order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)","description":"The associated order","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"return_order","type":"[ReturnDTO](../../../interfaces/order.ReturnDTO/page.mdx)","description":"The associated return order","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"exchange","type":"[OrderExchangeDTO](../../../interfaces/order.OrderExchangeDTO/page.mdx)","description":"The associated exchange order","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"claim","type":"[OrderClaimDTO](../../../interfaces/order.OrderClaimDTO/page.mdx)","description":"The associated claim order","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"actions","type":"[OrderChangeActionDTO](../../../interfaces/order.OrderChangeActionDTO/page.mdx)[]","description":"The actions of the order change","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"status","type":"[OrderChangeStatus](../../../types/order.OrderChangeStatus/page.mdx)","description":"The status of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_by","type":"`null` \\| `string`","description":"The requested by of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_at","type":"`null` \\| `string` \\| `Date`","description":"When the order change was requested","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_by","type":"`null` \\| `string`","description":"The confirmed by of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_at","type":"`null` \\| `string` \\| `Date`","description":"When the order change was confirmed","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_by","type":"`null` \\| `string`","description":"The declined by of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_reason","type":"`null` \\| `string`","description":"The declined reason of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"The metadata of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_at","type":"`null` \\| `string` \\| `Date`","description":"When the order change was declined","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_by","type":"`null` \\| `string`","description":"The canceled by of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`null` \\| `string` \\| `Date`","description":"When the order change was canceled","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","tLine truncated
@@ -36,7 +36,7 @@ const transaction = await orderModuleService.addOrderTransactions({
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderTransactionDTO](../../../interfaces/order.OrderTransactionDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The created transaction.","expandable":false,"children":[{"name":"OrderTransactionDTO","type":"[OrderTransactionDTO](../../../interfaces/order.OrderTransactionDTO/page.mdx)","optional":false,"defaultValue":"","description":"The order transaction details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the transaction","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the associated order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The associated order version","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)","description":"The associated order","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../types/order.OrderStatus/page.mdx)","description":"The status of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The subtotal of the order. (Excluding taxes)","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The discount subtotal of the order.","optional":false,"defaultValue":Line truncated
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderTransactionDTO](../../../interfaces/order.OrderTransactionDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The created transaction.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the transaction","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the associated order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The associated order version","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)","description":"The associated order","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../types/order.OrderStatus/page.mdx)","description":"The status of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The subtotal of the order. (Excluding taxes)","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The discount subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The discount total of the order.","optional":false,"defaultValue":"","expandable"Line truncated
## addOrderTransactions(data, sharedContext?): Promise&#60;[OrderTransactionDTO](../../../interfaces/order.OrderTransactionDTO/page.mdx)[]&#62;
@@ -58,4 +58,4 @@ const transactions = await orderModuleService.addOrderTransactions([{
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderTransactionDTO](../../../interfaces/order.OrderTransactionDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The created order transactions.","expandable":false,"children":[{"name":"OrderTransactionDTO[]","type":"[OrderTransactionDTO](../../../interfaces/order.OrderTransactionDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"OrderTransactionDTO","type":"`object`","description":"The order transaction details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="addOrderTransactions"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderTransactionDTO](../../../interfaces/order.OrderTransactionDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The created order transactions.","expandable":false,"children":[{"name":"OrderTransactionDTO[]","type":"[OrderTransactionDTO](../../../interfaces/order.OrderTransactionDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the transaction","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the associated order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The associated order version","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)","description":"The associated order","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../types/order.OrderStatus/page.mdx)","description":"The status of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The subtotal of the order. (Excluding taxes)","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The discount subtotal of the order.","optional":false,"defaultValue":"","expandable":fLine truncated
@@ -35,4 +35,4 @@ const {
## Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderChangeReturn](../../../interfaces/order.OrderChangeReturn/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The changes made by applying the actions on the orders.","expandable":false,"children":[{"name":"OrderChangeReturn","type":"[OrderChangeReturn](../../../interfaces/order.OrderChangeReturn/page.mdx)","optional":false,"defaultValue":"","description":"The details of changes made on orders.","expandable":false,"children":[{"name":"items","type":"`object`[]","description":"The list of items created or updated.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"item_id","type":"`string`","description":"The associated item's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfilled_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's fulfilled quantity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipped_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's shipped quantity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_requested_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's request quantity to be returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_received_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's quantity that was received through a return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_dismissed_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's quantity that was dismissed in a return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"written_off_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's quantity that was written off.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"shippingMethods","type":"`any`[]","description":"The list of shipping methods created or updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="applyPendingOrderActions"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderChangeReturn](../../../interfaces/order.OrderChangeReturn/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The changes made by applying the actions on the orders.","expandable":false,"children":[{"name":"items","type":"`object`[]","description":"The list of items created or updated.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"item_id","type":"`string`","description":"The associated item's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfilled_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's fulfilled quantity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipped_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's shipped quantity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_requested_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's request quantity to be returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_received_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's quantity that was received through a return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_dismissed_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's quantity that was dismissed in a return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"written_off_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's quantity that was written off.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"shippingMethods","type":"`any`[]","description":"The list of shipping methods created or updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="applyPendingOrderActions"/>
@@ -32,7 +32,7 @@ const orders = await orderModuleService.archive(["123", "321"])
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The archived orders.","expandable":false,"children":[{"name":"OrderDTO[]","type":"[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"OrderDTO","type":"`object`","description":"The order details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="archive"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The archived orders.","expandable":false,"children":[{"name":"OrderDTO[]","type":"[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../types/order.OrderStatus/page.mdx)","description":"The status of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item total of the order.","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":"original_item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item subtotal of the order.","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":"original_item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item tax total of the order.","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":"item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item total of the order.","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":"item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item subtotal of the order.","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":"item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optionLine truncated
## archive(orderId, sharedContext?): Promise&#60;[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)&#62;
@@ -50,4 +50,4 @@ const order = await orderModuleService.archive("123")
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The archived order.","expandable":false,"children":[{"name":"OrderDTO","type":"[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)","optional":false,"defaultValue":"","description":"The order details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../types/order.OrderStatus/page.mdx)","description":"The status of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item total of the order.","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":"original_item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item subtotal of the order.","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":"original_item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item tax total of the order.","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":"item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item total of the order.","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":"item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item subtotal of the order.","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":"item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description"Line truncated
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The archived order.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../types/order.OrderStatus/page.mdx)","description":"The status of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item total of the order.","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":"original_item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item subtotal of the order.","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":"original_item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item tax total of the order.","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":"item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item total of the order.","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":"item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item subtotal of the order.","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":"item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item tax total of the order.","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":"","opLine truncated
@@ -32,7 +32,7 @@ const orders = await orderModuleService.cancel(["123", "321"])
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The canceled orders.","expandable":false,"children":[{"name":"OrderDTO[]","type":"[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"OrderDTO","type":"`object`","description":"The order details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="cancel"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The canceled orders.","expandable":false,"children":[{"name":"OrderDTO[]","type":"[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../types/order.OrderStatus/page.mdx)","description":"The status of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item total of the order.","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":"original_item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item subtotal of the order.","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":"original_item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item tax total of the order.","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":"item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item total of the order.","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":"item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item subtotal of the order.","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":"item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optionLine truncated
## cancel(orderId, sharedContext?): Promise&#60;[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)&#62;
@@ -50,4 +50,4 @@ const orders = await orderModuleService.cancel("123")
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"Represents the completion of an asynchronous operation","expandable":false,"children":[{"name":"OrderDTO","type":"[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)","optional":false,"defaultValue":"","description":"The order details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../types/order.OrderStatus/page.mdx)","description":"The status of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item total of the order.","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":"original_item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item subtotal of the order.","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":"original_item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item tax total of the order.","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":"item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item total of the order.","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":"item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item subtotal of the order.","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":"item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numerLine truncated
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"Represents the completion of an asynchronous operation","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../types/order.OrderStatus/page.mdx)","description":"The status of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item total of the order.","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":"original_item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item subtotal of the order.","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":"original_item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item tax total of the order.","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":"item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item total of the order.","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":"item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item subtotal of the order.","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":"item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../types/order.BigNumberRawVaLine truncated
@@ -32,4 +32,4 @@ const claim = await orderModuleService.cancelClaim({
## Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderClaimDTO](../../../interfaces/order.OrderClaimDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The canceled claim.","expandable":false,"children":[{"name":"OrderClaimDTO","type":"[OrderClaimDTO](../../../interfaces/order.OrderClaimDTO/page.mdx)","optional":false,"defaultValue":"","description":"The claim details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The claim's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[OrderClaimType](../../../types/order.OrderClaimType/page.mdx)","description":"The claim's type.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the associated order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_version","type":"`number`","description":"The version of the order when the claim is applied.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The claim's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_items","type":"`any`[]","description":"The items to be received from the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"additional_items","type":"`any`[]","description":"The items to be sent to the customer\nif the claim's type is `replace`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)","description":"The associated order.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../types/order.OrderStatus/page.mdx)","description":"The status of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order.","optionLine truncated
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderClaimDTO](../../../interfaces/order.OrderClaimDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The canceled claim.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The claim's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[OrderClaimType](../../../types/order.OrderClaimType/page.mdx)","description":"The claim's type.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the associated order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_version","type":"`number`","description":"The version of the order when the claim is applied.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The claim's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_items","type":"`any`[]","description":"The items to be received from the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"additional_items","type":"`any`[]","description":"The items to be sent to the customer\nif the claim's type is `replace`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)","description":"The associated order.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../types/order.OrderStatus/page.mdx)","description":"The status of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The total of the order.","optional"Line truncated
@@ -32,4 +32,4 @@ const exchange = await orderModuleService.cancelExchange({
## Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderExchangeDTO](../../../interfaces/order.OrderExchangeDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The canceled order exchange.","expandable":false,"children":[{"name":"OrderExchangeDTO","type":"[OrderExchangeDTO](../../../interfaces/order.OrderExchangeDTO/page.mdx)","optional":false,"defaultValue":"","description":"The exchange details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The exchange's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_version","type":"`number`","description":"The version of the order when the exchange is applied.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The exchange's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"additional_items","type":"`any`[]","description":"The items to be sent to the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)","description":"The associated order.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../types/order.OrderStatus/page.mdx)","description":"The status of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","descriptioLine truncated
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderExchangeDTO](../../../interfaces/order.OrderExchangeDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The canceled order exchange.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The exchange's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_version","type":"`number`","description":"The version of the order when the exchange is applied.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The exchange's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"additional_items","type":"`any`[]","description":"The items to be sent to the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)","description":"The associated order.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../types/order.OrderStatus/page.mdx)","description":"The status of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The subtotal of the order. (Excluding taxes)","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","Line truncated
@@ -32,4 +32,4 @@ const orderReturn = await orderModuleService.cancelReturn({
## Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[ReturnDTO](../../../interfaces/order.ReturnDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The canceled return.","expandable":false,"children":[{"name":"ReturnDTO","type":"[ReturnDTO](../../../interfaces/order.ReturnDTO/page.mdx)","optional":false,"defaultValue":"","description":"The return details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ReturnStatus](../../../types/order.ReturnStatus/page.mdx)","description":"The status of the return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[OrderReturnItemDTO](../../../interfaces/order.OrderReturnItemDTO/page.mdx)[]","description":"The items of the return","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order return item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"The associated line item's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"The quantity of the item to return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reason_id","type":"`null` \\| `string`","description":"The associated reason's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"received_quantity","type":"`number`","description":"The received quantity of the return item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"damaged_quantity","type":"`number`","description":"The damaged quantity of the return item.","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":"created_at","type":"`string` \\| `Date`","description":"The creation date of the return item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the return item.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"display_id","type":"`number`","description":"The return's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refund_amount","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The refund amount of the return.","optional":true,"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":"raw_refund_amount","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The raw refund amount of the return.","optional":true,"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":"order","type":"[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)","description":"The associated order.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"displaLine truncated
<TypeList types={[{"name":"Promise","type":"Promise&#60;[ReturnDTO](../../../interfaces/order.ReturnDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The canceled return.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ReturnStatus](../../../types/order.ReturnStatus/page.mdx)","description":"The status of the return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[OrderReturnItemDTO](../../../interfaces/order.OrderReturnItemDTO/page.mdx)[]","description":"The items of the return","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order return item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"The associated line item's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"The quantity of the item to return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reason_id","type":"`null` \\| `string`","description":"The associated reason's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"received_quantity","type":"`number`","description":"The received quantity of the return item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"damaged_quantity","type":"`number`","description":"The damaged quantity of the return item.","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":"created_at","type":"`string` \\| `Date`","description":"The creation date of the return item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the return item.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"display_id","type":"`number`","description":"The return's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refund_amount","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The refund amount of the return.","optional":true,"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":"raw_refund_amount","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The raw refund amount of the return.","optional":true,"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":"order","type":"[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)","description":"The associated order.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../types/orLine truncated
@@ -34,7 +34,7 @@ const orders = await orderModuleService.completeOrder([
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The completed orders.","expandable":false,"children":[{"name":"OrderDTO[]","type":"[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"OrderDTO","type":"`object`","description":"The order details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="completeOrder"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The completed orders.","expandable":false,"children":[{"name":"OrderDTO[]","type":"[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../types/order.OrderStatus/page.mdx)","description":"The status of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item total of the order.","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":"original_item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item subtotal of the order.","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":"original_item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item tax total of the order.","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":"item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item total of the order.","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":"item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item subtotal of the order.","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":"item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optioLine truncated
## completeOrder(orderId, sharedContext?): Promise&#60;[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)&#62;
@@ -52,4 +52,4 @@ const order = await orderModuleService.completeOrder("123")
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The completed order.","expandable":false,"children":[{"name":"OrderDTO","type":"[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)","optional":false,"defaultValue":"","description":"The order details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../types/order.OrderStatus/page.mdx)","description":"The status of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item total of the order.","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":"original_item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item subtotal of the order.","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":"original_item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item tax total of the order.","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":"item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item total of the order.","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":"item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item subtotal of the order.","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":"item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","descriptionLine truncated
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The completed order.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../types/order.OrderStatus/page.mdx)","description":"The status of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item total of the order.","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":"original_item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item subtotal of the order.","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":"original_item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item tax total of the order.","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":"item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item total of the order.","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":"item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item subtotal of the order.","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":"item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item tax total of the order.","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":"","oLine truncated
@@ -35,7 +35,7 @@ const {
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderChangeReturn](../../../interfaces/order.OrderChangeReturn/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The item and shipping method changes made on the order.","expandable":false,"children":[{"name":"OrderChangeReturn","type":"[OrderChangeReturn](../../../interfaces/order.OrderChangeReturn/page.mdx)","optional":false,"defaultValue":"","description":"The details of changes made on orders.","expandable":false,"children":[{"name":"items","type":"`object`[]","description":"The list of items created or updated.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"item_id","type":"`string`","description":"The associated item's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfilled_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's fulfilled quantity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipped_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's shipped quantity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_requested_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's request quantity to be returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_received_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's quantity that was received through a return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_dismissed_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's quantity that was dismissed in a return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"written_off_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's quantity that was written off.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"shippingMethods","type":"`any`[]","description":"The list of shipping methods created or updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="confirmOrderChange"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderChangeReturn](../../../interfaces/order.OrderChangeReturn/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The item and shipping method changes made on the order.","expandable":false,"children":[{"name":"items","type":"`object`[]","description":"The list of items created or updated.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"item_id","type":"`string`","description":"The associated item's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfilled_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's fulfilled quantity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipped_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's shipped quantity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_requested_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's request quantity to be returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_received_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's quantity that was received through a return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_dismissed_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's quantity that was dismissed in a return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"written_off_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's quantity that was written off.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"shippingMethods","type":"`any`[]","description":"The list of shipping methods created or updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="confirmOrderChange"/>
## confirmOrderChange(orderChangeId, sharedContext?): Promise&#60;[OrderChangeReturn](../../../interfaces/order.OrderChangeReturn/page.mdx)&#62;
@@ -53,7 +53,7 @@ await orderModuleService.confirmOrderChange(["123"])
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderChangeReturn](../../../interfaces/order.OrderChangeReturn/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The item and shipping method changes made on the order.","expandable":false,"children":[{"name":"OrderChangeReturn","type":"[OrderChangeReturn](../../../interfaces/order.OrderChangeReturn/page.mdx)","optional":false,"defaultValue":"","description":"The details of changes made on orders.","expandable":false,"children":[{"name":"items","type":"`object`[]","description":"The list of items created or updated.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"item_id","type":"`string`","description":"The associated item's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfilled_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's fulfilled quantity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipped_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's shipped quantity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_requested_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's request quantity to be returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_received_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's quantity that was received through a return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_dismissed_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's quantity that was dismissed in a return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"written_off_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's quantity that was written off.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"shippingMethods","type":"`any`[]","description":"The list of shipping methods created or updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="confirmOrderChange"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderChangeReturn](../../../interfaces/order.OrderChangeReturn/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The item and shipping method changes made on the order.","expandable":false,"children":[{"name":"items","type":"`object`[]","description":"The list of items created or updated.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"item_id","type":"`string`","description":"The associated item's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfilled_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's fulfilled quantity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipped_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's shipped quantity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_requested_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's request quantity to be returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_received_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's quantity that was received through a return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_dismissed_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's quantity that was dismissed in a return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"written_off_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's quantity that was written off.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"shippingMethods","type":"`any`[]","description":"The list of shipping methods created or updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="confirmOrderChange"/>
## confirmOrderChange(data, sharedContext?): Promise&#60;[OrderChangeReturn](../../../interfaces/order.OrderChangeReturn/page.mdx)&#62;
@@ -74,7 +74,7 @@ await orderModuleService.confirmOrderChange({
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderChangeReturn](../../../interfaces/order.OrderChangeReturn/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The item and shipping method changes made on the order.","expandable":false,"children":[{"name":"OrderChangeReturn","type":"[OrderChangeReturn](../../../interfaces/order.OrderChangeReturn/page.mdx)","optional":false,"defaultValue":"","description":"The details of changes made on orders.","expandable":false,"children":[{"name":"items","type":"`object`[]","description":"The list of items created or updated.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"item_id","type":"`string`","description":"The associated item's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfilled_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's fulfilled quantity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipped_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's shipped quantity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_requested_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's request quantity to be returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_received_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's quantity that was received through a return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_dismissed_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's quantity that was dismissed in a return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"written_off_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's quantity that was written off.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"shippingMethods","type":"`any`[]","description":"The list of shipping methods created or updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="confirmOrderChange"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderChangeReturn](../../../interfaces/order.OrderChangeReturn/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The item and shipping method changes made on the order.","expandable":false,"children":[{"name":"items","type":"`object`[]","description":"The list of items created or updated.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"item_id","type":"`string`","description":"The associated item's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfilled_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's fulfilled quantity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipped_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's shipped quantity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_requested_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's request quantity to be returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_received_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's quantity that was received through a return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_dismissed_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's quantity that was dismissed in a return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"written_off_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's quantity that was written off.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"shippingMethods","type":"`any`[]","description":"The list of shipping methods created or updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="confirmOrderChange"/>
## confirmOrderChange(data, sharedContext?): Promise&#60;[OrderChangeReturn](../../../interfaces/order.OrderChangeReturn/page.mdx)&#62;
@@ -95,4 +95,4 @@ await orderModuleService.confirmOrderChange([{
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderChangeReturn](../../../interfaces/order.OrderChangeReturn/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The item and shipping method changes made on all the orders.","expandable":false,"children":[{"name":"OrderChangeReturn","type":"[OrderChangeReturn](../../../interfaces/order.OrderChangeReturn/page.mdx)","optional":false,"defaultValue":"","description":"The details of changes made on orders.","expandable":false,"children":[{"name":"items","type":"`object`[]","description":"The list of items created or updated.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"item_id","type":"`string`","description":"The associated item's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfilled_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's fulfilled quantity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipped_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's shipped quantity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_requested_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's request quantity to be returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_received_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's quantity that was received through a return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_dismissed_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's quantity that was dismissed in a return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"written_off_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's quantity that was written off.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"shippingMethods","type":"`any`[]","description":"The list of shipping methods created or updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="confirmOrderChange"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderChangeReturn](../../../interfaces/order.OrderChangeReturn/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The item and shipping method changes made on all the orders.","expandable":false,"children":[{"name":"items","type":"`object`[]","description":"The list of items created or updated.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"item_id","type":"`string`","description":"The associated item's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfilled_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's fulfilled quantity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipped_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's shipped quantity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_requested_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's request quantity to be returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_received_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's quantity that was received through a return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_dismissed_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's quantity that was dismissed in a return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"written_off_quantity","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The item's quantity that was written off.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"shippingMethods","type":"`any`[]","description":"The list of shipping methods created or updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="confirmOrderChange"/>
@@ -33,4 +33,4 @@ const claim = await orderModuleService.createClaim({
## Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderClaimDTO](../../../interfaces/order.OrderClaimDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The created claim.","expandable":false,"children":[{"name":"OrderClaimDTO","type":"[OrderClaimDTO](../../../interfaces/order.OrderClaimDTO/page.mdx)","optional":false,"defaultValue":"","description":"The claim details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The claim's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[OrderClaimType](../../../types/order.OrderClaimType/page.mdx)","description":"The claim's type.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the associated order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_version","type":"`number`","description":"The version of the order when the claim is applied.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The claim's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_items","type":"`any`[]","description":"The items to be received from the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"additional_items","type":"`any`[]","description":"The items to be sent to the customer\nif the claim's type is `replace`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)","description":"The associated order.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../types/order.OrderStatus/page.mdx)","description":"The status of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order.","optionaLine truncated
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderClaimDTO](../../../interfaces/order.OrderClaimDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The created claim.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The claim's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[OrderClaimType](../../../types/order.OrderClaimType/page.mdx)","description":"The claim's type.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the associated order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_version","type":"`number`","description":"The version of the order when the claim is applied.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The claim's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_items","type":"`any`[]","description":"The items to be received from the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"additional_items","type":"`any`[]","description":"The items to be sent to the customer\nif the claim's type is `replace`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)","description":"The associated order.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../types/order.OrderStatus/page.mdx)","description":"The status of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The total of the order.","optional":Line truncated
@@ -38,4 +38,4 @@ const exchange = await orderModuleService.createExchange({
## Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderExchangeDTO](../../../interfaces/order.OrderExchangeDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The created order exchange.","expandable":false,"children":[{"name":"OrderExchangeDTO","type":"[OrderExchangeDTO](../../../interfaces/order.OrderExchangeDTO/page.mdx)","optional":false,"defaultValue":"","description":"The exchange details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The exchange's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_version","type":"`number`","description":"The version of the order when the exchange is applied.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The exchange's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"additional_items","type":"`any`[]","description":"The items to be sent to the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)","description":"The associated order.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../types/order.OrderStatus/page.mdx)","description":"The status of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","descriptionLine truncated
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderExchangeDTO](../../../interfaces/order.OrderExchangeDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The created order exchange.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The exchange's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_version","type":"`number`","description":"The version of the order when the exchange is applied.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The exchange's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"additional_items","type":"`any`[]","description":"The items to be sent to the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)","description":"The associated order.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../types/order.OrderStatus/page.mdx)","description":"The status of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The subtotal of the order. (Excluding taxes)","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","dLine truncated
@@ -42,7 +42,7 @@ const addresses = await orderModuleService.createOrderAddresses([
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderAddressDTO](../../../interfaces/order.OrderAddressDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The created addresses.","expandable":false,"children":[{"name":"OrderAddressDTO[]","type":"[OrderAddressDTO](../../../interfaces/order.OrderAddressDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"OrderAddressDTO","type":"`object`","description":"The address details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createOrderAddresses"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderAddressDTO](../../../interfaces/order.OrderAddressDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The created addresses.","expandable":false,"children":[{"name":"OrderAddressDTO[]","type":"[OrderAddressDTO](../../../interfaces/order.OrderAddressDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the address was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the address was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string`","description":"The customer ID of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The first name of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The last name of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string`","description":"The phone number of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`string`","description":"The company of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`string`","description":"The first address line of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string`","description":"The second address line 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/state 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":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createOrderAddresses"/>
## createOrderAddresses(data, sharedContext?): Promise&#60;[OrderAddressDTO](../../../interfaces/order.OrderAddressDTO/page.mdx)&#62;
@@ -68,4 +68,4 @@ const address = await orderModuleService.createOrderAddresses({
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderAddressDTO](../../../interfaces/order.OrderAddressDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The created return.","expandable":false,"children":[{"name":"OrderAddressDTO","type":"[OrderAddressDTO](../../../interfaces/order.OrderAddressDTO/page.mdx)","optional":false,"defaultValue":"","description":"The address details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the address was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the address was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string`","description":"The customer ID of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The first name of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The last name of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string`","description":"The phone number of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`string`","description":"The company of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`string`","description":"The first address line of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string`","description":"The second address line 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/state 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":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createOrderAddresses"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderAddressDTO](../../../interfaces/order.OrderAddressDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The created return.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the address was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the address was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string`","description":"The customer ID of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The first name of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The last name of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string`","description":"The phone number of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`string`","description":"The company of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`string`","description":"The first address line of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string`","description":"The second address line 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/state 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":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createOrderAddresses"/>
@@ -34,7 +34,7 @@ const orderChange = await orderModuleService.createOrderChange({
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderChangeDTO](../../../interfaces/order.OrderChangeDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The created order change.","expandable":false,"children":[{"name":"OrderChangeDTO","type":"[OrderChangeDTO](../../../interfaces/order.OrderChangeDTO/page.mdx)","optional":false,"defaultValue":"","description":"The order change details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the associated order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The ID of the associated return order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The ID of the associated exchange order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The ID of the associated claim order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)","description":"The associated order","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../types/order.OrderStatus/page.mdx)","description":"The status of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The subtotal of the order. (Excluding taxes)Line truncated
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderChangeDTO](../../../interfaces/order.OrderChangeDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The created order change.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the associated order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The ID of the associated return order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The ID of the associated exchange order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The ID of the associated claim order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)","description":"The associated order","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../types/order.OrderStatus/page.mdx)","description":"The status of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The subtotal of the order. (Excluding taxes)","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The tax total of the order.","opLine truncated
## createOrderChange(data, sharedContext?): Promise&#60;[OrderChangeDTO](../../../interfaces/order.OrderChangeDTO/page.mdx)[]&#62;
@@ -56,7 +56,7 @@ const orderChanges = await orderModuleService.createOrderChange([
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderChangeDTO](../../../interfaces/order.OrderChangeDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The created 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":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createOrderChange"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderChangeDTO](../../../interfaces/order.OrderChangeDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The created order changes.","expandable":false,"children":[{"name":"OrderChangeDTO[]","type":"[OrderChangeDTO](../../../interfaces/order.OrderChangeDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the associated order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The ID of the associated return order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The ID of the associated exchange order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The ID of the associated claim order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)","description":"The associated order","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../types/order.OrderStatus/page.mdx)","description":"The status of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The subtotal of the order. (Excluding taxes)","optional":falseLine truncated
## createOrderChange(data, sharedContext?): Promise&#60;[OrderChangeDTO](../../../interfaces/order.OrderChangeDTO/page.mdx) \| [OrderChangeDTO](../../../interfaces/order.OrderChangeDTO/page.mdx)[]&#62;
@@ -36,7 +36,7 @@ const orderClaimItem = await orderModuleService.createOrderClaimItems({
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderClaimItemDTO](../../../interfaces/order.OrderClaimItemDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The created order claim item.","expandable":false,"children":[{"name":"OrderClaimItemDTO","type":"[OrderClaimItemDTO](../../../interfaces/order.OrderClaimItemDTO/page.mdx)","optional":false,"defaultValue":"","description":"The order claim item details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order claim item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The associated claim's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"The associated item's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"[OrderLineItemDTO](../../../interfaces/order.OrderLineItemDTO/page.mdx)","description":"The associated item.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The discount total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The discount tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The refundable total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_total_per_unit","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The refundable total per unit of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The ID of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`boolean`","description":"Indicates whether the line item requires shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_discountable","type":"`boolean`","description":"Indicates whether the line item is discountable.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`boolean`","description":"Indicates whether the line item price is tax inclusive.","optional":false,"defaultValue":"","expandablLine truncated
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderClaimItemDTO](../../../interfaces/order.OrderClaimItemDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The created order claim item.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order claim item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The associated claim's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"The associated item's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"[OrderLineItemDTO](../../../interfaces/order.OrderLineItemDTO/page.mdx)","description":"The associated item.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The discount total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The discount tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The refundable total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_total_per_unit","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The refundable total per unit of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The ID of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`boolean`","description":"Indicates whether the line item requires shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_discountable","type":"`boolean`","description":"Indicates whether the line item is discountable.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`boolean`","description":"Indicates whether the line item price is tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"unit_price","type":"`number`","description":"The unit price of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","descLine truncated
## createOrderClaimItems(data, sharedContext?): Promise&#60;[OrderClaimItemDTO](../../../interfaces/order.OrderClaimItemDTO/page.mdx)[]&#62;
@@ -66,4 +66,4 @@ const orderClaimItems = await orderModuleService.createOrderClaimItems([
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderClaimItemDTO](../../../interfaces/order.OrderClaimItemDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The created order claim items.","expandable":false,"children":[{"name":"OrderClaimItemDTO[]","type":"[OrderClaimItemDTO](../../../interfaces/order.OrderClaimItemDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"OrderClaimItemDTO","type":"`object`","description":"The order claim item details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createOrderClaimItems"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderClaimItemDTO](../../../interfaces/order.OrderClaimItemDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The created order claim items.","expandable":false,"children":[{"name":"OrderClaimItemDTO[]","type":"[OrderClaimItemDTO](../../../interfaces/order.OrderClaimItemDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order claim item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The associated claim's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"The associated item's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"[OrderLineItemDTO](../../../interfaces/order.OrderLineItemDTO/page.mdx)","description":"The associated item.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The discount total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The discount tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The refundable total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_total_per_unit","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The refundable total per unit of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The ID of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`boolean`","description":"Indicates whether the line item requires shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_discountable","type":"`boolean`","description":"Indicates whether the line item is discountable.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`boolean`","description":"Indicates whether the line item price is tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]Line truncated
@@ -35,7 +35,7 @@ const claim = await orderModuleService.createOrderClaims({
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderClaimDTO](../../../interfaces/order.OrderClaimDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The created order claim.","expandable":false,"children":[{"name":"OrderClaimDTO","type":"[OrderClaimDTO](../../../interfaces/order.OrderClaimDTO/page.mdx)","optional":false,"defaultValue":"","description":"The claim details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The claim's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[OrderClaimType](../../../types/order.OrderClaimType/page.mdx)","description":"The claim's type.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the associated order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_version","type":"`number`","description":"The version of the order when the claim is applied.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The claim's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_items","type":"`any`[]","description":"The items to be received from the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"additional_items","type":"`any`[]","description":"The items to be sent to the customer\nif the claim's type is `replace`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)","description":"The associated order.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../types/order.OrderStatus/page.mdx)","description":"The status of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order.","oLine truncated
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderClaimDTO](../../../interfaces/order.OrderClaimDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The created order claim.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The claim's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[OrderClaimType](../../../types/order.OrderClaimType/page.mdx)","description":"The claim's type.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the associated order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_version","type":"`number`","description":"The version of the order when the claim is applied.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The claim's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_items","type":"`any`[]","description":"The items to be received from the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"additional_items","type":"`any`[]","description":"The items to be sent to the customer\nif the claim's type is `replace`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)","description":"The associated order.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../types/order.OrderStatus/page.mdx)","description":"The status of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The total of the order.","optiLine truncated
## createOrderClaims(data, sharedContext?): Promise&#60;[OrderClaimDTO](../../../interfaces/order.OrderClaimDTO/page.mdx)[]&#62;
@@ -56,4 +56,4 @@ const claims = await orderModuleService.createOrderClaims([{
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderClaimDTO](../../../interfaces/order.OrderClaimDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The created order claims.","expandable":false,"children":[{"name":"OrderClaimDTO[]","type":"[OrderClaimDTO](../../../interfaces/order.OrderClaimDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"OrderClaimDTO","type":"`object`","description":"The claim details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createOrderClaims"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderClaimDTO](../../../interfaces/order.OrderClaimDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The created order claims.","expandable":false,"children":[{"name":"OrderClaimDTO[]","type":"[OrderClaimDTO](../../../interfaces/order.OrderClaimDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The claim's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[OrderClaimType](../../../types/order.OrderClaimType/page.mdx)","description":"The claim's type.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the associated order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_version","type":"`number`","description":"The version of the order when the claim is applied.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The claim's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_items","type":"`any`[]","description":"The items to be received from the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"additional_items","type":"`any`[]","description":"The items to be sent to the customer\nif the claim's type is `replace`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)","description":"The associated order.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../types/order.OrderStatus/page.mdx)","description":"The status of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order.","optional":faLine truncated
@@ -22,4 +22,4 @@ You should only use this methods when implementing complex customizations. For c
## Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderCreditLineDTO](../../../interfaces/order.OrderCreditLineDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"OrderCreditLineDTO[]","type":"[OrderCreditLineDTO](../../../interfaces/order.OrderCreditLineDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"OrderCreditLineDTO","type":"`object`","description":"The order credit line details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createOrderCreditLines"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderCreditLineDTO](../../../interfaces/order.OrderCreditLineDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"OrderCreditLineDTO[]","type":"[OrderCreditLineDTO](../../../interfaces/order.OrderCreditLineDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order credit line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the order that the credit line belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)","description":"The associated order","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../types/order.OrderStatus/page.mdx)","description":"The status of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The subtotal of the order. (Excluding taxes)","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The discount subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The discount total of theLine truncated
@@ -36,7 +36,7 @@ const orderExchangeItem = await orderModuleService.createOrderExchangeItems({
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderExchangeItemDTO](../../../interfaces/order.OrderExchangeItemDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The created order exchange item.","expandable":false,"children":[{"name":"OrderExchangeItemDTO","type":"[OrderExchangeItemDTO](../../../interfaces/order.OrderExchangeItemDTO/page.mdx)","optional":false,"defaultValue":"","description":"The order exchange item details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order exchange item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The associated exchange's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"The associated item's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"[OrderLineItemDTO](../../../interfaces/order.OrderLineItemDTO/page.mdx)","description":"The associated item.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The discount total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The discount tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The refundable total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_total_per_unit","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The refundable total per unit of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The ID of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`boolean`","description":"Indicates whether the line item requires shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_discountable","type":"`boolean`","description":"Indicates whether the line item is discountable.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`boolean`","description":"Indicates whether the line item price is tax inclusive.","optional":falsLine truncated
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderExchangeItemDTO](../../../interfaces/order.OrderExchangeItemDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The created order exchange item.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order exchange item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The associated exchange's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"The associated item's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"[OrderLineItemDTO](../../../interfaces/order.OrderLineItemDTO/page.mdx)","description":"The associated item.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The discount total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The discount tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The refundable total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_total_per_unit","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The refundable total per unit of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The ID of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`boolean`","description":"Indicates whether the line item requires shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_discountable","type":"`boolean`","description":"Indicates whether the line item is discountable.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`boolean`","description":"Indicates whether the line item price is tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"unit_price","type":"`number`","description":"The unit price of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","typeLine truncated
## createOrderExchangeItems(data, sharedContext?): Promise&#60;[OrderExchangeItemDTO](../../../interfaces/order.OrderExchangeItemDTO/page.mdx)[]&#62;
@@ -65,4 +65,4 @@ const orderExchangeItems = await orderModuleService.createOrderExchangeItems([
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderExchangeItemDTO](../../../interfaces/order.OrderExchangeItemDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The created order exchange items.","expandable":false,"children":[{"name":"OrderExchangeItemDTO[]","type":"[OrderExchangeItemDTO](../../../interfaces/order.OrderExchangeItemDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"OrderExchangeItemDTO","type":"`object`","description":"The order exchange item details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createOrderExchangeItems"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderExchangeItemDTO](../../../interfaces/order.OrderExchangeItemDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The created order exchange items.","expandable":false,"children":[{"name":"OrderExchangeItemDTO[]","type":"[OrderExchangeItemDTO](../../../interfaces/order.OrderExchangeItemDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order exchange item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The associated exchange's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"The associated item's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"[OrderLineItemDTO](../../../interfaces/order.OrderLineItemDTO/page.mdx)","description":"The associated item.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The discount total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The discount tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The refundable total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_total_per_unit","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The refundable total per unit of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The ID of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`boolean`","description":"Indicates whether the line item requires shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_discountable","type":"`boolean`","description":"Indicates whether the line item is discountable.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`boolean`","description":"Indicates whether the line item price is tax inclusive.","optional":false,"defaultValue":"","expaLine truncated
@@ -40,7 +40,7 @@ const exchange = await orderModuleService.createOrderExchanges({
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderExchangeDTO](../../../interfaces/order.OrderExchangeDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The created order exchange.","expandable":false,"children":[{"name":"OrderExchangeDTO","type":"[OrderExchangeDTO](../../../interfaces/order.OrderExchangeDTO/page.mdx)","optional":false,"defaultValue":"","description":"The exchange details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The exchange's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_version","type":"`number`","description":"The version of the order when the exchange is applied.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The exchange's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"additional_items","type":"`any`[]","description":"The items to be sent to the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)","description":"The associated order.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../types/order.OrderStatus/page.mdx)","description":"The status of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","descriptionLine truncated
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderExchangeDTO](../../../interfaces/order.OrderExchangeDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The created order exchange.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The exchange's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_version","type":"`number`","description":"The version of the order when the exchange is applied.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The exchange's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"additional_items","type":"`any`[]","description":"The items to be sent to the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)","description":"The associated order.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../types/order.OrderStatus/page.mdx)","description":"The status of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The subtotal of the order. (Excluding taxes)","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","dLine truncated
## createOrderExchanges(data, sharedContext?): Promise&#60;[OrderExchangeDTO](../../../interfaces/order.OrderExchangeDTO/page.mdx)[]&#62;
@@ -66,4 +66,4 @@ const exchanges = await orderModuleService.createOrderExchanges([{
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderExchangeDTO](../../../interfaces/order.OrderExchangeDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The created order exchanges.","expandable":false,"children":[{"name":"OrderExchangeDTO[]","type":"[OrderExchangeDTO](../../../interfaces/order.OrderExchangeDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"OrderExchangeDTO","type":"`object`","description":"The exchange details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createOrderExchanges"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderExchangeDTO](../../../interfaces/order.OrderExchangeDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The created order exchanges.","expandable":false,"children":[{"name":"OrderExchangeDTO[]","type":"[OrderExchangeDTO](../../../interfaces/order.OrderExchangeDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The exchange's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_version","type":"`number`","description":"The version of the order when the exchange is applied.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The exchange's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"additional_items","type":"`any`[]","description":"The items to be sent to the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)","description":"The associated order.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../types/order.OrderStatus/page.mdx)","description":"The status of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The subtotaLine truncated
@@ -34,7 +34,7 @@ const lineItemAdjustments = await orderModuleService.createOrderLineItemAdjustme
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderLineItemAdjustmentDTO](../../../interfaces/order.OrderLineItemAdjustmentDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The created line item adjustments.","expandable":false,"children":[{"name":"OrderLineItemAdjustmentDTO[]","type":"[OrderLineItemAdjustmentDTO](../../../interfaces/order.OrderLineItemAdjustmentDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"OrderLineItemAdjustmentDTO","type":"`object`","description":"The line item adjustment details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createOrderLineItemAdjustments"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderLineItemAdjustmentDTO](../../../interfaces/order.OrderLineItemAdjustmentDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The created line item adjustments.","expandable":false,"children":[{"name":"OrderLineItemAdjustmentDTO[]","type":"[OrderLineItemAdjustmentDTO](../../../interfaces/order.OrderLineItemAdjustmentDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the adjustment line","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The amount of the adjustment line","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":"order_id","type":"`string`","description":"The ID of the associated order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the adjustment line was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the adjustment line was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"[OrderLineItemDTO](../../../interfaces/order.OrderLineItemDTO/page.mdx)","description":"The associated line item.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The discount total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The discount tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The refundable total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_total_per_unit","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The refundable total per unit of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The ID of the line item.","optional":false,"defaultValLine truncated
## createOrderLineItemAdjustments(data, sharedContext?): Promise&#60;[OrderLineItemAdjustmentDTO](../../../interfaces/order.OrderLineItemAdjustmentDTO/page.mdx)[]&#62;
@@ -54,7 +54,7 @@ const lineItemAdjustment = await orderModuleService.createOrderLineItemAdjustmen
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderLineItemAdjustmentDTO](../../../interfaces/order.OrderLineItemAdjustmentDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The created line-item adjustment.","expandable":false,"children":[{"name":"OrderLineItemAdjustmentDTO[]","type":"[OrderLineItemAdjustmentDTO](../../../interfaces/order.OrderLineItemAdjustmentDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"OrderLineItemAdjustmentDTO","type":"`object`","description":"The line item adjustment details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createOrderLineItemAdjustments"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderLineItemAdjustmentDTO](../../../interfaces/order.OrderLineItemAdjustmentDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The created line-item adjustment.","expandable":false,"children":[{"name":"OrderLineItemAdjustmentDTO[]","type":"[OrderLineItemAdjustmentDTO](../../../interfaces/order.OrderLineItemAdjustmentDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the adjustment line","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The amount of the adjustment line","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":"order_id","type":"`string`","description":"The ID of the associated order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the adjustment line was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the adjustment line was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"[OrderLineItemDTO](../../../interfaces/order.OrderLineItemDTO/page.mdx)","description":"The associated line item.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The discount total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The discount tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The refundable total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_total_per_unit","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The refundable total per unit of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The ID of the line item.","optional":false,"defaultValuLine truncated
## createOrderLineItemAdjustments(orderId, data, sharedContext?): Promise&#60;[OrderLineItemAdjustmentDTO](../../../interfaces/order.OrderLineItemAdjustmentDTO/page.mdx)[]&#62;
@@ -77,4 +77,4 @@ const lineItemAdjustments = await orderModuleService.createOrderLineItemAdjustme
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderLineItemAdjustmentDTO](../../../interfaces/order.OrderLineItemAdjustmentDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The created line item adjustments.","expandable":false,"children":[{"name":"OrderLineItemAdjustmentDTO[]","type":"[OrderLineItemAdjustmentDTO](../../../interfaces/order.OrderLineItemAdjustmentDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"OrderLineItemAdjustmentDTO","type":"`object`","description":"The line item adjustment details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createOrderLineItemAdjustments"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderLineItemAdjustmentDTO](../../../interfaces/order.OrderLineItemAdjustmentDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The created line item adjustments.","expandable":false,"children":[{"name":"OrderLineItemAdjustmentDTO[]","type":"[OrderLineItemAdjustmentDTO](../../../interfaces/order.OrderLineItemAdjustmentDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the adjustment line","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The amount of the adjustment line","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":"order_id","type":"`string`","description":"The ID of the associated order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the adjustment line was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the adjustment line was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"[OrderLineItemDTO](../../../interfaces/order.OrderLineItemDTO/page.mdx)","description":"The associated line item.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The discount total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The discount tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The refundable total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_total_per_unit","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The refundable total per unit of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The ID of the line item.","optional":false,"defaultValLine truncated
@@ -38,7 +38,7 @@ const lineItemTaxLines = await orderModuleService
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderLineItemTaxLineDTO](../../../interfaces/order.OrderLineItemTaxLineDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The created line item tax lines.","expandable":false,"children":[{"name":"OrderLineItemTaxLineDTO[]","type":"[OrderLineItemTaxLineDTO](../../../interfaces/order.OrderLineItemTaxLineDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"OrderLineItemTaxLineDTO","type":"`object`","description":"The line item tax line details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createOrderLineItemTaxLines"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderLineItemTaxLineDTO](../../../interfaces/order.OrderLineItemTaxLineDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The created line item tax lines.","expandable":false,"children":[{"name":"OrderLineItemTaxLineDTO[]","type":"[OrderLineItemTaxLineDTO](../../../interfaces/order.OrderLineItemTaxLineDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"The code of the tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`number`","description":"The rate of the tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the tax line was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the tax line was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"[OrderLineItemDTO](../../../interfaces/order.OrderLineItemDTO/page.mdx)","description":"The associated line item.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The discount total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The discount tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The refundable total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_total_per_unit","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The refundable total per unit of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The ID of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`boolean`","description":"Indicates whether the line item requires shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_discountable","type":"`boolean`","description":"Indicates whether the line item is discountable.","optional":false,"defaultValue":"","expandable":falLine truncated
## createOrderLineItemTaxLines(taxLine, sharedContext?): Promise&#60;[OrderLineItemTaxLineDTO](../../../interfaces/order.OrderLineItemTaxLineDTO/page.mdx)&#62;
@@ -60,7 +60,7 @@ const lineItemTaxLines = await orderModuleService
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderLineItemTaxLineDTO](../../../interfaces/order.OrderLineItemTaxLineDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The created line item tax line.","expandable":false,"children":[{"name":"OrderLineItemTaxLineDTO","type":"[OrderLineItemTaxLineDTO](../../../interfaces/order.OrderLineItemTaxLineDTO/page.mdx)","optional":false,"defaultValue":"","description":"The line item tax line details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"The code of the tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`number`","description":"The rate of the tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the tax line was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the tax line was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"[OrderLineItemDTO](../../../interfaces/order.OrderLineItemDTO/page.mdx)","description":"The associated line item.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The discount total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The discount tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The refundable total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_total_per_unit","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The refundable total per unit of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The ID of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`boolean`","description":"Indicates whether the line item requires shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_discountable","type":"`boolean`","description":"Indicates whether the line item is discountable.","optional":false,"defaultVaLine truncated
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderLineItemTaxLineDTO](../../../interfaces/order.OrderLineItemTaxLineDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The created line item tax line.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"The code of the tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`number`","description":"The rate of the tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the tax line was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the tax line was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"[OrderLineItemDTO](../../../interfaces/order.OrderLineItemDTO/page.mdx)","description":"The associated line item.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The discount total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The discount tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The refundable total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_total_per_unit","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The refundable total per unit of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The ID of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`boolean`","description":"Indicates whether the line item requires shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_discountable","type":"`boolean`","description":"Indicates whether the line item is discountable.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`boolean`","description":"Indicates whether the line item price is tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"unit_Line truncated
## createOrderLineItemTaxLines(orderId, taxLines, sharedContext?): Promise&#60;[OrderLineItemTaxLineDTO](../../../interfaces/order.OrderLineItemTaxLineDTO/page.mdx)[]&#62;
@@ -87,4 +87,4 @@ const lineItemTaxLines = await orderModuleService
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderLineItemTaxLineDTO](../../../interfaces/order.OrderLineItemTaxLineDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The created line item tax line.","expandable":false,"children":[{"name":"OrderLineItemTaxLineDTO[]","type":"[OrderLineItemTaxLineDTO](../../../interfaces/order.OrderLineItemTaxLineDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"OrderLineItemTaxLineDTO","type":"`object`","description":"The line item tax line details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createOrderLineItemTaxLines"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderLineItemTaxLineDTO](../../../interfaces/order.OrderLineItemTaxLineDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The created line item tax line.","expandable":false,"children":[{"name":"OrderLineItemTaxLineDTO[]","type":"[OrderLineItemTaxLineDTO](../../../interfaces/order.OrderLineItemTaxLineDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"The code of the tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`number`","description":"The rate of the tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the tax line was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the tax line was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"[OrderLineItemDTO](../../../interfaces/order.OrderLineItemDTO/page.mdx)","description":"The associated line item.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The discount total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The discount tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The refundable total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_total_per_unit","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The refundable total per unit of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The ID of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`boolean`","description":"Indicates whether the line item requires shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_discountable","type":"`boolean`","description":"Indicates whether the line item is discountable.","optional":false,"defaultValue":"","expandable":falsLine truncated
@@ -36,7 +36,7 @@ const lineItems = await orderModuleService.createOrderLineItems({
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderLineItemDTO](../../../interfaces/order.OrderLineItemDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The created line items.","expandable":false,"children":[{"name":"OrderLineItemDTO[]","type":"[OrderLineItemDTO](../../../interfaces/order.OrderLineItemDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"OrderLineItemDTO","type":"`object`","description":"The line item details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createOrderLineItems"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderLineItemDTO](../../../interfaces/order.OrderLineItemDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The created line items.","expandable":false,"children":[{"name":"OrderLineItemDTO[]","type":"[OrderLineItemDTO](../../../interfaces/order.OrderLineItemDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order line item.","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":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order line item.","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":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order line item.","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":"item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item total of the order line item.","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":"item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item subtotal of the order line item.","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":"item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item tax total of the order line item.","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":"total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The total of the order line item.","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":"subtotal","type":"[BigNuLine truncated
## createOrderLineItems(data, sharedContext?): Promise&#60;[OrderLineItemDTO](../../../interfaces/order.OrderLineItemDTO/page.mdx)[]&#62;
@@ -58,7 +58,7 @@ const lineItems = await orderModuleService.createOrderLineItems([{
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderLineItemDTO](../../../interfaces/order.OrderLineItemDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The created line items.","expandable":false,"children":[{"name":"OrderLineItemDTO[]","type":"[OrderLineItemDTO](../../../interfaces/order.OrderLineItemDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"OrderLineItemDTO","type":"`object`","description":"The line item details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createOrderLineItems"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderLineItemDTO](../../../interfaces/order.OrderLineItemDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The created line items.","expandable":false,"children":[{"name":"OrderLineItemDTO[]","type":"[OrderLineItemDTO](../../../interfaces/order.OrderLineItemDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order line item.","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":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order line item.","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":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order line item.","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":"item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item total of the order line item.","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":"item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item subtotal of the order line item.","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":"item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item tax total of the order line item.","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":"total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The total of the order line item.","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":"subtotal","type":"[BigNuLine truncated
## createOrderLineItems(orderId, items, sharedContext?): Promise&#60;[OrderLineItemDTO](../../../interfaces/order.OrderLineItemDTO/page.mdx)[]&#62;
@@ -83,4 +83,4 @@ const lineItems = await orderModuleService.createOrderLineItems(
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderLineItemDTO](../../../interfaces/order.OrderLineItemDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The created orders.","expandable":false,"children":[{"name":"OrderLineItemDTO[]","type":"[OrderLineItemDTO](../../../interfaces/order.OrderLineItemDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"OrderLineItemDTO","type":"`object`","description":"The line item details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createOrderLineItems"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderLineItemDTO](../../../interfaces/order.OrderLineItemDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The created orders.","expandable":false,"children":[{"name":"OrderLineItemDTO[]","type":"[OrderLineItemDTO](../../../interfaces/order.OrderLineItemDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order line item.","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":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order line item.","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":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order line item.","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":"item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item total of the order line item.","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":"item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item subtotal of the order line item.","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":"item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item tax total of the order line item.","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":"total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The total of the order line item.","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":"subtotal","type":"[BigNumberLine truncated
@@ -39,7 +39,7 @@ const shippingMethodAdjustments = await orderModuleService
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderShippingMethodAdjustmentDTO](../../../interfaces/order.OrderShippingMethodAdjustmentDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The created shipping method adjustments.","expandable":false,"children":[{"name":"OrderShippingMethodAdjustmentDTO[]","type":"[OrderShippingMethodAdjustmentDTO](../../../interfaces/order.OrderShippingMethodAdjustmentDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"OrderShippingMethodAdjustmentDTO","type":"`object`","description":"The shipping method adjustment details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createOrderShippingMethodAdjustments"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderShippingMethodAdjustmentDTO](../../../interfaces/order.OrderShippingMethodAdjustmentDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The created shipping method adjustments.","expandable":false,"children":[{"name":"OrderShippingMethodAdjustmentDTO[]","type":"[OrderShippingMethodAdjustmentDTO](../../../interfaces/order.OrderShippingMethodAdjustmentDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the adjustment line","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The amount of the adjustment line","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":"order_id","type":"`string`","description":"The ID of the associated order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the adjustment line was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the adjustment line was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_method","type":"[OrderShippingMethodDTO](../../../interfaces/order.OrderShippingMethodDTO/page.mdx)","description":"The associated shipping method.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the associated order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The price of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`boolean`","description":"Whether the shipping method price is tax inclusive or not.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the shipping method was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the shipping method was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The subtotal of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The tax total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The discount total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The discount tax total of the order shipping method.","Line truncated
## createOrderShippingMethodAdjustments(data, sharedContext?): Promise&#60;[OrderShippingMethodAdjustmentDTO](../../../interfaces/order.OrderShippingMethodAdjustmentDTO/page.mdx)&#62;
@@ -62,7 +62,7 @@ const shippingMethodAdjustment = await orderModuleService
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderShippingMethodAdjustmentDTO](../../../interfaces/order.OrderShippingMethodAdjustmentDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The created shipping method adjustment.","expandable":false,"children":[{"name":"OrderShippingMethodAdjustmentDTO","type":"[OrderShippingMethodAdjustmentDTO](../../../interfaces/order.OrderShippingMethodAdjustmentDTO/page.mdx)","optional":false,"defaultValue":"","description":"The shipping method adjustment details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the adjustment line","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The amount of the adjustment line","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":"order_id","type":"`string`","description":"The ID of the associated order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the adjustment line was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the adjustment line was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_method","type":"[OrderShippingMethodDTO](../../../interfaces/order.OrderShippingMethodDTO/page.mdx)","description":"The associated shipping method.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the associated order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The price of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`boolean`","description":"Whether the shipping method price is tax inclusive or not.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the shipping method was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the shipping method was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The subtotal of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The tax total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The discount total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The discount tax total Line truncated
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderShippingMethodAdjustmentDTO](../../../interfaces/order.OrderShippingMethodAdjustmentDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The created shipping method adjustment.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the adjustment line","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The amount of the adjustment line","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":"order_id","type":"`string`","description":"The ID of the associated order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the adjustment line was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the adjustment line was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_method","type":"[OrderShippingMethodDTO](../../../interfaces/order.OrderShippingMethodDTO/page.mdx)","description":"The associated shipping method.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the associated order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The price of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`boolean`","description":"Whether the shipping method price is tax inclusive or not.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the shipping method was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the shipping method was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The subtotal of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The tax total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The discount total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The discount tax total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the shipping method.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shippLine truncated
## createOrderShippingMethodAdjustments(orderId, data, sharedContext?): Promise&#60;[OrderShippingMethodAdjustmentDTO](../../../interfaces/order.OrderShippingMethodAdjustmentDTO/page.mdx)[]&#62;
@@ -88,4 +88,4 @@ const shippingMethodAdjustments = await orderModuleService
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderShippingMethodAdjustmentDTO](../../../interfaces/order.OrderShippingMethodAdjustmentDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The created shipping method adjustments.","expandable":false,"children":[{"name":"OrderShippingMethodAdjustmentDTO[]","type":"[OrderShippingMethodAdjustmentDTO](../../../interfaces/order.OrderShippingMethodAdjustmentDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"OrderShippingMethodAdjustmentDTO","type":"`object`","description":"The shipping method adjustment details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createOrderShippingMethodAdjustments"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderShippingMethodAdjustmentDTO](../../../interfaces/order.OrderShippingMethodAdjustmentDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The created shipping method adjustments.","expandable":false,"children":[{"name":"OrderShippingMethodAdjustmentDTO[]","type":"[OrderShippingMethodAdjustmentDTO](../../../interfaces/order.OrderShippingMethodAdjustmentDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the adjustment line","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The amount of the adjustment line","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":"order_id","type":"`string`","description":"The ID of the associated order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the adjustment line was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the adjustment line was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_method","type":"[OrderShippingMethodDTO](../../../interfaces/order.OrderShippingMethodDTO/page.mdx)","description":"The associated shipping method.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the associated order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The price of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`boolean`","description":"Whether the shipping method price is tax inclusive or not.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the shipping method was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the shipping method was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The subtotal of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The tax total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The discount total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The discount tax total of the order shipping method.","Line truncated
@@ -38,7 +38,7 @@ const shippingMethodTaxLines = await orderModuleService
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderShippingMethodTaxLineDTO](../../../interfaces/order.OrderShippingMethodTaxLineDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The created shipping method tax lines.","expandable":false,"children":[{"name":"OrderShippingMethodTaxLineDTO[]","type":"[OrderShippingMethodTaxLineDTO](../../../interfaces/order.OrderShippingMethodTaxLineDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"OrderShippingMethodTaxLineDTO","type":"`object`","description":"The shipping method tax line details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createOrderShippingMethodTaxLines"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderShippingMethodTaxLineDTO](../../../interfaces/order.OrderShippingMethodTaxLineDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The created shipping method tax lines.","expandable":false,"children":[{"name":"OrderShippingMethodTaxLineDTO[]","type":"[OrderShippingMethodTaxLineDTO](../../../interfaces/order.OrderShippingMethodTaxLineDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"The code of the tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`number`","description":"The rate of the tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the tax line was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the tax line was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_method","type":"[OrderShippingMethodDTO](../../../interfaces/order.OrderShippingMethodDTO/page.mdx)","description":"The associated shipping method.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the associated order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The price of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`boolean`","description":"Whether the shipping method price is tax inclusive or not.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the shipping method was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the shipping method was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The subtotal of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The tax total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The discount total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The discount tax total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the shipping method.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_id","type":"`string`","description":"The ID of the shipping option the method was created from.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record<string, unknown>`","description":"Additional data needed for fulfillment.","optLine truncated
## createOrderShippingMethodTaxLines(taxLine, sharedContext?): Promise&#60;[OrderShippingMethodTaxLineDTO](../../../interfaces/order.OrderShippingMethodTaxLineDTO/page.mdx)&#62;
@@ -60,7 +60,7 @@ const shippingMethodTaxLine = await orderModuleService
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderShippingMethodTaxLineDTO](../../../interfaces/order.OrderShippingMethodTaxLineDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The created shipping method tax line.","expandable":false,"children":[{"name":"OrderShippingMethodTaxLineDTO","type":"[OrderShippingMethodTaxLineDTO](../../../interfaces/order.OrderShippingMethodTaxLineDTO/page.mdx)","optional":false,"defaultValue":"","description":"The shipping method tax line details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"The code of the tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`number`","description":"The rate of the tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the tax line was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the tax line was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_method","type":"[OrderShippingMethodDTO](../../../interfaces/order.OrderShippingMethodDTO/page.mdx)","description":"The associated shipping method.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the associated order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The price of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`boolean`","description":"Whether the shipping method price is tax inclusive or not.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the shipping method was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the shipping method was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The subtotal of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The tax total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The discount total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The discount tax total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the shipping method.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_id","type":"`string`","description":"The ID of the shipping option the method was created from.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record<string, unknown>`","description":"Additional dataLine truncated
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderShippingMethodTaxLineDTO](../../../interfaces/order.OrderShippingMethodTaxLineDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The created shipping method tax line.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"The code of the tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`number`","description":"The rate of the tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the tax line was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the tax line was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_method","type":"[OrderShippingMethodDTO](../../../interfaces/order.OrderShippingMethodDTO/page.mdx)","description":"The associated shipping method.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the associated order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The price of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`boolean`","description":"Whether the shipping method price is tax inclusive or not.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the shipping method was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the shipping method was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The subtotal of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The tax total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The discount total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The discount tax total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the shipping method.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_id","type":"`string`","description":"The ID of the shipping option the method was created from.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record<string, unknown>`","description":"Additional data needed for fulfillment.","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,"Line truncated
## createOrderShippingMethodTaxLines(orderId, taxLines, sharedContext?): Promise&#60;[OrderShippingMethodTaxLineDTO](../../../interfaces/order.OrderShippingMethodTaxLineDTO/page.mdx)[]&#62;
@@ -85,4 +85,4 @@ const shippingMethodTaxLines = await orderModuleService
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderShippingMethodTaxLineDTO](../../../interfaces/order.OrderShippingMethodTaxLineDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The created shipping method tax lines.","expandable":false,"children":[{"name":"OrderShippingMethodTaxLineDTO[]","type":"[OrderShippingMethodTaxLineDTO](../../../interfaces/order.OrderShippingMethodTaxLineDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"OrderShippingMethodTaxLineDTO","type":"`object`","description":"The shipping method tax line details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createOrderShippingMethodTaxLines"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderShippingMethodTaxLineDTO](../../../interfaces/order.OrderShippingMethodTaxLineDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The created shipping method tax lines.","expandable":false,"children":[{"name":"OrderShippingMethodTaxLineDTO[]","type":"[OrderShippingMethodTaxLineDTO](../../../interfaces/order.OrderShippingMethodTaxLineDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"The code of the tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`number`","description":"The rate of the tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the tax line was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the tax line was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_method","type":"[OrderShippingMethodDTO](../../../interfaces/order.OrderShippingMethodDTO/page.mdx)","description":"The associated shipping method.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the associated order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The price of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`boolean`","description":"Whether the shipping method price is tax inclusive or not.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the shipping method was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the shipping method was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The subtotal of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The tax total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The discount total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The discount tax total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the shipping method.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_id","type":"`string`","description":"The ID of the shipping option the method was created from.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record<string, unknown>`","description":"Additional data needed for fulfillment.","optLine truncated
@@ -36,7 +36,7 @@ const shippingMethod = await orderModuleService.createOrderShippingMethods({
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderShippingMethodDTO](../../../interfaces/order.OrderShippingMethodDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The created shipping method.","expandable":false,"children":[{"name":"OrderShippingMethodDTO","type":"[OrderShippingMethodDTO](../../../interfaces/order.OrderShippingMethodDTO/page.mdx)","optional":false,"defaultValue":"","description":"The order shipping method details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the associated order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The price of the shipping method.","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":"raw_amount","type":"[BigNumberRawValue](../../../types/order.BigNumberRawValue/page.mdx)","description":"The raw price of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"is_tax_inclusive","type":"`boolean`","description":"Whether the shipping method price is tax inclusive or not.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the shipping method was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the shipping method was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order shipping method.","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":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order shipping method.","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":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order shipping method.","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":"total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The total of the order shipping method.","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":"`BigNumbeLine truncated
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderShippingMethodDTO](../../../interfaces/order.OrderShippingMethodDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The created shipping method.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the associated order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The price of the shipping method.","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":"raw_amount","type":"[BigNumberRawValue](../../../types/order.BigNumberRawValue/page.mdx)","description":"The raw price of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"is_tax_inclusive","type":"`boolean`","description":"Whether the shipping method price is tax inclusive or not.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the shipping method was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the shipping method was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order shipping method.","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":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order shipping method.","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":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order shipping method.","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":"total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The total of the order shipping method.","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":"subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The subtotal of the order shipping method.","oLine truncated
## createOrderShippingMethods(data, sharedContext?): Promise&#60;[OrderShippingMethodDTO](../../../interfaces/order.OrderShippingMethodDTO/page.mdx)[]&#62;
@@ -58,7 +58,7 @@ const shippingMethods = await orderModuleService.createOrderShippingMethods([{
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderShippingMethodDTO](../../../interfaces/order.OrderShippingMethodDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The created orders.","expandable":false,"children":[{"name":"OrderShippingMethodDTO[]","type":"[OrderShippingMethodDTO](../../../interfaces/order.OrderShippingMethodDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"OrderShippingMethodDTO","type":"`object`","description":"The order shipping method details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createOrderShippingMethods"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderShippingMethodDTO](../../../interfaces/order.OrderShippingMethodDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The created orders.","expandable":false,"children":[{"name":"OrderShippingMethodDTO[]","type":"[OrderShippingMethodDTO](../../../interfaces/order.OrderShippingMethodDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the associated order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The price of the shipping method.","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":"raw_amount","type":"[BigNumberRawValue](../../../types/order.BigNumberRawValue/page.mdx)","description":"The raw price of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"is_tax_inclusive","type":"`boolean`","description":"Whether the shipping method price is tax inclusive or not.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the shipping method was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the shipping method was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order shipping method.","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":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order shipping method.","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":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order shipping method.","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":"total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The total of the order shipping method.","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,Line truncated
## createOrderShippingMethods(orderId, methods, sharedContext?): Promise&#60;[OrderShippingMethodDTO](../../../interfaces/order.OrderShippingMethodDTO/page.mdx)[]&#62;
@@ -85,4 +85,4 @@ const shippingMethods = await orderModuleService.createOrderShippingMethods(
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderShippingMethodDTO](../../../interfaces/order.OrderShippingMethodDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The created shipping methods.","expandable":false,"children":[{"name":"OrderShippingMethodDTO[]","type":"[OrderShippingMethodDTO](../../../interfaces/order.OrderShippingMethodDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"OrderShippingMethodDTO","type":"`object`","description":"The order shipping method details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createOrderShippingMethods"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderShippingMethodDTO](../../../interfaces/order.OrderShippingMethodDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The created shipping methods.","expandable":false,"children":[{"name":"OrderShippingMethodDTO[]","type":"[OrderShippingMethodDTO](../../../interfaces/order.OrderShippingMethodDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the associated order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The price of the shipping method.","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":"raw_amount","type":"[BigNumberRawValue](../../../types/order.BigNumberRawValue/page.mdx)","description":"The raw price of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"is_tax_inclusive","type":"`boolean`","description":"Whether the shipping method price is tax inclusive or not.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the shipping method was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the shipping method was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order shipping method.","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":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order shipping method.","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":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order shipping method.","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":"total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The total of the order shipping method.","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":"","optioLine truncated
@@ -41,7 +41,7 @@ const orders = await orderModuleService.createOrders([{
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The created orders.","expandable":false,"children":[{"name":"OrderDTO[]","type":"[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"OrderDTO","type":"`object`","description":"The order details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createOrders"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The created orders.","expandable":false,"children":[{"name":"OrderDTO[]","type":"[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../types/order.OrderStatus/page.mdx)","description":"The status of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item total of the order.","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":"original_item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item subtotal of the order.","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":"original_item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item tax total of the order.","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":"item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item total of the order.","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":"item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item subtotal of the order.","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":"item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optionaLine truncated
## createOrders(data, sharedContext?): Promise&#60;[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)&#62;
@@ -68,4 +68,4 @@ const order = await orderModuleService.createOrders({
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The created orders.","expandable":false,"children":[{"name":"OrderDTO","type":"[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)","optional":false,"defaultValue":"","description":"The order details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../types/order.OrderStatus/page.mdx)","description":"The status of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item total of the order.","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":"original_item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item subtotal of the order.","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":"original_item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item tax total of the order.","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":"item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item total of the order.","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":"item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item subtotal of the order.","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":"item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description"Line truncated
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The created orders.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../types/order.OrderStatus/page.mdx)","description":"The status of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item total of the order.","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":"original_item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item subtotal of the order.","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":"original_item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item tax total of the order.","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":"item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item total of the order.","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":"item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item subtotal of the order.","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":"item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item tax total of the order.","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":"","opLine truncated
@@ -36,4 +36,4 @@ const orderReturn = await orderModuleService.createReturn({
## Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[ReturnDTO](../../../interfaces/order.ReturnDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The created order return.","expandable":false,"children":[{"name":"ReturnDTO","type":"[ReturnDTO](../../../interfaces/order.ReturnDTO/page.mdx)","optional":false,"defaultValue":"","description":"The return details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ReturnStatus](../../../types/order.ReturnStatus/page.mdx)","description":"The status of the return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[OrderReturnItemDTO](../../../interfaces/order.OrderReturnItemDTO/page.mdx)[]","description":"The items of the return","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order return item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"The associated line item's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"The quantity of the item to return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reason_id","type":"`null` \\| `string`","description":"The associated reason's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"received_quantity","type":"`number`","description":"The received quantity of the return item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"damaged_quantity","type":"`number`","description":"The damaged quantity of the return item.","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":"created_at","type":"`string` \\| `Date`","description":"The creation date of the return item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the return item.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"display_id","type":"`number`","description":"The return's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refund_amount","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The refund amount of the return.","optional":true,"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":"raw_refund_amount","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The raw refund amount of the return.","optional":true,"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":"order","type":"[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)","description":"The associated order.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"dLine truncated
<TypeList types={[{"name":"Promise","type":"Promise&#60;[ReturnDTO](../../../interfaces/order.ReturnDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The created order return.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ReturnStatus](../../../types/order.ReturnStatus/page.mdx)","description":"The status of the return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[OrderReturnItemDTO](../../../interfaces/order.OrderReturnItemDTO/page.mdx)[]","description":"The items of the return","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order return item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"The associated line item's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"The quantity of the item to return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reason_id","type":"`null` \\| `string`","description":"The associated reason's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"received_quantity","type":"`number`","description":"The received quantity of the return item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"damaged_quantity","type":"`number`","description":"The damaged quantity of the return item.","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":"created_at","type":"`string` \\| `Date`","description":"The creation date of the return item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the return item.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"display_id","type":"`number`","description":"The return's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refund_amount","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The refund amount of the return.","optional":true,"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":"raw_refund_amount","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The raw refund amount of the return.","optional":true,"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":"order","type":"[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)","description":"The associated order.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../typLine truncated
@@ -36,7 +36,7 @@ const returnItem = await orderModuleService.createReturnItems({
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderReturnItemDTO](../../../interfaces/order.OrderReturnItemDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The created return item.","expandable":false,"children":[{"name":"OrderReturnItemDTO","type":"[OrderReturnItemDTO](../../../interfaces/order.OrderReturnItemDTO/page.mdx)","optional":false,"defaultValue":"","description":"The order return item details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order return item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"The associated line item's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"The quantity of the item to return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_quantity","type":"[BigNumberRawValue](../../../types/order.BigNumberRawValue/page.mdx)","description":"The raw quantity of the item to return.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"reason_id","type":"`null` \\| `string`","description":"The associated reason's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"received_quantity","type":"`number`","description":"The received quantity of the return item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_received_quantity","type":"[BigNumberRawValue](../../../types/order.BigNumberRawValue/page.mdx)","description":"The raw received quantity of the return item.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"damaged_quantity","type":"`number`","description":"The damaged quantity of the return item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_damaged_quantity","type":"[BigNumberRawValue](../../../types/order.BigNumberRawValue/page.mdx)","description":"The raw damaged quantity of the return item.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"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":"created_at","type":"`string` \\| `Date`","description":"The creation date of the return item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the return item.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createReturnItems"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderReturnItemDTO](../../../interfaces/order.OrderReturnItemDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The created return item.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order return item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"The associated line item's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"The quantity of the item to return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_quantity","type":"[BigNumberRawValue](../../../types/order.BigNumberRawValue/page.mdx)","description":"The raw quantity of the item to return.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"reason_id","type":"`null` \\| `string`","description":"The associated reason's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"received_quantity","type":"`number`","description":"The received quantity of the return item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_received_quantity","type":"[BigNumberRawValue](../../../types/order.BigNumberRawValue/page.mdx)","description":"The raw received quantity of the return item.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"damaged_quantity","type":"`number`","description":"The damaged quantity of the return item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_damaged_quantity","type":"[BigNumberRawValue](../../../types/order.BigNumberRawValue/page.mdx)","description":"The raw damaged quantity of the return item.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"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":"created_at","type":"`string` \\| `Date`","description":"The creation date of the return item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the return item.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createReturnItems"/>
## createReturnItems(data, sharedContext?): Promise&#60;[OrderReturnItemDTO](../../../interfaces/order.OrderReturnItemDTO/page.mdx)[]&#62;
@@ -58,4 +58,4 @@ const returnItems = await orderModuleService.createReturnItems([{
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderReturnItemDTO](../../../interfaces/order.OrderReturnItemDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The created return items.","expandable":false,"children":[{"name":"OrderReturnItemDTO[]","type":"[OrderReturnItemDTO](../../../interfaces/order.OrderReturnItemDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"OrderReturnItemDTO","type":"`object`","description":"The order return item details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createReturnItems"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderReturnItemDTO](../../../interfaces/order.OrderReturnItemDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The created return items.","expandable":false,"children":[{"name":"OrderReturnItemDTO[]","type":"[OrderReturnItemDTO](../../../interfaces/order.OrderReturnItemDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order return item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"The associated line item's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"The quantity of the item to return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_quantity","type":"[BigNumberRawValue](../../../types/order.BigNumberRawValue/page.mdx)","description":"The raw quantity of the item to return.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"reason_id","type":"`null` \\| `string`","description":"The associated reason's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"received_quantity","type":"`number`","description":"The received quantity of the return item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_received_quantity","type":"[BigNumberRawValue](../../../types/order.BigNumberRawValue/page.mdx)","description":"The raw received quantity of the return item.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"damaged_quantity","type":"`number`","description":"The damaged quantity of the return item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_damaged_quantity","type":"[BigNumberRawValue](../../../types/order.BigNumberRawValue/page.mdx)","description":"The raw damaged quantity of the return item.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"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":"created_at","type":"`string` \\| `Date`","description":"The creation date of the return item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the return item.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createReturnItems"/>
@@ -35,7 +35,7 @@ const returnReason = await orderModuleService.createReturnReasons({
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderReturnReasonDTO](../../../interfaces/order.OrderReturnReasonDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The created return reason.","expandable":false,"children":[{"name":"OrderReturnReasonDTO","type":"[OrderReturnReasonDTO](../../../interfaces/order.OrderReturnReasonDTO/page.mdx)","optional":false,"defaultValue":"","description":"The order return reason details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The unique value of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"The label of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"The metadata of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the return reason was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the return reason was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the return reason","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`string`","description":"The parent return reason ID","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason","type":"[OrderReturnReasonDTO](../../../interfaces/order.OrderReturnReasonDTO/page.mdx)","description":"The associated order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The unique value of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"The label of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"The metadata of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the return reason was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the return reason was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the return reason","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`string`","description":"The parent return reason ID","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason","type":"[OrderReturnReasonDTO](../../../interfaces/order.OrderReturnReasonDTO/page.mdx)","description":"The associated order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_reason_children","type":"[OrderReturnReasonDTO](../../../interfaces/order.OrderReturnReasonDTO/page.mdx)[]","description":"The return reason children of the order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"return_reason_children","type":"[OrderReturnReasonDTO](../../../interfaces/order.OrderReturnReasonDTO/page.mdx)[]","description":"The return reason children of the order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The unique value of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"The label of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"The metadata of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the return reason was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the return reason was updated","optiLine truncated
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderReturnReasonDTO](../../../interfaces/order.OrderReturnReasonDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The created return reason.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The unique value of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"The label of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"The metadata of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the return reason was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the return reason was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the return reason","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`string`","description":"The parent return reason ID","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason","type":"[OrderReturnReasonDTO](../../../interfaces/order.OrderReturnReasonDTO/page.mdx)","description":"The associated order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The unique value of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"The label of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"The metadata of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the return reason was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the return reason was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the return reason","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`string`","description":"The parent return reason ID","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason","type":"[OrderReturnReasonDTO](../../../interfaces/order.OrderReturnReasonDTO/page.mdx)","description":"The associated order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_reason_children","type":"[OrderReturnReasonDTO](../../../interfaces/order.OrderReturnReasonDTO/page.mdx)[]","description":"The return reason children of the order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"return_reason_children","type":"[OrderReturnReasonDTO](../../../interfaces/order.OrderReturnReasonDTO/page.mdx)[]","description":"The return reason children of the order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The unique value of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"The label of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"The metadata of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the return reason was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the return reason was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the return reason","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"pLine truncated
## createReturnReasons(returnReasonData, sharedContext?): Promise&#60;[OrderReturnReasonDTO](../../../interfaces/order.OrderReturnReasonDTO/page.mdx)[]&#62;
@@ -56,4 +56,4 @@ const returnReasons = await orderModuleService.createReturnReasons([{
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderReturnReasonDTO](../../../interfaces/order.OrderReturnReasonDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The created return reason.","expandable":false,"children":[{"name":"OrderReturnReasonDTO[]","type":"[OrderReturnReasonDTO](../../../interfaces/order.OrderReturnReasonDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"OrderReturnReasonDTO","type":"`object`","description":"The order return reason details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createReturnReasons"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderReturnReasonDTO](../../../interfaces/order.OrderReturnReasonDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The created return reason.","expandable":false,"children":[{"name":"OrderReturnReasonDTO[]","type":"[OrderReturnReasonDTO](../../../interfaces/order.OrderReturnReasonDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The unique value of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"The label of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"The metadata of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the return reason was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the return reason was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the return reason","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`string`","description":"The parent return reason ID","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason","type":"[OrderReturnReasonDTO](../../../interfaces/order.OrderReturnReasonDTO/page.mdx)","description":"The associated order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The unique value of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"The label of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"The metadata of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the return reason was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the return reason was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the return reason","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`string`","description":"The parent return reason ID","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason","type":"[OrderReturnReasonDTO](../../../interfaces/order.OrderReturnReasonDTO/page.mdx)","description":"The associated order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_reason_children","type":"[OrderReturnReasonDTO](../../../interfaces/order.OrderReturnReasonDTO/page.mdx)[]","description":"The return reason children of the order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"return_reason_children","type":"[OrderReturnReasonDTO](../../../interfaces/order.OrderReturnReasonDTO/page.mdx)[]","description":"The return reason children of the order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The unique value of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"The label of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"The metadata of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the return reason was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the return reason was updated","optional":false,"defaultValue"Line truncated
@@ -40,7 +40,7 @@ const orderReturn = await orderModuleService.createReturns({
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[ReturnDTO](../../../interfaces/order.ReturnDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The created return.","expandable":false,"children":[{"name":"ReturnDTO","type":"[ReturnDTO](../../../interfaces/order.ReturnDTO/page.mdx)","optional":false,"defaultValue":"","description":"The return details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ReturnStatus](../../../types/order.ReturnStatus/page.mdx)","description":"The status of the return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[OrderReturnItemDTO](../../../interfaces/order.OrderReturnItemDTO/page.mdx)[]","description":"The items of the return","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order return item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"The associated line item's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"The quantity of the item to return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reason_id","type":"`null` \\| `string`","description":"The associated reason's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"received_quantity","type":"`number`","description":"The received quantity of the return item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"damaged_quantity","type":"`number`","description":"The damaged quantity of the return item.","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":"created_at","type":"`string` \\| `Date`","description":"The creation date of the return item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the return item.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"display_id","type":"`number`","description":"The return's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refund_amount","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The refund amount of the return.","optional":true,"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":"raw_refund_amount","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The raw refund amount of the return.","optional":true,"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":"order","type":"[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)","description":"The associated order.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"displayLine truncated
<TypeList types={[{"name":"Promise","type":"Promise&#60;[ReturnDTO](../../../interfaces/order.ReturnDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The created return.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ReturnStatus](../../../types/order.ReturnStatus/page.mdx)","description":"The status of the return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[OrderReturnItemDTO](../../../interfaces/order.OrderReturnItemDTO/page.mdx)[]","description":"The items of the return","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order return item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"The associated line item's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"The quantity of the item to return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reason_id","type":"`null` \\| `string`","description":"The associated reason's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"received_quantity","type":"`number`","description":"The received quantity of the return item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"damaged_quantity","type":"`number`","description":"The damaged quantity of the return item.","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":"created_at","type":"`string` \\| `Date`","description":"The creation date of the return item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the return item.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"display_id","type":"`number`","description":"The return's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refund_amount","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The refund amount of the return.","optional":true,"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":"raw_refund_amount","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The raw refund amount of the return.","optional":true,"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":"order","type":"[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)","description":"The associated order.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../types/ordLine truncated
## createReturns(data, sharedContext?): Promise&#60;[ReturnDTO](../../../interfaces/order.ReturnDTO/page.mdx)[]&#62;
@@ -66,4 +66,4 @@ const returns = await orderModuleService.createReturns([{
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[ReturnDTO](../../../interfaces/order.ReturnDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The created returns.","expandable":false,"children":[{"name":"ReturnDTO[]","type":"[ReturnDTO](../../../interfaces/order.ReturnDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"ReturnDTO","type":"`object`","description":"The return details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createReturns"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[ReturnDTO](../../../interfaces/order.ReturnDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The created returns.","expandable":false,"children":[{"name":"ReturnDTO[]","type":"[ReturnDTO](../../../interfaces/order.ReturnDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ReturnStatus](../../../types/order.ReturnStatus/page.mdx)","description":"The status of the return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[OrderReturnItemDTO](../../../interfaces/order.OrderReturnItemDTO/page.mdx)[]","description":"The items of the return","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order return item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"The associated line item's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"The quantity of the item to return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reason_id","type":"`null` \\| `string`","description":"The associated reason's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"received_quantity","type":"`number`","description":"The received quantity of the return item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"damaged_quantity","type":"`number`","description":"The damaged quantity of the return item.","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":"created_at","type":"`string` \\| `Date`","description":"The creation date of the return item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the return item.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"display_id","type":"`number`","description":"The return's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refund_amount","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The refund amount of the return.","optional":true,"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":"raw_refund_amount","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The raw refund amount of the return.","optional":true,"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":"order","type":"[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)","description":"The associated order.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":Line truncated
@@ -45,4 +45,4 @@ const addresses = await orderModuleService.listOrderAddresses({
## Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderAddressDTO](../../../interfaces/order.OrderAddressDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The list of addresses.","expandable":false,"children":[{"name":"OrderAddressDTO[]","type":"[OrderAddressDTO](../../../interfaces/order.OrderAddressDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"OrderAddressDTO","type":"`object`","description":"The address details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="listOrderAddresses"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderAddressDTO](../../../interfaces/order.OrderAddressDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The list of addresses.","expandable":false,"children":[{"name":"OrderAddressDTO[]","type":"[OrderAddressDTO](../../../interfaces/order.OrderAddressDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the address was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the address was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string`","description":"The customer ID of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The first name of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The last name of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string`","description":"The phone number of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`string`","description":"The company of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`string`","description":"The first address line of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string`","description":"The second address line 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/state 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":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="listOrderAddresses"/>
@@ -56,4 +56,4 @@ const orderChangeActions = await orderModuleService.listOrderChangeActions({
## Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderChangeActionDTO](../../../interfaces/order.OrderChangeActionDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The list of order change actions.","expandable":false,"children":[{"name":"OrderChangeActionDTO[]","type":"[OrderChangeActionDTO](../../../interfaces/order.OrderChangeActionDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"OrderChangeActionDTO","type":"`object`","description":"The order change action details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="listOrderChangeActions"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderChangeActionDTO](../../../interfaces/order.OrderChangeActionDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The list of order change actions.","expandable":false,"children":[{"name":"OrderChangeActionDTO[]","type":"[OrderChangeActionDTO](../../../interfaces/order.OrderChangeActionDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order change action","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_change_id","type":"`null` \\| `string`","description":"The ID of the associated order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_change","type":"`null` \\| [OrderChangeDTO](../../../interfaces/order.OrderChangeDTO/page.mdx)","description":"The associated order change","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the associated order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The ID of the associated return order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The ID of the associated exchange order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The ID of the associated claim order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)","description":"The associated order","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"return_order","type":"[ReturnDTO](../../../interfaces/order.ReturnDTO/page.mdx)","description":"The associated return order","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"exchange","type":"[OrderExchangeDTO](../../../interfaces/order.OrderExchangeDTO/page.mdx)","description":"The associated exchange order","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"claim","type":"[OrderClaimDTO](../../../interfaces/order.OrderClaimDTO/page.mdx)","description":"The associated claim order","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"actions","type":"[OrderChangeActionDTO](../../../interfaces/order.OrderChangeActionDTO/page.mdx)[]","description":"The actions of the order change","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"status","type":"[OrderChangeStatus](../../../types/order.OrderChangeStatus/page.mdx)","description":"The status of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_by","type":"`null` \\| `string`","description":"The requested by of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_at","type":"`null` \\| `string` \\| `Date`","description":"When the order change was requested","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_by","type":"`null` \\| `string`","description":"The confirmed by of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_at","type":"`null` \\| `string` \\| `Date`","description":"When the order change was confirmed","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_by","type":"`null` \\| `string`","description":"The declined by of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_reason","type":"`null` \\| `string`","description":"The declined reason of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"The metadata of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_at","type":"`null` \\| `string` \\| `Date`","description":"When the order change was declined","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_by","type":"`null` \\| `string`","description":"The canceled by of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`null` \\| `string` \\| `Date`","description":"When the order change was canceled","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","tLine truncated
@@ -56,4 +56,4 @@ const orderChanges = await orderModuleService.listOrderChanges({
## Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderChangeDTO](../../../interfaces/order.OrderChangeDTO/page.mdx)[]&#62;","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":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="listOrderChanges"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderChangeDTO](../../../interfaces/order.OrderChangeDTO/page.mdx)[]&#62;","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":"id","type":"`string`","description":"The ID of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the associated order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The ID of the associated return order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The ID of the associated exchange order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The ID of the associated claim order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)","description":"The associated order","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../types/order.OrderStatus/page.mdx)","description":"The status of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The subtotal of the order. (Excluding taxes)","optional":falseLine truncated
@@ -56,4 +56,4 @@ const claims = await orderModuleService.listOrderClaims({
## Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderClaimDTO](../../../interfaces/order.OrderClaimDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The list of order claims.","expandable":false,"children":[{"name":"OrderClaimDTO[]","type":"[OrderClaimDTO](../../../interfaces/order.OrderClaimDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"OrderClaimDTO","type":"`object`","description":"The claim details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="listOrderClaims"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderClaimDTO](../../../interfaces/order.OrderClaimDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The list of order claims.","expandable":false,"children":[{"name":"OrderClaimDTO[]","type":"[OrderClaimDTO](../../../interfaces/order.OrderClaimDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The claim's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[OrderClaimType](../../../types/order.OrderClaimType/page.mdx)","description":"The claim's type.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the associated order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_version","type":"`number`","description":"The version of the order when the claim is applied.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The claim's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_items","type":"`any`[]","description":"The items to be received from the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"additional_items","type":"`any`[]","description":"The items to be sent to the customer\nif the claim's type is `replace`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)","description":"The associated order.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../types/order.OrderStatus/page.mdx)","description":"The status of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order.","optional":faLine truncated
@@ -56,4 +56,4 @@ const exchanges = await orderModuleService.listOrderExchanges({
## Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderExchangeDTO](../../../interfaces/order.OrderExchangeDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The list of exchanges.","expandable":false,"children":[{"name":"OrderExchangeDTO[]","type":"[OrderExchangeDTO](../../../interfaces/order.OrderExchangeDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"OrderExchangeDTO","type":"`object`","description":"The exchange details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="listOrderExchanges"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderExchangeDTO](../../../interfaces/order.OrderExchangeDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The list of exchanges.","expandable":false,"children":[{"name":"OrderExchangeDTO[]","type":"[OrderExchangeDTO](../../../interfaces/order.OrderExchangeDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The exchange's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_version","type":"`number`","description":"The version of the order when the exchange is applied.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The exchange's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"additional_items","type":"`any`[]","description":"The items to be sent to the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)","description":"The associated order.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../types/order.OrderStatus/page.mdx)","description":"The status of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The subtotal of tLine truncated
@@ -56,4 +56,4 @@ const lineItemAdjustment = await orderModuleService.listOrderLineItemAdjustments
## Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderLineItemAdjustmentDTO](../../../interfaces/order.OrderLineItemAdjustmentDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The list of line item adjustments.","expandable":false,"children":[{"name":"OrderLineItemAdjustmentDTO[]","type":"[OrderLineItemAdjustmentDTO](../../../interfaces/order.OrderLineItemAdjustmentDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"OrderLineItemAdjustmentDTO","type":"`object`","description":"The line item adjustment details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="listOrderLineItemAdjustments"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderLineItemAdjustmentDTO](../../../interfaces/order.OrderLineItemAdjustmentDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The list of line item adjustments.","expandable":false,"children":[{"name":"OrderLineItemAdjustmentDTO[]","type":"[OrderLineItemAdjustmentDTO](../../../interfaces/order.OrderLineItemAdjustmentDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the adjustment line","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The amount of the adjustment line","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":"order_id","type":"`string`","description":"The ID of the associated order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the adjustment line was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the adjustment line was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"[OrderLineItemDTO](../../../interfaces/order.OrderLineItemDTO/page.mdx)","description":"The associated line item.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The discount total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The discount tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The refundable total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_total_per_unit","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The refundable total per unit of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The ID of the line item.","optional":false,"defaultValLine truncated
@@ -59,4 +59,4 @@ const lineItemTaxLines = await orderModuleService
## Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderLineItemTaxLineDTO](../../../interfaces/order.OrderLineItemTaxLineDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The list of line item taxes.","expandable":false,"children":[{"name":"OrderLineItemTaxLineDTO[]","type":"[OrderLineItemTaxLineDTO](../../../interfaces/order.OrderLineItemTaxLineDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"OrderLineItemTaxLineDTO","type":"`object`","description":"The line item tax line details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="listOrderLineItemTaxLines"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderLineItemTaxLineDTO](../../../interfaces/order.OrderLineItemTaxLineDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The list of line item taxes.","expandable":false,"children":[{"name":"OrderLineItemTaxLineDTO[]","type":"[OrderLineItemTaxLineDTO](../../../interfaces/order.OrderLineItemTaxLineDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"The code of the tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`number`","description":"The rate of the tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the tax line was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the tax line was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"[OrderLineItemDTO](../../../interfaces/order.OrderLineItemDTO/page.mdx)","description":"The associated line item.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The discount total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The discount tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The refundable total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_total_per_unit","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The refundable total per unit of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The ID of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`boolean`","description":"Indicates whether the line item requires shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_discountable","type":"`boolean`","description":"Indicates whether the line item is discountable.","optional":false,"defaultValue":"","expandable":false,"Line truncated
@@ -56,4 +56,4 @@ const lineItems = await orderModuleService.listOrderLineItems({
## Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderLineItemDTO](../../../interfaces/order.OrderLineItemDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The list of line items.","expandable":false,"children":[{"name":"OrderLineItemDTO[]","type":"[OrderLineItemDTO](../../../interfaces/order.OrderLineItemDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"OrderLineItemDTO","type":"`object`","description":"The line item details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="listOrderLineItems"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderLineItemDTO](../../../interfaces/order.OrderLineItemDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The list of line items.","expandable":false,"children":[{"name":"OrderLineItemDTO[]","type":"[OrderLineItemDTO](../../../interfaces/order.OrderLineItemDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order line item.","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":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order line item.","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":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order line item.","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":"item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item total of the order line item.","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":"item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item subtotal of the order line item.","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":"item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item tax total of the order line item.","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":"total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The total of the order line item.","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":"subtotal","type":"[BigNuLine truncated
@@ -59,4 +59,4 @@ const shippingMethodAdjustments = await orderModuleService
## Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderShippingMethodAdjustmentDTO](../../../interfaces/order.OrderShippingMethodAdjustmentDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The list of shipping method adjustments.","expandable":false,"children":[{"name":"OrderShippingMethodAdjustmentDTO[]","type":"[OrderShippingMethodAdjustmentDTO](../../../interfaces/order.OrderShippingMethodAdjustmentDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"OrderShippingMethodAdjustmentDTO","type":"`object`","description":"The shipping method adjustment details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="listOrderShippingMethodAdjustments"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderShippingMethodAdjustmentDTO](../../../interfaces/order.OrderShippingMethodAdjustmentDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The list of shipping method adjustments.","expandable":false,"children":[{"name":"OrderShippingMethodAdjustmentDTO[]","type":"[OrderShippingMethodAdjustmentDTO](../../../interfaces/order.OrderShippingMethodAdjustmentDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the adjustment line","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The amount of the adjustment line","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":"order_id","type":"`string`","description":"The ID of the associated order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the adjustment line was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the adjustment line was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_method","type":"[OrderShippingMethodDTO](../../../interfaces/order.OrderShippingMethodDTO/page.mdx)","description":"The associated shipping method.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the associated order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The price of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`boolean`","description":"Whether the shipping method price is tax inclusive or not.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the shipping method was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the shipping method was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The subtotal of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The tax total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The discount total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The discount tax total of the order shipping method.","Line truncated
@@ -59,4 +59,4 @@ const shippingMethodTaxLines = await orderModuleService
## Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderShippingMethodTaxLineDTO](../../../interfaces/order.OrderShippingMethodTaxLineDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The list of shipping method tax lines.","expandable":false,"children":[{"name":"OrderShippingMethodTaxLineDTO[]","type":"[OrderShippingMethodTaxLineDTO](../../../interfaces/order.OrderShippingMethodTaxLineDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"OrderShippingMethodTaxLineDTO","type":"`object`","description":"The shipping method tax line details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="listOrderShippingMethodTaxLines"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderShippingMethodTaxLineDTO](../../../interfaces/order.OrderShippingMethodTaxLineDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The list of shipping method tax lines.","expandable":false,"children":[{"name":"OrderShippingMethodTaxLineDTO[]","type":"[OrderShippingMethodTaxLineDTO](../../../interfaces/order.OrderShippingMethodTaxLineDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"The code of the tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`number`","description":"The rate of the tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the tax line was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the tax line was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_method","type":"[OrderShippingMethodDTO](../../../interfaces/order.OrderShippingMethodDTO/page.mdx)","description":"The associated shipping method.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the associated order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The price of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`boolean`","description":"Whether the shipping method price is tax inclusive or not.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the shipping method was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the shipping method was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The subtotal of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The tax total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The discount total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The discount tax total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the shipping method.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_id","type":"`string`","description":"The ID of the shipping option the method was created from.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record<string, unknown>`","description":"Additional data needed for fulfillment.","optLine truncated
@@ -56,4 +56,4 @@ const shippingMethods = await orderModuleService.listOrderShippingMethods({
## Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderShippingMethodDTO](../../../interfaces/order.OrderShippingMethodDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The list of shipping methods.","expandable":false,"children":[{"name":"OrderShippingMethodDTO[]","type":"[OrderShippingMethodDTO](../../../interfaces/order.OrderShippingMethodDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"OrderShippingMethodDTO","type":"`object`","description":"The order shipping method details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="listOrderShippingMethods"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderShippingMethodDTO](../../../interfaces/order.OrderShippingMethodDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The list of shipping methods.","expandable":false,"children":[{"name":"OrderShippingMethodDTO[]","type":"[OrderShippingMethodDTO](../../../interfaces/order.OrderShippingMethodDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the associated order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The price of the shipping method.","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":"raw_amount","type":"[BigNumberRawValue](../../../types/order.BigNumberRawValue/page.mdx)","description":"The raw price of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"is_tax_inclusive","type":"`boolean`","description":"Whether the shipping method price is tax inclusive or not.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the shipping method was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the shipping method was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order shipping method.","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":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order shipping method.","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":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order shipping method.","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":"total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The total of the order shipping method.","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":"","optioLine truncated
@@ -56,4 +56,4 @@ const transactions = await orderModuleService.listOrderTransactions({
## Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderTransactionDTO](../../../interfaces/order.OrderTransactionDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The list of transactions.","expandable":false,"children":[{"name":"OrderTransactionDTO[]","type":"[OrderTransactionDTO](../../../interfaces/order.OrderTransactionDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"OrderTransactionDTO","type":"`object`","description":"The order transaction details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="listOrderTransactions"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderTransactionDTO](../../../interfaces/order.OrderTransactionDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The list of transactions.","expandable":false,"children":[{"name":"OrderTransactionDTO[]","type":"[OrderTransactionDTO](../../../interfaces/order.OrderTransactionDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the transaction","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the associated order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The associated order version","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)","description":"The associated order","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../types/order.OrderStatus/page.mdx)","description":"The status of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The subtotal of the order. (Excluding taxes)","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The discount subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"Line truncated
@@ -56,4 +56,4 @@ const orders = await orderModuleService.listOrders({
## Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The list of orders.","expandable":false,"children":[{"name":"OrderDTO[]","type":"[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"OrderDTO","type":"`object`","description":"The order details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="listOrders"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The list of orders.","expandable":false,"children":[{"name":"OrderDTO[]","type":"[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../types/order.OrderStatus/page.mdx)","description":"The status of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item total of the order.","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":"original_item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item subtotal of the order.","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":"original_item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item tax total of the order.","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":"item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item total of the order.","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":"item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item subtotal of the order.","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":"item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optionaLine truncated
@@ -56,4 +56,4 @@ const returnReasons = await orderModuleService.listReturnReasons({
## Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderReturnReasonDTO](../../../interfaces/order.OrderReturnReasonDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The list of return reasons.","expandable":false,"children":[{"name":"OrderReturnReasonDTO[]","type":"[OrderReturnReasonDTO](../../../interfaces/order.OrderReturnReasonDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"OrderReturnReasonDTO","type":"`object`","description":"The order return reason details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="listReturnReasons"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderReturnReasonDTO](../../../interfaces/order.OrderReturnReasonDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The list of return reasons.","expandable":false,"children":[{"name":"OrderReturnReasonDTO[]","type":"[OrderReturnReasonDTO](../../../interfaces/order.OrderReturnReasonDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The unique value of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"The label of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"The metadata of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the return reason was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the return reason was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the return reason","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`string`","description":"The parent return reason ID","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason","type":"[OrderReturnReasonDTO](../../../interfaces/order.OrderReturnReasonDTO/page.mdx)","description":"The associated order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The unique value of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"The label of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"The metadata of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the return reason was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the return reason was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the return reason","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`string`","description":"The parent return reason ID","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason","type":"[OrderReturnReasonDTO](../../../interfaces/order.OrderReturnReasonDTO/page.mdx)","description":"The associated order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_reason_children","type":"[OrderReturnReasonDTO](../../../interfaces/order.OrderReturnReasonDTO/page.mdx)[]","description":"The return reason children of the order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"return_reason_children","type":"[OrderReturnReasonDTO](../../../interfaces/order.OrderReturnReasonDTO/page.mdx)[]","description":"The return reason children of the order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The unique value of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"The label of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"The metadata of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the return reason was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the return reason was updated","optional":false,"defaultValueLine truncated
@@ -56,4 +56,4 @@ const returns = await orderModuleService.listReturns({
## Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[ReturnDTO](../../../interfaces/order.ReturnDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The list of returns.","expandable":false,"children":[{"name":"ReturnDTO[]","type":"[ReturnDTO](../../../interfaces/order.ReturnDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"ReturnDTO","type":"`object`","description":"The return details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="listReturns"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[ReturnDTO](../../../interfaces/order.ReturnDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The list of returns.","expandable":false,"children":[{"name":"ReturnDTO[]","type":"[ReturnDTO](../../../interfaces/order.ReturnDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ReturnStatus](../../../types/order.ReturnStatus/page.mdx)","description":"The status of the return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[OrderReturnItemDTO](../../../interfaces/order.OrderReturnItemDTO/page.mdx)[]","description":"The items of the return","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order return item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"The associated line item's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"The quantity of the item to return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reason_id","type":"`null` \\| `string`","description":"The associated reason's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"received_quantity","type":"`number`","description":"The received quantity of the return item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"damaged_quantity","type":"`number`","description":"The damaged quantity of the return item.","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":"created_at","type":"`string` \\| `Date`","description":"The creation date of the return item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the return item.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"display_id","type":"`number`","description":"The return's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refund_amount","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The refund amount of the return.","optional":true,"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":"raw_refund_amount","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The raw refund amount of the return.","optional":true,"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":"order","type":"[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)","description":"The associated order.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":Line truncated
@@ -32,4 +32,4 @@ const orderPreview = await orderModuleService.previewOrderChange(
## Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderPreviewDTO](../../../interfaces/order.OrderPreviewDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The preview of the order.","expandable":false,"children":[{"name":"OrderPreviewDTO","type":"[OrderPreviewDTO](../../../interfaces/order.OrderPreviewDTO/page.mdx)","optional":false,"defaultValue":"","description":"The details of an order after a change is applied on it.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../types/order.OrderStatus/page.mdx)","description":"The status of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item total of the order.","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":"original_item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item subtotal of the order.","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":"original_item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item tax total of the order.","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":"item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item total of the order.","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":"item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item subtotal of the order.","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":"item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item tax total of the order.","optional":false,"defaultValue":"","Line truncated
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderPreviewDTO](../../../interfaces/order.OrderPreviewDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The preview of the order.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../types/order.OrderStatus/page.mdx)","description":"The status of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item total of the order.","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":"original_item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item subtotal of the order.","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":"original_item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item tax total of the order.","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":"item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item total of the order.","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":"item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item subtotal of the order.","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":"item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item tax total of the order.","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)",Line truncated
@@ -38,4 +38,4 @@ const orderReturn = await orderModuleService.receiveReturn({
## Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[ReturnDTO](../../../interfaces/order.ReturnDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The received return.","expandable":false,"children":[{"name":"ReturnDTO","type":"[ReturnDTO](../../../interfaces/order.ReturnDTO/page.mdx)","optional":false,"defaultValue":"","description":"The return details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ReturnStatus](../../../types/order.ReturnStatus/page.mdx)","description":"The status of the return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[OrderReturnItemDTO](../../../interfaces/order.OrderReturnItemDTO/page.mdx)[]","description":"The items of the return","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order return item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"The associated line item's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"The quantity of the item to return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reason_id","type":"`null` \\| `string`","description":"The associated reason's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"received_quantity","type":"`number`","description":"The received quantity of the return item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"damaged_quantity","type":"`number`","description":"The damaged quantity of the return item.","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":"created_at","type":"`string` \\| `Date`","description":"The creation date of the return item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the return item.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"display_id","type":"`number`","description":"The return's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refund_amount","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The refund amount of the return.","optional":true,"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":"raw_refund_amount","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The raw refund amount of the return.","optional":true,"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":"order","type":"[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)","description":"The associated order.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"displaLine truncated
<TypeList types={[{"name":"Promise","type":"Promise&#60;[ReturnDTO](../../../interfaces/order.ReturnDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The received return.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ReturnStatus](../../../types/order.ReturnStatus/page.mdx)","description":"The status of the return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[OrderReturnItemDTO](../../../interfaces/order.OrderReturnItemDTO/page.mdx)[]","description":"The items of the return","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order return item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"The associated line item's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"The quantity of the item to return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reason_id","type":"`null` \\| `string`","description":"The associated reason's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"received_quantity","type":"`number`","description":"The received quantity of the return item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"damaged_quantity","type":"`number`","description":"The damaged quantity of the return item.","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":"created_at","type":"`string` \\| `Date`","description":"The creation date of the return item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the return item.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"display_id","type":"`number`","description":"The return's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refund_amount","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The refund amount of the return.","optional":true,"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":"raw_refund_amount","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The raw refund amount of the return.","optional":true,"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":"order","type":"[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)","description":"The associated order.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../types/orLine truncated
@@ -35,7 +35,7 @@ await orderModuleService.registerOrderChange({
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderChangeDTO](../../../interfaces/order.OrderChangeDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The item and shipping method changes made on the order.","expandable":false,"children":[{"name":"OrderChangeDTO","type":"[OrderChangeDTO](../../../interfaces/order.OrderChangeDTO/page.mdx)","optional":false,"defaultValue":"","description":"The order change details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the associated order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The ID of the associated return order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The ID of the associated exchange order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The ID of the associated claim order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)","description":"The associated order","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../types/order.OrderStatus/page.mdx)","description":"The status of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The subtotal oLine truncated
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderChangeDTO](../../../interfaces/order.OrderChangeDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The item and shipping method changes made on the order.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the associated order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The ID of the associated return order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The ID of the associated exchange order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The ID of the associated claim order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)","description":"The associated order","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../types/order.OrderStatus/page.mdx)","description":"The status of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The subtotal of the order. (Excluding taxes)","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"ThLine truncated
## registerOrderChange(data, sharedContext?): Promise&#60;[OrderChangeDTO](../../../interfaces/order.OrderChangeDTO/page.mdx)[]&#62;
@@ -56,4 +56,4 @@ await orderModuleService.registerOrderChange({
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderChangeDTO](../../../interfaces/order.OrderChangeDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The item and shipping method changes made on the orders.","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":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="registerOrderChange"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderChangeDTO](../../../interfaces/order.OrderChangeDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The item and shipping method changes made on the orders.","expandable":false,"children":[{"name":"OrderChangeDTO[]","type":"[OrderChangeDTO](../../../interfaces/order.OrderChangeDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the associated order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The ID of the associated return order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The ID of the associated exchange order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The ID of the associated claim order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)","description":"The associated order","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../types/order.OrderStatus/page.mdx)","description":"The status of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The subtotal of the order. (ExclLine truncated
@@ -45,4 +45,4 @@ const order = await orderModuleService.retrieveOrder(
## Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The retrieved order.","expandable":false,"children":[{"name":"OrderDTO","type":"[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)","optional":false,"defaultValue":"","description":"The order details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../types/order.OrderStatus/page.mdx)","description":"The status of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item total of the order.","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":"original_item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item subtotal of the order.","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":"original_item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item tax total of the order.","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":"item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item total of the order.","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":"item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item subtotal of the order.","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":"item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","descriptionLine truncated
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The retrieved order.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../types/order.OrderStatus/page.mdx)","description":"The status of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item total of the order.","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":"original_item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item subtotal of the order.","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":"original_item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item tax total of the order.","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":"item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item total of the order.","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":"item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item subtotal of the order.","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":"item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item tax total of the order.","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":"","oLine truncated
@@ -45,4 +45,4 @@ const orderChange = await orderModuleService.retrieveOrderChange(
## Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderChangeDTO](../../../interfaces/order.OrderChangeDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The retrieved order change.","expandable":false,"children":[{"name":"OrderChangeDTO","type":"[OrderChangeDTO](../../../interfaces/order.OrderChangeDTO/page.mdx)","optional":false,"defaultValue":"","description":"The order change details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the associated order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The ID of the associated return order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The ID of the associated exchange order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The ID of the associated claim order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)","description":"The associated order","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../types/order.OrderStatus/page.mdx)","description":"The status of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The subtotal of the order. (Excluding taxeLine truncated
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderChangeDTO](../../../interfaces/order.OrderChangeDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The retrieved order change.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the associated order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The ID of the associated return order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The ID of the associated exchange order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The ID of the associated claim order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)","description":"The associated order","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../types/order.OrderStatus/page.mdx)","description":"The status of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The subtotal of the order. (Excluding taxes)","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The tax total of the order.","Line truncated
@@ -45,4 +45,4 @@ const orderChangeAction = await orderModuleService.retrieveOrderChangeAction(
## Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderChangeActionDTO](../../../interfaces/order.OrderChangeActionDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The retrieved order change action.","expandable":false,"children":[{"name":"OrderChangeActionDTO","type":"[OrderChangeActionDTO](../../../interfaces/order.OrderChangeActionDTO/page.mdx)","optional":false,"defaultValue":"","description":"The order change action details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order change action","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_change_id","type":"`null` \\| `string`","description":"The ID of the associated order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_change","type":"`null` \\| [OrderChangeDTO](../../../interfaces/order.OrderChangeDTO/page.mdx)","description":"The associated order change","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the associated order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The ID of the associated return order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The ID of the associated exchange order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The ID of the associated claim order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)","description":"The associated order","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"return_order","type":"[ReturnDTO](../../../interfaces/order.ReturnDTO/page.mdx)","description":"The associated return order","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"exchange","type":"[OrderExchangeDTO](../../../interfaces/order.OrderExchangeDTO/page.mdx)","description":"The associated exchange order","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"claim","type":"[OrderClaimDTO](../../../interfaces/order.OrderClaimDTO/page.mdx)","description":"The associated claim order","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"actions","type":"[OrderChangeActionDTO](../../../interfaces/order.OrderChangeActionDTO/page.mdx)[]","description":"The actions of the order change","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"status","type":"[OrderChangeStatus](../../../types/order.OrderChangeStatus/page.mdx)","description":"The status of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_by","type":"`null` \\| `string`","description":"The requested by of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_at","type":"`null` \\| `string` \\| `Date`","description":"When the order change was requested","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_by","type":"`null` \\| `string`","description":"The confirmed by of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_at","type":"`null` \\| `string` \\| `Date`","description":"When the order change was confirmed","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_by","type":"`null` \\| `string`","description":"The declined by of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_reason","type":"`null` \\| `string`","description":"The declined reason of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"The metadata of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_at","type":"`null` \\| `string` \\| `Date`","description":"When the order change was declined","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_by","type":"`null` \\| `string`","description":"The canceled by of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`null` \\| `string` \\| `Date`","description":"When the order change was canceled","optional":false,"defaultValue":"","expandable":false,"children":Line truncated
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderChangeActionDTO](../../../interfaces/order.OrderChangeActionDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The retrieved order change action.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order change action","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_change_id","type":"`null` \\| `string`","description":"The ID of the associated order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_change","type":"`null` \\| [OrderChangeDTO](../../../interfaces/order.OrderChangeDTO/page.mdx)","description":"The associated order change","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the associated order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The ID of the associated return order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The ID of the associated exchange order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The ID of the associated claim order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)","description":"The associated order","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"return_order","type":"[ReturnDTO](../../../interfaces/order.ReturnDTO/page.mdx)","description":"The associated return order","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"exchange","type":"[OrderExchangeDTO](../../../interfaces/order.OrderExchangeDTO/page.mdx)","description":"The associated exchange order","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"claim","type":"[OrderClaimDTO](../../../interfaces/order.OrderClaimDTO/page.mdx)","description":"The associated claim order","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"actions","type":"[OrderChangeActionDTO](../../../interfaces/order.OrderChangeActionDTO/page.mdx)[]","description":"The actions of the order change","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"status","type":"[OrderChangeStatus](../../../types/order.OrderChangeStatus/page.mdx)","description":"The status of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_by","type":"`null` \\| `string`","description":"The requested by of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_at","type":"`null` \\| `string` \\| `Date`","description":"When the order change was requested","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_by","type":"`null` \\| `string`","description":"The confirmed by of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_at","type":"`null` \\| `string` \\| `Date`","description":"When the order change was confirmed","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_by","type":"`null` \\| `string`","description":"The declined by of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_reason","type":"`null` \\| `string`","description":"The declined reason of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"The metadata of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_at","type":"`null` \\| `string` \\| `Date`","description":"When the order change was declined","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_by","type":"`null` \\| `string`","description":"The canceled by of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`null` \\| `string` \\| `Date`","description":"When the order change was canceled","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the order change was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","descriptionLine truncated
@@ -45,4 +45,4 @@ const claim = await orderModuleService.retrieveOrderClaim(
## Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderClaimDTO](../../../interfaces/order.OrderClaimDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The retrieved order claim.","expandable":false,"children":[{"name":"OrderClaimDTO","type":"[OrderClaimDTO](../../../interfaces/order.OrderClaimDTO/page.mdx)","optional":false,"defaultValue":"","description":"The claim details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The claim's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[OrderClaimType](../../../types/order.OrderClaimType/page.mdx)","description":"The claim's type.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the associated order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_version","type":"`number`","description":"The version of the order when the claim is applied.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The claim's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_items","type":"`any`[]","description":"The items to be received from the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"additional_items","type":"`any`[]","description":"The items to be sent to the customer\nif the claim's type is `replace`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)","description":"The associated order.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../types/order.OrderStatus/page.mdx)","description":"The status of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order.",Line truncated
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderClaimDTO](../../../interfaces/order.OrderClaimDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The retrieved order claim.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The claim's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[OrderClaimType](../../../types/order.OrderClaimType/page.mdx)","description":"The claim's type.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the associated order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_version","type":"`number`","description":"The version of the order when the claim is applied.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The claim's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_items","type":"`any`[]","description":"The items to be received from the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"additional_items","type":"`any`[]","description":"The items to be sent to the customer\nif the claim's type is `replace`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)","description":"The associated order.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../types/order.OrderStatus/page.mdx)","description":"The status of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The total of the order.","opLine truncated
@@ -45,4 +45,4 @@ const exchange = await orderModuleService.retrieveOrderExchange(
## Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderExchangeDTO](../../../interfaces/order.OrderExchangeDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The retrieved order exchange.","expandable":false,"children":[{"name":"OrderExchangeDTO","type":"[OrderExchangeDTO](../../../interfaces/order.OrderExchangeDTO/page.mdx)","optional":false,"defaultValue":"","description":"The exchange details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The exchange's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_version","type":"`number`","description":"The version of the order when the exchange is applied.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The exchange's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"additional_items","type":"`any`[]","description":"The items to be sent to the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)","description":"The associated order.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../types/order.OrderStatus/page.mdx)","description":"The status of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","descriptiLine truncated
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderExchangeDTO](../../../interfaces/order.OrderExchangeDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The retrieved order exchange.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The exchange's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_version","type":"`number`","description":"The version of the order when the exchange is applied.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The exchange's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"additional_items","type":"`any`[]","description":"The items to be sent to the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)","description":"The associated order.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../types/order.OrderStatus/page.mdx)","description":"The status of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The subtotal of the order. (Excluding taxes)","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)",Line truncated
@@ -43,4 +43,4 @@ const lineItem = await orderModuleService.retrieveOrderLineItem(
## Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderLineItemDTO](../../../interfaces/order.OrderLineItemDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The retrieved line item.","expandable":false,"children":[{"name":"OrderLineItemDTO","type":"[OrderLineItemDTO](../../../interfaces/order.OrderLineItemDTO/page.mdx)","optional":false,"defaultValue":"","description":"The line item details.","expandable":false,"children":[{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order line item.","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":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order line item.","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":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order line item.","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":"item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item total of the order line item.","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":"item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item subtotal of the order line item.","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":"item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item tax total of the order line item.","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":"total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The total of the order line item.","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":"subtotaLine truncated
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderLineItemDTO](../../../interfaces/order.OrderLineItemDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The retrieved line item.","expandable":false,"children":[{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order line item.","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":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order line item.","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":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order line item.","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":"item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item total of the order line item.","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":"item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item subtotal of the order line item.","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":"item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item tax total of the order line item.","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":"total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The total of the order line item.","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":"subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","Line truncated
@@ -45,4 +45,4 @@ const orderReturn = await orderModuleService.retrieveReturn(
## Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[ReturnDTO](../../../interfaces/order.ReturnDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The retrieved return.","expandable":false,"children":[{"name":"ReturnDTO","type":"[ReturnDTO](../../../interfaces/order.ReturnDTO/page.mdx)","optional":false,"defaultValue":"","description":"The return details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ReturnStatus](../../../types/order.ReturnStatus/page.mdx)","description":"The status of the return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[OrderReturnItemDTO](../../../interfaces/order.OrderReturnItemDTO/page.mdx)[]","description":"The items of the return","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order return item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"The associated line item's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"The quantity of the item to return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reason_id","type":"`null` \\| `string`","description":"The associated reason's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"received_quantity","type":"`number`","description":"The received quantity of the return item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"damaged_quantity","type":"`number`","description":"The damaged quantity of the return item.","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":"created_at","type":"`string` \\| `Date`","description":"The creation date of the return item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the return item.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"display_id","type":"`number`","description":"The return's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refund_amount","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The refund amount of the return.","optional":true,"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":"raw_refund_amount","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The raw refund amount of the return.","optional":true,"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":"order","type":"[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)","description":"The associated order.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"displLine truncated
<TypeList types={[{"name":"Promise","type":"Promise&#60;[ReturnDTO](../../../interfaces/order.ReturnDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The retrieved return.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ReturnStatus](../../../types/order.ReturnStatus/page.mdx)","description":"The status of the return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[OrderReturnItemDTO](../../../interfaces/order.OrderReturnItemDTO/page.mdx)[]","description":"The items of the return","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order return item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"The associated line item's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"The quantity of the item to return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reason_id","type":"`null` \\| `string`","description":"The associated reason's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"received_quantity","type":"`number`","description":"The received quantity of the return item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"damaged_quantity","type":"`number`","description":"The damaged quantity of the return item.","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":"created_at","type":"`string` \\| `Date`","description":"The creation date of the return item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the return item.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"display_id","type":"`number`","description":"The return's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refund_amount","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The refund amount of the return.","optional":true,"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":"raw_refund_amount","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The raw refund amount of the return.","optional":true,"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":"order","type":"[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)","description":"The associated order.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../types/oLine truncated
@@ -45,4 +45,4 @@ const returnReason = await orderModuleService.retrieveReturnReason(
## Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderReturnReasonDTO](../../../interfaces/order.OrderReturnReasonDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The retrieved return reason.","expandable":false,"children":[{"name":"OrderReturnReasonDTO","type":"[OrderReturnReasonDTO](../../../interfaces/order.OrderReturnReasonDTO/page.mdx)","optional":false,"defaultValue":"","description":"The order return reason details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The unique value of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"The label of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"The metadata of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the return reason was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the return reason was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the return reason","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`string`","description":"The parent return reason ID","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason","type":"[OrderReturnReasonDTO](../../../interfaces/order.OrderReturnReasonDTO/page.mdx)","description":"The associated order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The unique value of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"The label of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"The metadata of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the return reason was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the return reason was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the return reason","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`string`","description":"The parent return reason ID","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason","type":"[OrderReturnReasonDTO](../../../interfaces/order.OrderReturnReasonDTO/page.mdx)","description":"The associated order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_reason_children","type":"[OrderReturnReasonDTO](../../../interfaces/order.OrderReturnReasonDTO/page.mdx)[]","description":"The return reason children of the order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"return_reason_children","type":"[OrderReturnReasonDTO](../../../interfaces/order.OrderReturnReasonDTO/page.mdx)[]","description":"The return reason children of the order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The unique value of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"The label of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"The metadata of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the return reason was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the return reason was updated","opLine truncated
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderReturnReasonDTO](../../../interfaces/order.OrderReturnReasonDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The retrieved return reason.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The unique value of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"The label of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"The metadata of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the return reason was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the return reason was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the return reason","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`string`","description":"The parent return reason ID","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason","type":"[OrderReturnReasonDTO](../../../interfaces/order.OrderReturnReasonDTO/page.mdx)","description":"The associated order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The unique value of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"The label of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"The metadata of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the return reason was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the return reason was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the return reason","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`string`","description":"The parent return reason ID","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason","type":"[OrderReturnReasonDTO](../../../interfaces/order.OrderReturnReasonDTO/page.mdx)","description":"The associated order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_reason_children","type":"[OrderReturnReasonDTO](../../../interfaces/order.OrderReturnReasonDTO/page.mdx)[]","description":"The return reason children of the order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"return_reason_children","type":"[OrderReturnReasonDTO](../../../interfaces/order.OrderReturnReasonDTO/page.mdx)[]","description":"The return reason children of the order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The unique value of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"The label of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"The metadata of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the return reason was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the return reason was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the return reason","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":Line truncated
@@ -43,4 +43,4 @@ const lineItemAdjustments = await orderModuleService.setOrderLineItemAdjustments
## Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderLineItemAdjustmentDTO](../../../interfaces/order.OrderLineItemAdjustmentDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The order's line item adjustments.","expandable":false,"children":[{"name":"OrderLineItemAdjustmentDTO[]","type":"[OrderLineItemAdjustmentDTO](../../../interfaces/order.OrderLineItemAdjustmentDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"OrderLineItemAdjustmentDTO","type":"`object`","description":"The line item adjustment details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="setOrderLineItemAdjustments"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderLineItemAdjustmentDTO](../../../interfaces/order.OrderLineItemAdjustmentDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The order's line item adjustments.","expandable":false,"children":[{"name":"OrderLineItemAdjustmentDTO[]","type":"[OrderLineItemAdjustmentDTO](../../../interfaces/order.OrderLineItemAdjustmentDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the adjustment line","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The amount of the adjustment line","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":"order_id","type":"`string`","description":"The ID of the associated order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the adjustment line was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the adjustment line was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"[OrderLineItemDTO](../../../interfaces/order.OrderLineItemDTO/page.mdx)","description":"The associated line item.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The discount total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The discount tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The refundable total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_total_per_unit","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The refundable total per unit of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The ID of the line item.","optional":false,"defaultValLine truncated
@@ -39,4 +39,4 @@ const lineItemTaxLines = await orderModuleService
## Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderLineItemTaxLineDTO](../../../interfaces/order.OrderLineItemTaxLineDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The order's line item tax lines.","expandable":false,"children":[{"name":"OrderLineItemTaxLineDTO[]","type":"[OrderLineItemTaxLineDTO](../../../interfaces/order.OrderLineItemTaxLineDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"OrderLineItemTaxLineDTO","type":"`object`","description":"The line item tax line details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="setOrderLineItemTaxLines"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderLineItemTaxLineDTO](../../../interfaces/order.OrderLineItemTaxLineDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The order's line item tax lines.","expandable":false,"children":[{"name":"OrderLineItemTaxLineDTO[]","type":"[OrderLineItemTaxLineDTO](../../../interfaces/order.OrderLineItemTaxLineDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"The code of the tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`number`","description":"The rate of the tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the tax line was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the tax line was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"[OrderLineItemDTO](../../../interfaces/order.OrderLineItemDTO/page.mdx)","description":"The associated line item.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The discount total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The discount tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The refundable total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_total_per_unit","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The refundable total per unit of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The ID of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`boolean`","description":"Indicates whether the line item requires shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_discountable","type":"`boolean`","description":"Indicates whether the line item is discountable.","optional":false,"defaultValue":"","expandable":falLine truncated
@@ -44,4 +44,4 @@ const shippingMethodAdjustments = await orderModuleService
## Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderShippingMethodAdjustmentDTO](../../../interfaces/order.OrderShippingMethodAdjustmentDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The order's shipping method adjustments.","expandable":false,"children":[{"name":"OrderShippingMethodAdjustmentDTO[]","type":"[OrderShippingMethodAdjustmentDTO](../../../interfaces/order.OrderShippingMethodAdjustmentDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"OrderShippingMethodAdjustmentDTO","type":"`object`","description":"The shipping method adjustment details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="setOrderShippingMethodAdjustments"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderShippingMethodAdjustmentDTO](../../../interfaces/order.OrderShippingMethodAdjustmentDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The order's shipping method adjustments.","expandable":false,"children":[{"name":"OrderShippingMethodAdjustmentDTO[]","type":"[OrderShippingMethodAdjustmentDTO](../../../interfaces/order.OrderShippingMethodAdjustmentDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the adjustment line","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The amount of the adjustment line","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":"order_id","type":"`string`","description":"The ID of the associated order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the adjustment line was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the adjustment line was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_method","type":"[OrderShippingMethodDTO](../../../interfaces/order.OrderShippingMethodDTO/page.mdx)","description":"The associated shipping method.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the associated order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The price of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`boolean`","description":"Whether the shipping method price is tax inclusive or not.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the shipping method was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the shipping method was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The subtotal of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The tax total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The discount total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The discount tax total of the order shipping method.","Line truncated
@@ -43,4 +43,4 @@ const shippingMethodTaxLines = await orderModuleService
## Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderShippingMethodTaxLineDTO](../../../interfaces/order.OrderShippingMethodTaxLineDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The order's shipping method tax lines.","expandable":false,"children":[{"name":"OrderShippingMethodTaxLineDTO[]","type":"[OrderShippingMethodTaxLineDTO](../../../interfaces/order.OrderShippingMethodTaxLineDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"OrderShippingMethodTaxLineDTO","type":"`object`","description":"The shipping method tax line details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="setOrderShippingMethodTaxLines"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderShippingMethodTaxLineDTO](../../../interfaces/order.OrderShippingMethodTaxLineDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The order's shipping method tax lines.","expandable":false,"children":[{"name":"OrderShippingMethodTaxLineDTO[]","type":"[OrderShippingMethodTaxLineDTO](../../../interfaces/order.OrderShippingMethodTaxLineDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"The code of the tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`number`","description":"The rate of the tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the tax line was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the tax line was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_method","type":"[OrderShippingMethodDTO](../../../interfaces/order.OrderShippingMethodDTO/page.mdx)","description":"The associated shipping method.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the associated order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The price of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`boolean`","description":"Whether the shipping method price is tax inclusive or not.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the shipping method was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the shipping method was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The subtotal of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The tax total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The discount total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The discount tax total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the shipping method.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_id","type":"`string`","description":"The ID of the shipping option the method was created from.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record<string, unknown>`","description":"Additional data needed for fulfillment.","optLine truncated
@@ -35,7 +35,7 @@ const addresses = await orderModuleService.updateOrderAddresses([{
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderAddressDTO](../../../interfaces/order.OrderAddressDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The updated addresses.","expandable":false,"children":[{"name":"OrderAddressDTO[]","type":"[OrderAddressDTO](../../../interfaces/order.OrderAddressDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"OrderAddressDTO","type":"`object`","description":"The address details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateOrderAddresses"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderAddressDTO](../../../interfaces/order.OrderAddressDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The updated addresses.","expandable":false,"children":[{"name":"OrderAddressDTO[]","type":"[OrderAddressDTO](../../../interfaces/order.OrderAddressDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the address was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the address was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string`","description":"The customer ID of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The first name of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The last name of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string`","description":"The phone number of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`string`","description":"The company of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`string`","description":"The first address line of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string`","description":"The second address line 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/state 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":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateOrderAddresses"/>
## updateOrderAddresses(data, sharedContext?): Promise&#60;[OrderAddressDTO](../../../interfaces/order.OrderAddressDTO/page.mdx)&#62;
@@ -56,4 +56,4 @@ const address = await orderModuleService.updateOrderAddresses({
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderAddressDTO](../../../interfaces/order.OrderAddressDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The updated address.","expandable":false,"children":[{"name":"OrderAddressDTO","type":"[OrderAddressDTO](../../../interfaces/order.OrderAddressDTO/page.mdx)","optional":false,"defaultValue":"","description":"The address details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the address was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the address was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string`","description":"The customer ID of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The first name of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The last name of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string`","description":"The phone number of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`string`","description":"The company of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`string`","description":"The first address line of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string`","description":"The second address line 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/state 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":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateOrderAddresses"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderAddressDTO](../../../interfaces/order.OrderAddressDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The updated address.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the address was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the address was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string`","description":"The customer ID of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The first name of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The last name of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string`","description":"The phone number of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`string`","description":"The company of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`string`","description":"The first address line of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string`","description":"The second address line 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/state 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":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateOrderAddresses"/>
@@ -35,7 +35,7 @@ const orderChangeAction = await orderModuleService.updateOrderChangeActions({
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderChangeActionDTO](../../../interfaces/order.OrderChangeActionDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The updated order change action.","expandable":false,"children":[{"name":"OrderChangeActionDTO","type":"[OrderChangeActionDTO](../../../interfaces/order.OrderChangeActionDTO/page.mdx)","optional":false,"defaultValue":"","description":"The order change action details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order change action","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_change_id","type":"`null` \\| `string`","description":"The ID of the associated order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_change","type":"`null` \\| [OrderChangeDTO](../../../interfaces/order.OrderChangeDTO/page.mdx)","description":"The associated order change","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the associated order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The ID of the associated return order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The ID of the associated exchange order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The ID of the associated claim order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)","description":"The associated order","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"return_order","type":"[ReturnDTO](../../../interfaces/order.ReturnDTO/page.mdx)","description":"The associated return order","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"exchange","type":"[OrderExchangeDTO](../../../interfaces/order.OrderExchangeDTO/page.mdx)","description":"The associated exchange order","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"claim","type":"[OrderClaimDTO](../../../interfaces/order.OrderClaimDTO/page.mdx)","description":"The associated claim order","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"actions","type":"[OrderChangeActionDTO](../../../interfaces/order.OrderChangeActionDTO/page.mdx)[]","description":"The actions of the order change","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"status","type":"[OrderChangeStatus](../../../types/order.OrderChangeStatus/page.mdx)","description":"The status of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_by","type":"`null` \\| `string`","description":"The requested by of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_at","type":"`null` \\| `string` \\| `Date`","description":"When the order change was requested","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_by","type":"`null` \\| `string`","description":"The confirmed by of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_at","type":"`null` \\| `string` \\| `Date`","description":"When the order change was confirmed","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_by","type":"`null` \\| `string`","description":"The declined by of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_reason","type":"`null` \\| `string`","description":"The declined reason of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"The metadata of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_at","type":"`null` \\| `string` \\| `Date`","description":"When the order change was declined","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_by","type":"`null` \\| `string`","description":"The canceled by of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`null` \\| `string` \\| `Date`","description":"When the order change was canceled","optional":false,"defaultValue":"","expandable":false,"children":[]Line truncated
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderChangeActionDTO](../../../interfaces/order.OrderChangeActionDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The updated order change action.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order change action","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_change_id","type":"`null` \\| `string`","description":"The ID of the associated order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_change","type":"`null` \\| [OrderChangeDTO](../../../interfaces/order.OrderChangeDTO/page.mdx)","description":"The associated order change","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the associated order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The ID of the associated return order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The ID of the associated exchange order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The ID of the associated claim order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)","description":"The associated order","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"return_order","type":"[ReturnDTO](../../../interfaces/order.ReturnDTO/page.mdx)","description":"The associated return order","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"exchange","type":"[OrderExchangeDTO](../../../interfaces/order.OrderExchangeDTO/page.mdx)","description":"The associated exchange order","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"claim","type":"[OrderClaimDTO](../../../interfaces/order.OrderClaimDTO/page.mdx)","description":"The associated claim order","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"actions","type":"[OrderChangeActionDTO](../../../interfaces/order.OrderChangeActionDTO/page.mdx)[]","description":"The actions of the order change","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"status","type":"[OrderChangeStatus](../../../types/order.OrderChangeStatus/page.mdx)","description":"The status of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_by","type":"`null` \\| `string`","description":"The requested by of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_at","type":"`null` \\| `string` \\| `Date`","description":"When the order change was requested","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_by","type":"`null` \\| `string`","description":"The confirmed by of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_at","type":"`null` \\| `string` \\| `Date`","description":"When the order change was confirmed","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_by","type":"`null` \\| `string`","description":"The declined by of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_reason","type":"`null` \\| `string`","description":"The declined reason of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"The metadata of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_at","type":"`null` \\| `string` \\| `Date`","description":"When the order change was declined","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_by","type":"`null` \\| `string`","description":"The canceled by of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`null` \\| `string` \\| `Date`","description":"When the order change was canceled","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the order change was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":Line truncated
## updateOrderChangeActions(data, sharedContext?): Promise&#60;[OrderChangeActionDTO](../../../interfaces/order.OrderChangeActionDTO/page.mdx)[]&#62;
@@ -56,7 +56,7 @@ const orderChangeActions = await orderModuleService.updateOrderChangeActions([{
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderChangeActionDTO](../../../interfaces/order.OrderChangeActionDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The updated order change actions.","expandable":false,"children":[{"name":"OrderChangeActionDTO[]","type":"[OrderChangeActionDTO](../../../interfaces/order.OrderChangeActionDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"OrderChangeActionDTO","type":"`object`","description":"The order change action details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateOrderChangeActions"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderChangeActionDTO](../../../interfaces/order.OrderChangeActionDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The updated order change actions.","expandable":false,"children":[{"name":"OrderChangeActionDTO[]","type":"[OrderChangeActionDTO](../../../interfaces/order.OrderChangeActionDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order change action","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_change_id","type":"`null` \\| `string`","description":"The ID of the associated order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_change","type":"`null` \\| [OrderChangeDTO](../../../interfaces/order.OrderChangeDTO/page.mdx)","description":"The associated order change","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the associated order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The ID of the associated return order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The ID of the associated exchange order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The ID of the associated claim order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)","description":"The associated order","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"return_order","type":"[ReturnDTO](../../../interfaces/order.ReturnDTO/page.mdx)","description":"The associated return order","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"exchange","type":"[OrderExchangeDTO](../../../interfaces/order.OrderExchangeDTO/page.mdx)","description":"The associated exchange order","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"claim","type":"[OrderClaimDTO](../../../interfaces/order.OrderClaimDTO/page.mdx)","description":"The associated claim order","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"actions","type":"[OrderChangeActionDTO](../../../interfaces/order.OrderChangeActionDTO/page.mdx)[]","description":"The actions of the order change","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"status","type":"[OrderChangeStatus](../../../types/order.OrderChangeStatus/page.mdx)","description":"The status of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_by","type":"`null` \\| `string`","description":"The requested by of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_at","type":"`null` \\| `string` \\| `Date`","description":"When the order change was requested","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_by","type":"`null` \\| `string`","description":"The confirmed by of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_at","type":"`null` \\| `string` \\| `Date`","description":"When the order change was confirmed","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_by","type":"`null` \\| `string`","description":"The declined by of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_reason","type":"`null` \\| `string`","description":"The declined reason of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"The metadata of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_at","type":"`null` \\| `string` \\| `Date`","description":"When the order change was declined","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_by","type":"`null` \\| `string`","description":"The canceled by of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`null` \\| `string` \\| `Date`","description":"When the order change was canceled","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","tLine truncated
## updateOrderChangeActions(data, sharedContext?): Promise&#60;[OrderChangeActionDTO](../../../interfaces/order.OrderChangeActionDTO/page.mdx) \| [OrderChangeActionDTO](../../../interfaces/order.OrderChangeActionDTO/page.mdx)[]&#62;
@@ -34,7 +34,7 @@ const orderChange = await orderModuleService.updateOrderChanges({
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderChangeDTO](../../../interfaces/order.OrderChangeDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The updated order change.","expandable":false,"children":[{"name":"OrderChangeDTO","type":"[OrderChangeDTO](../../../interfaces/order.OrderChangeDTO/page.mdx)","optional":false,"defaultValue":"","description":"The order change details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the associated order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The ID of the associated return order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The ID of the associated exchange order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The ID of the associated claim order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)","description":"The associated order","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../types/order.OrderStatus/page.mdx)","description":"The status of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The subtotal of the order. (Excluding taxes)Line truncated
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderChangeDTO](../../../interfaces/order.OrderChangeDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The updated order change.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the associated order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The ID of the associated return order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The ID of the associated exchange order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The ID of the associated claim order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)","description":"The associated order","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../types/order.OrderStatus/page.mdx)","description":"The status of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The subtotal of the order. (Excluding taxes)","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The tax total of the order.","opLine truncated
## updateOrderChanges(data, sharedContext?): Promise&#60;[OrderChangeDTO](../../../interfaces/order.OrderChangeDTO/page.mdx)[]&#62;
@@ -54,7 +54,7 @@ const orderChanges = await orderModuleService.updateOrderChanges([{
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderChangeDTO](../../../interfaces/order.OrderChangeDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The updated 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":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateOrderChanges"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderChangeDTO](../../../interfaces/order.OrderChangeDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The updated order changes.","expandable":false,"children":[{"name":"OrderChangeDTO[]","type":"[OrderChangeDTO](../../../interfaces/order.OrderChangeDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the associated order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The ID of the associated return order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The ID of the associated exchange order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The ID of the associated claim order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)","description":"The associated order","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../types/order.OrderStatus/page.mdx)","description":"The status of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The subtotal of the order. (Excluding taxes)","optional":falseLine truncated
## updateOrderChanges(data, sharedContext?): Promise&#60;[OrderChangeDTO](../../../interfaces/order.OrderChangeDTO/page.mdx) \| [OrderChangeDTO](../../../interfaces/order.OrderChangeDTO/page.mdx)[]&#62;
@@ -41,7 +41,7 @@ const claims = await orderModuleService.updateOrderClaims([
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderClaimDTO](../../../interfaces/order.OrderClaimDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The updated order claims.","expandable":false,"children":[{"name":"OrderClaimDTO[]","type":"[OrderClaimDTO](../../../interfaces/order.OrderClaimDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"OrderClaimDTO","type":"`object`","description":"The claim details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateOrderClaims"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderClaimDTO](../../../interfaces/order.OrderClaimDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The updated order claims.","expandable":false,"children":[{"name":"OrderClaimDTO[]","type":"[OrderClaimDTO](../../../interfaces/order.OrderClaimDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The claim's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[OrderClaimType](../../../types/order.OrderClaimType/page.mdx)","description":"The claim's type.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the associated order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_version","type":"`number`","description":"The version of the order when the claim is applied.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The claim's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_items","type":"`any`[]","description":"The items to be received from the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"additional_items","type":"`any`[]","description":"The items to be sent to the customer\nif the claim's type is `replace`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)","description":"The associated order.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../types/order.OrderStatus/page.mdx)","description":"The status of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order.","optional":faLine truncated
## updateOrderClaims(selector, data, sharedContext?): Promise&#60;[OrderClaimDTO](../../../interfaces/order.OrderClaimDTO/page.mdx)[]&#62;
@@ -63,7 +63,7 @@ const claims = await orderModuleService.updateOrderClaims({
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderClaimDTO](../../../interfaces/order.OrderClaimDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The updated order claims.","expandable":false,"children":[{"name":"OrderClaimDTO[]","type":"[OrderClaimDTO](../../../interfaces/order.OrderClaimDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"OrderClaimDTO","type":"`object`","description":"The claim details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateOrderClaims"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderClaimDTO](../../../interfaces/order.OrderClaimDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The updated order claims.","expandable":false,"children":[{"name":"OrderClaimDTO[]","type":"[OrderClaimDTO](../../../interfaces/order.OrderClaimDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The claim's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[OrderClaimType](../../../types/order.OrderClaimType/page.mdx)","description":"The claim's type.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the associated order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_version","type":"`number`","description":"The version of the order when the claim is applied.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The claim's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_items","type":"`any`[]","description":"The items to be received from the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"additional_items","type":"`any`[]","description":"The items to be sent to the customer\nif the claim's type is `replace`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)","description":"The associated order.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../types/order.OrderStatus/page.mdx)","description":"The status of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order.","optional":faLine truncated
## updateOrderClaims(id, data, sharedContext?): Promise&#60;[OrderClaimDTO](../../../interfaces/order.OrderClaimDTO/page.mdx)&#62;
@@ -83,4 +83,4 @@ const claim = await orderModuleService.updateOrderClaims("123", {
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderClaimDTO](../../../interfaces/order.OrderClaimDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The updated order claim.","expandable":false,"children":[{"name":"OrderClaimDTO","type":"[OrderClaimDTO](../../../interfaces/order.OrderClaimDTO/page.mdx)","optional":false,"defaultValue":"","description":"The claim details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The claim's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[OrderClaimType](../../../types/order.OrderClaimType/page.mdx)","description":"The claim's type.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the associated order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_version","type":"`number`","description":"The version of the order when the claim is applied.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The claim's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_items","type":"`any`[]","description":"The items to be received from the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"additional_items","type":"`any`[]","description":"The items to be sent to the customer\nif the claim's type is `replace`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)","description":"The associated order.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../types/order.OrderStatus/page.mdx)","description":"The status of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order.","oLine truncated
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderClaimDTO](../../../interfaces/order.OrderClaimDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The updated order claim.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The claim's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[OrderClaimType](../../../types/order.OrderClaimType/page.mdx)","description":"The claim's type.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the associated order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_version","type":"`number`","description":"The version of the order when the claim is applied.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The claim's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_items","type":"`any`[]","description":"The items to be received from the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"additional_items","type":"`any`[]","description":"The items to be sent to the customer\nif the claim's type is `replace`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)","description":"The associated order.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../types/order.OrderStatus/page.mdx)","description":"The status of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The total of the order.","optiLine truncated
@@ -41,7 +41,7 @@ const exchanges = await orderModuleService.updateOrderExchanges([
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderExchangeDTO](../../../interfaces/order.OrderExchangeDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The updated order exchanges.","expandable":false,"children":[{"name":"OrderExchangeDTO[]","type":"[OrderExchangeDTO](../../../interfaces/order.OrderExchangeDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"OrderExchangeDTO","type":"`object`","description":"The exchange details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateOrderExchanges"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderExchangeDTO](../../../interfaces/order.OrderExchangeDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The updated order exchanges.","expandable":false,"children":[{"name":"OrderExchangeDTO[]","type":"[OrderExchangeDTO](../../../interfaces/order.OrderExchangeDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The exchange's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_version","type":"`number`","description":"The version of the order when the exchange is applied.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The exchange's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"additional_items","type":"`any`[]","description":"The items to be sent to the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)","description":"The associated order.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../types/order.OrderStatus/page.mdx)","description":"The status of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The subtotaLine truncated
## updateOrderExchanges(selector, data, sharedContext?): Promise&#60;[OrderExchangeDTO](../../../interfaces/order.OrderExchangeDTO/page.mdx)[]&#62;
@@ -63,7 +63,7 @@ const exchanges = await orderModuleService.updateOrderExchanges({
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderExchangeDTO](../../../interfaces/order.OrderExchangeDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The updated order exchanges.","expandable":false,"children":[{"name":"OrderExchangeDTO[]","type":"[OrderExchangeDTO](../../../interfaces/order.OrderExchangeDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"OrderExchangeDTO","type":"`object`","description":"The exchange details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateOrderExchanges"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderExchangeDTO](../../../interfaces/order.OrderExchangeDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The updated order exchanges.","expandable":false,"children":[{"name":"OrderExchangeDTO[]","type":"[OrderExchangeDTO](../../../interfaces/order.OrderExchangeDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The exchange's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_version","type":"`number`","description":"The version of the order when the exchange is applied.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The exchange's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"additional_items","type":"`any`[]","description":"The items to be sent to the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)","description":"The associated order.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../types/order.OrderStatus/page.mdx)","description":"The status of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The subtotaLine truncated
## updateOrderExchanges(id, data, sharedContext?): Promise&#60;[OrderExchangeDTO](../../../interfaces/order.OrderExchangeDTO/page.mdx)&#62;
@@ -86,4 +86,4 @@ const exchange = await orderModuleService.updateOrderExchanges(
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderExchangeDTO](../../../interfaces/order.OrderExchangeDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The updated order exchange.","expandable":false,"children":[{"name":"OrderExchangeDTO","type":"[OrderExchangeDTO](../../../interfaces/order.OrderExchangeDTO/page.mdx)","optional":false,"defaultValue":"","description":"The exchange details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The exchange's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_version","type":"`number`","description":"The version of the order when the exchange is applied.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The exchange's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"additional_items","type":"`any`[]","description":"The items to be sent to the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)","description":"The associated order.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../types/order.OrderStatus/page.mdx)","description":"The status of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","descriptionLine truncated
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderExchangeDTO](../../../interfaces/order.OrderExchangeDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The updated order exchange.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The exchange's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_version","type":"`number`","description":"The version of the order when the exchange is applied.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The exchange's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"additional_items","type":"`any`[]","description":"The items to be sent to the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)","description":"The associated order.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../types/order.OrderStatus/page.mdx)","description":"The status of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The subtotal of the order. (Excluding taxes)","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","dLine truncated
@@ -36,7 +36,7 @@ const orderItems = await orderModuleService.updateOrderItem({
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderItemDTO](../../../interfaces/order.OrderItemDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The updated order items.","expandable":false,"children":[{"name":"OrderItemDTO[]","type":"[OrderItemDTO](../../../interfaces/order.OrderItemDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"OrderItemDTO","type":"`object`","description":"The order item details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateOrderItem"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderItemDTO](../../../interfaces/order.OrderItemDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The updated order items.","expandable":false,"children":[{"name":"OrderItemDTO[]","type":"[OrderItemDTO](../../../interfaces/order.OrderItemDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"The ID of the associated item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"[OrderLineItemDTO](../../../interfaces/order.OrderLineItemDTO/page.mdx)","description":"The associated line item.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The discount total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The discount tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The refundable total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_total_per_unit","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The refundable total per unit of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The ID of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`boolean`","description":"Indicates whether the line item requires shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_discountable","type":"`boolean`","description":"Indicates whether the line item is discountable.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`boolean`","description":"Indicates whether the line item price is tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"unit_price","type":"`number`","description":"The unit price of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"The quantity of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"detaiLine truncated
## updateOrderItem(orderItemId, data, sharedContext?): Promise&#60;[OrderItemDTO](../../../interfaces/order.OrderItemDTO/page.mdx)&#62;
@@ -59,7 +59,7 @@ const orderItem = await orderModuleService.updateOrderItem(
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderItemDTO](../../../interfaces/order.OrderItemDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The updated order item.","expandable":false,"children":[{"name":"OrderItemDTO","type":"[OrderItemDTO](../../../interfaces/order.OrderItemDTO/page.mdx)","optional":false,"defaultValue":"","description":"The order item details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"The ID of the associated item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"[OrderLineItemDTO](../../../interfaces/order.OrderLineItemDTO/page.mdx)","description":"The associated line item.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The discount total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The discount tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The refundable total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_total_per_unit","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The refundable total per unit of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The ID of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`boolean`","description":"Indicates whether the line item requires shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_discountable","type":"`boolean`","description":"Indicates whether the line item is discountable.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`boolean`","description":"Indicates whether the line item price is tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"unit_price","type":"`number`","description":"The unit price of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"The quantity of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]Line truncated
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderItemDTO](../../../interfaces/order.OrderItemDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The updated order item.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"The ID of the associated item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"[OrderLineItemDTO](../../../interfaces/order.OrderLineItemDTO/page.mdx)","description":"The associated line item.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The discount total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The discount tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The refundable total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_total_per_unit","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The refundable total per unit of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The ID of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`boolean`","description":"Indicates whether the line item requires shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_discountable","type":"`boolean`","description":"Indicates whether the line item is discountable.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`boolean`","description":"Indicates whether the line item price is tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"unit_price","type":"`number`","description":"The unit price of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"The quantity of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"detail","type":"[OrderItemDTO](../../../interfaces/order.OrderItemDTO/page.mdx)","description":"The details of the item","optional":false,"defaultValue":"","expandable":false,"children":[]},{Line truncated
## updateOrderItem(orderItemIdOrDataOrSelector, data?, sharedContext?): Promise&#60;[OrderItemDTO](../../../interfaces/order.OrderItemDTO/page.mdx) \| [OrderItemDTO](../../../interfaces/order.OrderItemDTO/page.mdx)[]&#62;
@@ -41,7 +41,7 @@ const lineItems = await orderModuleService.updateOrderLineItems([
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderLineItemDTO](../../../interfaces/order.OrderLineItemDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The updated line items.","expandable":false,"children":[{"name":"OrderLineItemDTO[]","type":"[OrderLineItemDTO](../../../interfaces/order.OrderLineItemDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"OrderLineItemDTO","type":"`object`","description":"The line item details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateOrderLineItems"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderLineItemDTO](../../../interfaces/order.OrderLineItemDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The updated line items.","expandable":false,"children":[{"name":"OrderLineItemDTO[]","type":"[OrderLineItemDTO](../../../interfaces/order.OrderLineItemDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order line item.","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":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order line item.","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":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order line item.","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":"item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item total of the order line item.","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":"item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item subtotal of the order line item.","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":"item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item tax total of the order line item.","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":"total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The total of the order line item.","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":"subtotal","type":"[BigNuLine truncated
## updateOrderLineItems(selector, data, sharedContext?): Promise&#60;[OrderLineItemDTO](../../../interfaces/order.OrderLineItemDTO/page.mdx)[]&#62;
@@ -63,7 +63,7 @@ const lineItems = await orderModuleService.updateOrderLineItems({
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderLineItemDTO](../../../interfaces/order.OrderLineItemDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The updated line items.","expandable":false,"children":[{"name":"OrderLineItemDTO[]","type":"[OrderLineItemDTO](../../../interfaces/order.OrderLineItemDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"OrderLineItemDTO","type":"`object`","description":"The line item details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateOrderLineItems"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderLineItemDTO](../../../interfaces/order.OrderLineItemDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The updated line items.","expandable":false,"children":[{"name":"OrderLineItemDTO[]","type":"[OrderLineItemDTO](../../../interfaces/order.OrderLineItemDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order line item.","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":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order line item.","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":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order line item.","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":"item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item total of the order line item.","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":"item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item subtotal of the order line item.","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":"item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item tax total of the order line item.","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":"total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The total of the order line item.","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":"subtotal","type":"[BigNuLine truncated
## updateOrderLineItems(lineId, data, sharedContext?): Promise&#60;[OrderLineItemDTO](../../../interfaces/order.OrderLineItemDTO/page.mdx)&#62;
@@ -86,4 +86,4 @@ const lineItem = await orderModuleService.updateOrderLineItems(
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderLineItemDTO](../../../interfaces/order.OrderLineItemDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The updated line item.","expandable":false,"children":[{"name":"OrderLineItemDTO","type":"[OrderLineItemDTO](../../../interfaces/order.OrderLineItemDTO/page.mdx)","optional":false,"defaultValue":"","description":"The line item details.","expandable":false,"children":[{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order line item.","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":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order line item.","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":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order line item.","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":"item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item total of the order line item.","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":"item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item subtotal of the order line item.","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":"item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item tax total of the order line item.","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":"total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The total of the order line item.","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":"subtotal"Line truncated
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderLineItemDTO](../../../interfaces/order.OrderLineItemDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The updated line item.","expandable":false,"children":[{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order line item.","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":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order line item.","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":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order line item.","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":"item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item total of the order line item.","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":"item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item subtotal of the order line item.","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":"item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item tax total of the order line item.","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":"total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The total of the order line item.","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":"subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","tyLine truncated
@@ -35,7 +35,7 @@ const shippingMethods = await orderModuleService.updateOrderShippingMethods([{
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderShippingMethodDTO](../../../interfaces/order.OrderShippingMethodDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The updated shipping methods.","expandable":false,"children":[{"name":"OrderShippingMethodDTO[]","type":"[OrderShippingMethodDTO](../../../interfaces/order.OrderShippingMethodDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"OrderShippingMethodDTO","type":"`object`","description":"The order shipping method details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateOrderShippingMethods"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderShippingMethodDTO](../../../interfaces/order.OrderShippingMethodDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The updated shipping methods.","expandable":false,"children":[{"name":"OrderShippingMethodDTO[]","type":"[OrderShippingMethodDTO](../../../interfaces/order.OrderShippingMethodDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the associated order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The price of the shipping method.","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":"raw_amount","type":"[BigNumberRawValue](../../../types/order.BigNumberRawValue/page.mdx)","description":"The raw price of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"is_tax_inclusive","type":"`boolean`","description":"Whether the shipping method price is tax inclusive or not.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the shipping method was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the shipping method was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order shipping method.","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":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order shipping method.","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":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order shipping method.","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":"total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The total of the order shipping method.","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":"","optioLine truncated
## updateOrderShippingMethods(data, sharedContext?): Promise&#60;[OrderShippingMethodDTO](../../../interfaces/order.OrderShippingMethodDTO/page.mdx)&#62;
@@ -56,4 +56,4 @@ const shippingMethod = await orderModuleService.updateOrderShippingMethods({
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderShippingMethodDTO](../../../interfaces/order.OrderShippingMethodDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The updated shipping method.","expandable":false,"children":[{"name":"OrderShippingMethodDTO","type":"[OrderShippingMethodDTO](../../../interfaces/order.OrderShippingMethodDTO/page.mdx)","optional":false,"defaultValue":"","description":"The order shipping method details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the associated order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The price of the shipping method.","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":"raw_amount","type":"[BigNumberRawValue](../../../types/order.BigNumberRawValue/page.mdx)","description":"The raw price of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"is_tax_inclusive","type":"`boolean`","description":"Whether the shipping method price is tax inclusive or not.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the shipping method was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the shipping method was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order shipping method.","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":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order shipping method.","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":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order shipping method.","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":"total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The total of the order shipping method.","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":"`BigNumbeLine truncated
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderShippingMethodDTO](../../../interfaces/order.OrderShippingMethodDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The updated shipping method.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the associated order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The price of the shipping method.","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":"raw_amount","type":"[BigNumberRawValue](../../../types/order.BigNumberRawValue/page.mdx)","description":"The raw price of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"is_tax_inclusive","type":"`boolean`","description":"Whether the shipping method price is tax inclusive or not.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the shipping method was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the shipping method was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order shipping method.","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":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order shipping method.","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":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order shipping method.","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":"total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The total of the order shipping method.","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":"subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The subtotal of the order shipping method.","oLine truncated
@@ -35,7 +35,7 @@ const orders = await orderModuleService.updateOrders([{
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The updated orders.","expandable":false,"children":[{"name":"OrderDTO[]","type":"[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"OrderDTO","type":"`object`","description":"The order details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateOrders"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The updated orders.","expandable":false,"children":[{"name":"OrderDTO[]","type":"[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../types/order.OrderStatus/page.mdx)","description":"The status of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item total of the order.","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":"original_item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item subtotal of the order.","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":"original_item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item tax total of the order.","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":"item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item total of the order.","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":"item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item subtotal of the order.","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":"item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optionaLine truncated
## updateOrders(orderId, data, sharedContext?): Promise&#60;[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)&#62;
@@ -58,7 +58,7 @@ const order = await orderModuleService.updateOrders(
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The updated orders.","expandable":false,"children":[{"name":"OrderDTO","type":"[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)","optional":false,"defaultValue":"","description":"The order details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../types/order.OrderStatus/page.mdx)","description":"The status of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item total of the order.","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":"original_item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item subtotal of the order.","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":"original_item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item tax total of the order.","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":"item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item total of the order.","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":"item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item subtotal of the order.","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":"item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description"Line truncated
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The updated orders.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../types/order.OrderStatus/page.mdx)","description":"The status of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item total of the order.","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":"original_item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item subtotal of the order.","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":"original_item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item tax total of the order.","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":"item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item total of the order.","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":"item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item subtotal of the order.","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":"item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item tax total of the order.","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":"","opLine truncated
## updateOrders(selector, data, sharedContext?): Promise&#60;[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)[]&#62;
@@ -80,4 +80,4 @@ const orders = await orderModuleService.updateOrders({
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The updated orders.","expandable":false,"children":[{"name":"OrderDTO[]","type":"[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"OrderDTO","type":"`object`","description":"The order details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateOrders"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The updated orders.","expandable":false,"children":[{"name":"OrderDTO[]","type":"[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../types/order.OrderStatus/page.mdx)","description":"The status of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item total of the order.","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":"original_item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item subtotal of the order.","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":"original_item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item tax total of the order.","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":"item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item total of the order.","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":"item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item subtotal of the order.","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":"item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optionaLine truncated
@@ -36,7 +36,7 @@ const returnReasons = await orderModuleService.updateReturnReasons({
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderReturnReasonDTO](../../../interfaces/order.OrderReturnReasonDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The updated return reasons.","expandable":false,"children":[{"name":"OrderReturnReasonDTO[]","type":"[OrderReturnReasonDTO](../../../interfaces/order.OrderReturnReasonDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"OrderReturnReasonDTO","type":"`object`","description":"The order return reason details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateReturnReasons"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderReturnReasonDTO](../../../interfaces/order.OrderReturnReasonDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The updated return reasons.","expandable":false,"children":[{"name":"OrderReturnReasonDTO[]","type":"[OrderReturnReasonDTO](../../../interfaces/order.OrderReturnReasonDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The unique value of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"The label of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"The metadata of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the return reason was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the return reason was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the return reason","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`string`","description":"The parent return reason ID","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason","type":"[OrderReturnReasonDTO](../../../interfaces/order.OrderReturnReasonDTO/page.mdx)","description":"The associated order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The unique value of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"The label of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"The metadata of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the return reason was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the return reason was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the return reason","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`string`","description":"The parent return reason ID","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason","type":"[OrderReturnReasonDTO](../../../interfaces/order.OrderReturnReasonDTO/page.mdx)","description":"The associated order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_reason_children","type":"[OrderReturnReasonDTO](../../../interfaces/order.OrderReturnReasonDTO/page.mdx)[]","description":"The return reason children of the order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"return_reason_children","type":"[OrderReturnReasonDTO](../../../interfaces/order.OrderReturnReasonDTO/page.mdx)[]","description":"The return reason children of the order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The unique value of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"The label of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"The metadata of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the return reason was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the return reason was updated","optional":false,"defaultValueLine truncated
## updateReturnReasons(id, data, sharedContext?): Promise&#60;[OrderReturnReasonDTO](../../../interfaces/order.OrderReturnReasonDTO/page.mdx)&#62;
@@ -59,4 +59,4 @@ const returnReason = await orderModuleService.updateReturnReasons(
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderReturnReasonDTO](../../../interfaces/order.OrderReturnReasonDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The updated return reason.","expandable":false,"children":[{"name":"OrderReturnReasonDTO","type":"[OrderReturnReasonDTO](../../../interfaces/order.OrderReturnReasonDTO/page.mdx)","optional":false,"defaultValue":"","description":"The order return reason details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The unique value of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"The label of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"The metadata of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the return reason was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the return reason was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the return reason","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`string`","description":"The parent return reason ID","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason","type":"[OrderReturnReasonDTO](../../../interfaces/order.OrderReturnReasonDTO/page.mdx)","description":"The associated order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The unique value of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"The label of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"The metadata of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the return reason was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the return reason was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the return reason","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`string`","description":"The parent return reason ID","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason","type":"[OrderReturnReasonDTO](../../../interfaces/order.OrderReturnReasonDTO/page.mdx)","description":"The associated order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_reason_children","type":"[OrderReturnReasonDTO](../../../interfaces/order.OrderReturnReasonDTO/page.mdx)[]","description":"The return reason children of the order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"return_reason_children","type":"[OrderReturnReasonDTO](../../../interfaces/order.OrderReturnReasonDTO/page.mdx)[]","description":"The return reason children of the order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The unique value of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"The label of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"The metadata of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the return reason was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the return reason was updated","optiLine truncated
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderReturnReasonDTO](../../../interfaces/order.OrderReturnReasonDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The updated return reason.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The unique value of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"The label of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"The metadata of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the return reason was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the return reason was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the return reason","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`string`","description":"The parent return reason ID","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason","type":"[OrderReturnReasonDTO](../../../interfaces/order.OrderReturnReasonDTO/page.mdx)","description":"The associated order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The unique value of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"The label of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"The metadata of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the return reason was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the return reason was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the return reason","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`string`","description":"The parent return reason ID","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason","type":"[OrderReturnReasonDTO](../../../interfaces/order.OrderReturnReasonDTO/page.mdx)","description":"The associated order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_reason_children","type":"[OrderReturnReasonDTO](../../../interfaces/order.OrderReturnReasonDTO/page.mdx)[]","description":"The return reason children of the order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"return_reason_children","type":"[OrderReturnReasonDTO](../../../interfaces/order.OrderReturnReasonDTO/page.mdx)[]","description":"The return reason children of the order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The unique value of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"The label of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"The metadata of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the return reason was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the return reason was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the return reason","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"pLine truncated
@@ -39,7 +39,7 @@ const returns = await orderModuleService.updateReturns([{
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[ReturnDTO](../../../interfaces/order.ReturnDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The updated returns.","expandable":false,"children":[{"name":"ReturnDTO[]","type":"[ReturnDTO](../../../interfaces/order.ReturnDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"ReturnDTO","type":"`object`","description":"The return details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateReturns"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[ReturnDTO](../../../interfaces/order.ReturnDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The updated returns.","expandable":false,"children":[{"name":"ReturnDTO[]","type":"[ReturnDTO](../../../interfaces/order.ReturnDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ReturnStatus](../../../types/order.ReturnStatus/page.mdx)","description":"The status of the return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[OrderReturnItemDTO](../../../interfaces/order.OrderReturnItemDTO/page.mdx)[]","description":"The items of the return","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order return item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"The associated line item's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"The quantity of the item to return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reason_id","type":"`null` \\| `string`","description":"The associated reason's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"received_quantity","type":"`number`","description":"The received quantity of the return item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"damaged_quantity","type":"`number`","description":"The damaged quantity of the return item.","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":"created_at","type":"`string` \\| `Date`","description":"The creation date of the return item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the return item.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"display_id","type":"`number`","description":"The return's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refund_amount","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The refund amount of the return.","optional":true,"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":"raw_refund_amount","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The raw refund amount of the return.","optional":true,"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":"order","type":"[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)","description":"The associated order.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":Line truncated
## updateReturns(selector, data, sharedContext?): Promise&#60;[ReturnDTO](../../../interfaces/order.ReturnDTO/page.mdx)[]&#62;
@@ -61,7 +61,7 @@ const returns = await orderModuleService.updateReturns({
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[ReturnDTO](../../../interfaces/order.ReturnDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The updated returns.","expandable":false,"children":[{"name":"ReturnDTO[]","type":"[ReturnDTO](../../../interfaces/order.ReturnDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"ReturnDTO","type":"`object`","description":"The return details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateReturns"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[ReturnDTO](../../../interfaces/order.ReturnDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The updated returns.","expandable":false,"children":[{"name":"ReturnDTO[]","type":"[ReturnDTO](../../../interfaces/order.ReturnDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ReturnStatus](../../../types/order.ReturnStatus/page.mdx)","description":"The status of the return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[OrderReturnItemDTO](../../../interfaces/order.OrderReturnItemDTO/page.mdx)[]","description":"The items of the return","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order return item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"The associated line item's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"The quantity of the item to return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reason_id","type":"`null` \\| `string`","description":"The associated reason's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"received_quantity","type":"`number`","description":"The received quantity of the return item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"damaged_quantity","type":"`number`","description":"The damaged quantity of the return item.","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":"created_at","type":"`string` \\| `Date`","description":"The creation date of the return item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the return item.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"display_id","type":"`number`","description":"The return's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refund_amount","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The refund amount of the return.","optional":true,"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":"raw_refund_amount","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The raw refund amount of the return.","optional":true,"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":"order","type":"[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)","description":"The associated order.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":Line truncated
## updateReturns(id, data, sharedContext?): Promise&#60;[ReturnDTO](../../../interfaces/order.ReturnDTO/page.mdx)&#62;
@@ -84,4 +84,4 @@ const orderReturn = await orderModuleService.updateReturns(
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[ReturnDTO](../../../interfaces/order.ReturnDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The updated return.","expandable":false,"children":[{"name":"ReturnDTO","type":"[ReturnDTO](../../../interfaces/order.ReturnDTO/page.mdx)","optional":false,"defaultValue":"","description":"The return details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ReturnStatus](../../../types/order.ReturnStatus/page.mdx)","description":"The status of the return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[OrderReturnItemDTO](../../../interfaces/order.OrderReturnItemDTO/page.mdx)[]","description":"The items of the return","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order return item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"The associated line item's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"The quantity of the item to return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reason_id","type":"`null` \\| `string`","description":"The associated reason's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"received_quantity","type":"`number`","description":"The received quantity of the return item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"damaged_quantity","type":"`number`","description":"The damaged quantity of the return item.","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":"created_at","type":"`string` \\| `Date`","description":"The creation date of the return item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the return item.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"display_id","type":"`number`","description":"The return's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refund_amount","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The refund amount of the return.","optional":true,"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":"raw_refund_amount","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The raw refund amount of the return.","optional":true,"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":"order","type":"[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)","description":"The associated order.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"displayLine truncated
<TypeList types={[{"name":"Promise","type":"Promise&#60;[ReturnDTO](../../../interfaces/order.ReturnDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The updated return.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ReturnStatus](../../../types/order.ReturnStatus/page.mdx)","description":"The status of the return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[OrderReturnItemDTO](../../../interfaces/order.OrderReturnItemDTO/page.mdx)[]","description":"The items of the return","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order return item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"The associated line item's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"The quantity of the item to return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reason_id","type":"`null` \\| `string`","description":"The associated reason's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"received_quantity","type":"`number`","description":"The received quantity of the return item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"damaged_quantity","type":"`number`","description":"The damaged quantity of the return item.","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":"created_at","type":"`string` \\| `Date`","description":"The creation date of the return item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the return item.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"display_id","type":"`number`","description":"The return's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refund_amount","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The refund amount of the return.","optional":true,"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":"raw_refund_amount","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The raw refund amount of the return.","optional":true,"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":"order","type":"[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)","description":"The associated order.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../types/ordLine truncated
@@ -42,4 +42,4 @@ const lineItemAdjustments = await orderModuleService.upsertOrderLineItemAdjustme
## Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderLineItemAdjustmentDTO](../../../interfaces/order.OrderLineItemAdjustmentDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The line item adjustments.","expandable":false,"children":[{"name":"OrderLineItemAdjustmentDTO[]","type":"[OrderLineItemAdjustmentDTO](../../../interfaces/order.OrderLineItemAdjustmentDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"OrderLineItemAdjustmentDTO","type":"`object`","description":"The line item adjustment details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="upsertOrderLineItemAdjustments"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderLineItemAdjustmentDTO](../../../interfaces/order.OrderLineItemAdjustmentDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The line item adjustments.","expandable":false,"children":[{"name":"OrderLineItemAdjustmentDTO[]","type":"[OrderLineItemAdjustmentDTO](../../../interfaces/order.OrderLineItemAdjustmentDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the adjustment line","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The amount of the adjustment line","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":"order_id","type":"`string`","description":"The ID of the associated order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the adjustment line was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the adjustment line was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"[OrderLineItemDTO](../../../interfaces/order.OrderLineItemDTO/page.mdx)","description":"The associated line item.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The discount total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The discount tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The refundable total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_total_per_unit","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The refundable total per unit of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The ID of the line item.","optional":false,"defaultValue":"","Line truncated
@@ -38,4 +38,4 @@ const lineItemTaxLines = await orderModuleService
## Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderLineItemTaxLineDTO](../../../interfaces/order.OrderLineItemTaxLineDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The line item tax lines.","expandable":false,"children":[{"name":"OrderLineItemTaxLineDTO[]","type":"[OrderLineItemTaxLineDTO](../../../interfaces/order.OrderLineItemTaxLineDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"OrderLineItemTaxLineDTO","type":"`object`","description":"The line item tax line details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="upsertOrderLineItemTaxLines"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderLineItemTaxLineDTO](../../../interfaces/order.OrderLineItemTaxLineDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The line item tax lines.","expandable":false,"children":[{"name":"OrderLineItemTaxLineDTO[]","type":"[OrderLineItemTaxLineDTO](../../../interfaces/order.OrderLineItemTaxLineDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"The code of the tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`number`","description":"The rate of the tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the tax line was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the tax line was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"[OrderLineItemDTO](../../../interfaces/order.OrderLineItemDTO/page.mdx)","description":"The associated line item.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The discount total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The discount tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The refundable total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_total_per_unit","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The refundable total per unit of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The ID of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`boolean`","description":"Indicates whether the line item requires shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_discountable","type":"`boolean`","description":"Indicates whether the line item is discountable.","optional":false,"defaultValue":"","expandable":false,"chilLine truncated
@@ -43,4 +43,4 @@ const shippingMethodAdjustments = await orderModuleService
## Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderShippingMethodAdjustmentDTO](../../../interfaces/order.OrderShippingMethodAdjustmentDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The shipping method adjustments.","expandable":false,"children":[{"name":"OrderShippingMethodAdjustmentDTO[]","type":"[OrderShippingMethodAdjustmentDTO](../../../interfaces/order.OrderShippingMethodAdjustmentDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"OrderShippingMethodAdjustmentDTO","type":"`object`","description":"The shipping method adjustment details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="upsertOrderShippingMethodAdjustments"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderShippingMethodAdjustmentDTO](../../../interfaces/order.OrderShippingMethodAdjustmentDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The shipping method adjustments.","expandable":false,"children":[{"name":"OrderShippingMethodAdjustmentDTO[]","type":"[OrderShippingMethodAdjustmentDTO](../../../interfaces/order.OrderShippingMethodAdjustmentDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the adjustment line","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The amount of the adjustment line","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":"order_id","type":"`string`","description":"The ID of the associated order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the adjustment line was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the adjustment line was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_method","type":"[OrderShippingMethodDTO](../../../interfaces/order.OrderShippingMethodDTO/page.mdx)","description":"The associated shipping method.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the associated order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The price of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`boolean`","description":"Whether the shipping method price is tax inclusive or not.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the shipping method was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the shipping method was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The subtotal of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The tax total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The discount total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The discount tax total of the order shipping method.","optionalLine truncated
@@ -42,4 +42,4 @@ const shippingMethodTaxLines = await orderModuleService
## Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderShippingMethodTaxLineDTO](../../../interfaces/order.OrderShippingMethodTaxLineDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The shipping method tax lines.","expandable":false,"children":[{"name":"OrderShippingMethodTaxLineDTO[]","type":"[OrderShippingMethodTaxLineDTO](../../../interfaces/order.OrderShippingMethodTaxLineDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"OrderShippingMethodTaxLineDTO","type":"`object`","description":"The shipping method tax line details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="upsertOrderShippingMethodTaxLines"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderShippingMethodTaxLineDTO](../../../interfaces/order.OrderShippingMethodTaxLineDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The shipping method tax lines.","expandable":false,"children":[{"name":"OrderShippingMethodTaxLineDTO[]","type":"[OrderShippingMethodTaxLineDTO](../../../interfaces/order.OrderShippingMethodTaxLineDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"The code of the tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`number`","description":"The rate of the tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the tax line was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the tax line was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_method","type":"[OrderShippingMethodDTO](../../../interfaces/order.OrderShippingMethodDTO/page.mdx)","description":"The associated shipping method.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the associated order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The price of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`boolean`","description":"Whether the shipping method price is tax inclusive or not.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the shipping method was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the shipping method was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The subtotal of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The tax total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The discount total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The discount tax total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the shipping method.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_id","type":"`string`","description":"The ID of the shipping option the method was created from.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record<string, unknown>`","description":"Additional data needed for fulfillment.","optional":tLine truncated