chore(docs): Generated References (#8598)
Generated the following references: - `core_flows` - `modules` - `types` Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
github-actions[bot]andShahed Nasser authored and 
GitHub committed
1 parent
b4f3b8a79d
commit
3ea467e3e8
44 files changed
+100022
-100654
No files matched your search
@@ -3455,10 +3455,6 @@ export const filesMap = [
|
||||
"filePath": "/www/apps/resources/references/core_flows/Order/functions/core_flows.Order.createFulfillmentValidateOrder/page.mdx",
|
||||
"pathname": "/references/core_flows/Order/functions/core_flows.Order.createFulfillmentValidateOrder"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/core_flows/Order/functions/core_flows.Order.createOrderChangeActionsStep/page.mdx",
|
||||
"pathname": "/references/core_flows/Order/functions/core_flows.Order.createOrderChangeActionsStep"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/core_flows/Order/functions/core_flows.Order.createOrderChangeActionsWorkflow/page.mdx",
|
||||
"pathname": "/references/core_flows/Order/functions/core_flows.Order.createOrderChangeActionsWorkflow"
|
||||
@@ -3967,10 +3963,6 @@ export const filesMap = [
|
||||
"filePath": "/www/apps/resources/references/core_flows/Order/variables/core_flows.Order.createExchangeShippingMethodWorkflowId/page.mdx",
|
||||
"pathname": "/references/core_flows/Order/variables/core_flows.Order.createExchangeShippingMethodWorkflowId"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/core_flows/Order/variables/core_flows.Order.createOrderChangeActionsStepId/page.mdx",
|
||||
"pathname": "/references/core_flows/Order/variables/core_flows.Order.createOrderChangeActionsStepId"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/core_flows/Order/variables/core_flows.Order.createOrderChangeActionsWorkflowId/page.mdx",
|
||||
"pathname": "/references/core_flows/Order/variables/core_flows.Order.createOrderChangeActionsWorkflowId"
|
||||
|
||||
@@ -11149,14 +11149,6 @@ export const generatedSidebar = [
|
||||
"title": "createFulfillmentValidateOrder",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"loaded": true,
|
||||
"isPathHref": true,
|
||||
"type": "link",
|
||||
"path": "/references/medusa-workflows/steps/createOrderChangeActionsStep",
|
||||
"title": "createOrderChangeActionsStep",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"loaded": true,
|
||||
"isPathHref": true,
|
||||
|
||||
@@ -1419,11 +1419,6 @@ export const slugChanges = [
|
||||
"newSlug": "/references/medusa-workflows/createExchangeShippingMethodWorkflow",
|
||||
"filePath": "/www/apps/resources/references/core_flows/Order/functions/core_flows.Order.createExchangeShippingMethodWorkflow/page.mdx"
|
||||
},
|
||||
{
|
||||
"origSlug": "/references/core_flows/Order/functions/core_flows.Order.createOrderChangeActionsStep",
|
||||
"newSlug": "/references/medusa-workflows/steps/createOrderChangeActionsStep",
|
||||
"filePath": "/www/apps/resources/references/core_flows/Order/functions/core_flows.Order.createOrderChangeActionsStep/page.mdx"
|
||||
},
|
||||
{
|
||||
"origSlug": "/references/core_flows/Order/functions/core_flows.Order.createOrderChangeActionsWorkflow",
|
||||
"newSlug": "/references/medusa-workflows/createOrderChangeActionsWorkflow",
|
||||
|
||||
+1
-1
@@ -13,7 +13,7 @@ This workflow confirms a requested claim.
|
||||
|
||||
## Diagram
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"confirmClaimRequestWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":3},{"type":"step","name":"confirmClaimRequestValidationStep","description":"This step validates that a requested claim can be confirmed.","link":"../core_flows.Order.confirmClaimRequestValidationStep/page.mdx","depth":4},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../core_flows.Order.previewOrderChangeStep/page.mdx","depth":5},{"type":"step","name":"createOrderClaimItemsFromActionsStep","description":"This step creates claim items from a change action.","link":"../core_flows.Order.createOrderClaimItemsFromActionsStep/page.mdx","depth":6},{"type":"step","name":"updateReturnsStep","description":"This step updates one or more returns.","link":"../core_flows.Order.updateReturnsStep/page.mdx","depth":7},{"type":"when","condition":"{\n return !!claimShippingMethod\n }","depth":"8","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":8},{"type":"step","name":"reserveInventoryStep","description":"This step reserves the quantity of line items from the associated\nvariant's inventory.","link":"../../../Definition/functions/core_flows.Definition.reserveInventoryStep/page.mdx","depth":8}]},{"type":"when","condition":"{\n return !!returnShippingMethod\n }","depth":"9","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":9},{"type":"workflow","name":"createReturnFulfillmentWorkflow","description":"This workflow creates a fulfillment for a return.","link":"../../../Fulfillment/functions/core_flows.Fulfillment.createReturnFulfillmentWorkflow/page.mdx","depth":9},{"type":"step","name":"createRemoteLinkStep","description":"This step creates remote links between two records of linked data models.\n\nLearn more in the [Remote Link documentation.](https://docs.medusajs.com/v2/advanced-development/modules/remote-link#create-link).\n\n","link":"../../../Common/functions/core_flows.Common.createRemoteLinkStep/page.mdx","depth":9}]}]}} />
|
||||
<WorkflowDiagram workflow={{"name":"confirmClaimRequestWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":3},{"type":"step","name":"confirmClaimRequestValidationStep","description":"This step validates that a requested claim can be confirmed.","link":"../core_flows.Order.confirmClaimRequestValidationStep/page.mdx","depth":4},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../core_flows.Order.previewOrderChangeStep/page.mdx","depth":5},{"type":"step","name":"createOrderClaimItemsFromActionsStep","description":"This step creates claim items from a change action.","link":"../core_flows.Order.createOrderClaimItemsFromActionsStep/page.mdx","depth":6},{"type":"when","condition":"{\n return !!returnId\n }","depth":"7","steps":[{"type":"step","name":"updateReturnsStep","description":"This step updates one or more returns.","link":"../core_flows.Order.updateReturnsStep/page.mdx","depth":7}]},{"type":"when","condition":"{\n return !!claimShippingMethod\n }","depth":"8","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":8},{"type":"step","name":"reserveInventoryStep","description":"This step reserves the quantity of line items from the associated\nvariant's inventory.","link":"../../../Definition/functions/core_flows.Definition.reserveInventoryStep/page.mdx","depth":8}]},{"type":"when","condition":"{\n return !!returnShippingMethod && !!returnId\n }","depth":"9","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":9},{"type":"workflow","name":"createReturnFulfillmentWorkflow","description":"This workflow creates a fulfillment for a return.","link":"../../../Fulfillment/functions/core_flows.Fulfillment.createReturnFulfillmentWorkflow/page.mdx","depth":9},{"type":"step","name":"createRemoteLinkStep","description":"This step creates remote links between two records of linked data models.\n\nLearn more in the [Remote Link documentation.](https://docs.medusajs.com/v2/advanced-development/modules/remote-link#create-link).\n\n","link":"../../../Common/functions/core_flows.Common.createRemoteLinkStep/page.mdx","depth":9}]}]}} />
|
||||
|
||||
## Input
|
||||
|
||||
|
||||
+1
-1
@@ -13,7 +13,7 @@ This workflow creates a shipping method for a claim.
|
||||
|
||||
## Diagram
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"createClaimShippingMethodWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":3},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":4},{"type":"step","name":"createClaimShippingMethodValidationStep","description":"This step confirms that a shipping method can be created for a claim.","link":"../core_flows.Order.createClaimShippingMethodValidationStep/page.mdx","depth":5},{"type":"step","name":"createOrderChangeActionsStep","description":"This step creates order change actions.","link":"../core_flows.Order.createOrderChangeActionsStep/page.mdx","depth":6},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../core_flows.Order.previewOrderChangeStep/page.mdx","depth":7}]}} />
|
||||
<WorkflowDiagram workflow={{"name":"createClaimShippingMethodWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":3},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":4},{"type":"step","name":"createClaimShippingMethodValidationStep","description":"This step confirms that a shipping method can be created for a claim.","link":"../core_flows.Order.createClaimShippingMethodValidationStep/page.mdx","depth":5},{"type":"workflow","name":"createOrderChangeActionsWorkflow","description":"This workflow creates order change actions.","link":"../core_flows.Order.createOrderChangeActionsWorkflow/page.mdx","depth":6},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../core_flows.Order.previewOrderChangeStep/page.mdx","depth":7}]}} />
|
||||
|
||||
## Input
|
||||
|
||||
|
||||
+1
-1
@@ -13,7 +13,7 @@ This workflow creates a shipping method for an exchange.
|
||||
|
||||
## Diagram
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"createExchangeShippingMethodWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":3},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":4},{"type":"step","name":"createExchangeShippingMethodValidationStep","description":"This step validates that a shipping method can be created for an exchange.","link":"../core_flows.Order.createExchangeShippingMethodValidationStep/page.mdx","depth":5},{"type":"step","name":"createOrderChangeActionsStep","description":"This step creates order change actions.","link":"../core_flows.Order.createOrderChangeActionsStep/page.mdx","depth":6},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../core_flows.Order.previewOrderChangeStep/page.mdx","depth":7}]}} />
|
||||
<WorkflowDiagram workflow={{"name":"createExchangeShippingMethodWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":3},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":4},{"type":"step","name":"createExchangeShippingMethodValidationStep","description":"This step validates that a shipping method can be created for an exchange.","link":"../core_flows.Order.createExchangeShippingMethodValidationStep/page.mdx","depth":5},{"type":"workflow","name":"createOrderChangeActionsWorkflow","description":"This workflow creates order change actions.","link":"../core_flows.Order.createOrderChangeActionsWorkflow/page.mdx","depth":6},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../core_flows.Order.previewOrderChangeStep/page.mdx","depth":7}]}} />
|
||||
|
||||
## Input
|
||||
|
||||
|
||||
-20
@@ -1,20 +0,0 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/steps/createOrderChangeActionsStep
|
||||
sidebar_label: createOrderChangeActionsStep
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# createOrderChangeActionsStep - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `createOrderChangeActionsStep`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This step creates order change actions.
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"CreateOrderChangeActionDTO[]","type":"[CreateOrderChangeActionDTO](../../../../order/interfaces/order.CreateOrderChangeActionDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"CreateOrderChangeActionDTO","type":"[CreateOrderChangeActionDTO](../../../../order/interfaces/order.CreateOrderChangeActionDTO/page.mdx)","optional":false,"defaultValue":"","description":"The data of the order change action to be created.","expandable":false,"children":[{"name":"action","type":"[ChangeActionType](../../../../order/types/order.ChangeActionType/page.mdx)","description":"The type of action.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_change_id","type":"`string`","description":"The associated order change's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The associated claim's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The associated exchange's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order change action.\nOnce the order change action is confirmed, this\nbecomes the order's version.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`string`","description":"The name of the data model that this action\nreferences. For example, `return`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the record references of the data model\nspecified in [reference](../../../../order/interfaces/order.CreateOrderChangeActionDTO/page.mdx#reference).\n\nFor example, if `reference` is `return`, the `reference_id`\nis the ID of the return.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"The internal note of the order change action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberInput](../../../../order/types/order.BigNumberInput/page.mdx)","description":"The amount of the order change action.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../../order/types/order.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"details","type":"`Record<string, unknown>`","description":"The details of the order change action.\n\nThis could include the returned items or their changed\nquantity, based on the type of this action.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} sectionTitle="createOrderChangeActionsStep"/>
|
||||
|
||||
## Output
|
||||
|
||||
<TypeList types={[{"name":"OrderChangeActionDTO[]","type":"[OrderChangeActionDTO](../../../../fulfillment/interfaces/fulfillment.OrderChangeActionDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"OrderChangeActionDTO","type":"[OrderChangeActionDTO](../../../../fulfillment/interfaces/fulfillment.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](../../../../fulfillment/interfaces/fulfillment.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](../../../../fulfillment/interfaces/fulfillment.OrderDTO/page.mdx)","description":"The associated order","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"return_order","type":"[ReturnDTO](../../../../fulfillment/interfaces/fulfillment.ReturnDTO/page.mdx)","description":"The associated return order","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"exchange","type":"[OrderExchangeDTO](../../../../fulfillment/interfaces/fulfillment.OrderExchangeDTO/page.mdx)","description":"The associated exchange order","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"claim","type":"[OrderClaimDTO](../../../../fulfillment/interfaces/fulfillment.OrderClaimDTO/page.mdx)","description":"The associated claim order","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"actions","type":"[OrderChangeActionDTO](../../../../fulfillment/interfaces/fulfillment.OrderChangeActionDTO/page.mdx)[]","description":"The actions of the order change","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"status","type":"`string`","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 cLine truncated
|
||||
-4
@@ -11,10 +11,6 @@ This documentation provides a reference to the `createOrderChangeActionsWorkflow
|
||||
|
||||
This workflow creates order change actions.
|
||||
|
||||
## Diagram
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"createOrderChangeActionsWorkflow","steps":[{"type":"step","name":"createOrderChangeActionsStep","description":"This step creates order change actions.","link":"../core_flows.Order.createOrderChangeActionsStep/page.mdx","depth":1}]}} />
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"CreateOrderChangeActionDTO[]","type":"[CreateOrderChangeActionDTO](../../../../order/interfaces/order.CreateOrderChangeActionDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"CreateOrderChangeActionDTO","type":"[CreateOrderChangeActionDTO](../../../../order/interfaces/order.CreateOrderChangeActionDTO/page.mdx)","optional":false,"defaultValue":"","description":"The data of the order change action to be created.","expandable":false,"children":[{"name":"action","type":"[ChangeActionType](../../../../order/types/order.ChangeActionType/page.mdx)","description":"The type of action.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_change_id","type":"`string`","description":"The associated order change's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The associated claim's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The associated exchange's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order change action.\nOnce the order change action is confirmed, this\nbecomes the order's version.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`string`","description":"The name of the data model that this action\nreferences. For example, `return`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the record references of the data model\nspecified in [reference](../../../../order/interfaces/order.CreateOrderChangeActionDTO/page.mdx#reference).\n\nFor example, if `reference` is `return`, the `reference_id`\nis the ID of the return.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"The internal note of the order change action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberInput](../../../../order/types/order.BigNumberInput/page.mdx)","description":"The amount of the order change action.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../../order/types/order.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"details","type":"`Record<string, unknown>`","description":"The details of the order change action.\n\nThis could include the returned items or their changed\nquantity, based on the type of this action.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} sectionTitle="createOrderChangeActionsWorkflow"/>
|
||||
|
||||
+1
-1
@@ -13,7 +13,7 @@ This workflow creates a shipping method for a return.
|
||||
|
||||
## Diagram
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"createReturnShippingMethodWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":3},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":4},{"type":"step","name":"createReturnShippingMethodValidationStep","description":"This step validates that a shipping method can be created for a return.","link":"../core_flows.Order.createReturnShippingMethodValidationStep/page.mdx","depth":5},{"type":"step","name":"createOrderChangeActionsStep","description":"This step creates order change actions.","link":"../core_flows.Order.createOrderChangeActionsStep/page.mdx","depth":6},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../core_flows.Order.previewOrderChangeStep/page.mdx","depth":7}]}} />
|
||||
<WorkflowDiagram workflow={{"name":"createReturnShippingMethodWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":3},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":4},{"type":"step","name":"createReturnShippingMethodValidationStep","description":"This step validates that a shipping method can be created for a return.","link":"../core_flows.Order.createReturnShippingMethodValidationStep/page.mdx","depth":5},{"type":"workflow","name":"createOrderChangeActionsWorkflow","description":"This workflow creates order change actions.","link":"../core_flows.Order.createOrderChangeActionsWorkflow/page.mdx","depth":6},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../core_flows.Order.previewOrderChangeStep/page.mdx","depth":7}]}} />
|
||||
|
||||
## Input
|
||||
|
||||
|
||||
+1
-1
@@ -13,7 +13,7 @@ This workflow dismisses items from a return request.
|
||||
|
||||
## Diagram
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"dismissItemReturnRequestWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":3},{"type":"step","name":"dismissItemReturnRequestValidationStep","description":"This step validates that a return request can have its items dismissed.","link":"../core_flows.Order.dismissItemReturnRequestValidationStep/page.mdx","depth":4},{"type":"step","name":"createOrderChangeActionsStep","description":"This step creates order change actions.","link":"../core_flows.Order.createOrderChangeActionsStep/page.mdx","depth":5},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../core_flows.Order.previewOrderChangeStep/page.mdx","depth":6}]}} />
|
||||
<WorkflowDiagram workflow={{"name":"dismissItemReturnRequestWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":3},{"type":"step","name":"dismissItemReturnRequestValidationStep","description":"This step validates that a return request can have its items dismissed.","link":"../core_flows.Order.dismissItemReturnRequestValidationStep/page.mdx","depth":4},{"type":"workflow","name":"createOrderChangeActionsWorkflow","description":"This workflow creates order change actions.","link":"../core_flows.Order.createOrderChangeActionsWorkflow/page.mdx","depth":5},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../core_flows.Order.previewOrderChangeStep/page.mdx","depth":6}]}} />
|
||||
|
||||
## Input
|
||||
|
||||
|
||||
+1
-1
@@ -13,7 +13,7 @@ This workflow adds a new item to a claim.
|
||||
|
||||
## Diagram
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"orderClaimAddNewItemWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":3},{"type":"step","name":"orderClaimAddNewItemValidationStep","description":"This step validates that a new item can be added to the claim.","link":"../core_flows.Order.orderClaimAddNewItemValidationStep/page.mdx","depth":4},{"type":"workflow","name":"addOrderLineItemsWorkflow","description":"This workflow adds line items to an order.","link":"../core_flows.Order.addOrderLineItemsWorkflow/page.mdx","depth":5},{"type":"step","name":"createOrderChangeActionsStep","description":"This step creates order change actions.","link":"../core_flows.Order.createOrderChangeActionsStep/page.mdx","depth":6},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../core_flows.Order.previewOrderChangeStep/page.mdx","depth":7}]}} />
|
||||
<WorkflowDiagram workflow={{"name":"orderClaimAddNewItemWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":3},{"type":"step","name":"orderClaimAddNewItemValidationStep","description":"This step validates that a new item can be added to the claim.","link":"../core_flows.Order.orderClaimAddNewItemValidationStep/page.mdx","depth":4},{"type":"workflow","name":"addOrderLineItemsWorkflow","description":"This workflow adds line items to an order.","link":"../core_flows.Order.addOrderLineItemsWorkflow/page.mdx","depth":5},{"type":"workflow","name":"createOrderChangeActionsWorkflow","description":"This workflow creates order change actions.","link":"../core_flows.Order.createOrderChangeActionsWorkflow/page.mdx","depth":6},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../core_flows.Order.previewOrderChangeStep/page.mdx","depth":7}]}} />
|
||||
|
||||
## Input
|
||||
|
||||
|
||||
+1
-1
@@ -13,7 +13,7 @@ This workflow adds claim items to a claim.
|
||||
|
||||
## Diagram
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"orderClaimItemWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":3},{"type":"step","name":"orderClaimItemValidationStep","description":"This step validates that claim items can be added to a claim.","link":"../core_flows.Order.orderClaimItemValidationStep/page.mdx","depth":4},{"type":"step","name":"createOrderChangeActionsStep","description":"This step creates order change actions.","link":"../core_flows.Order.createOrderChangeActionsStep/page.mdx","depth":5},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../core_flows.Order.previewOrderChangeStep/page.mdx","depth":6}]}} />
|
||||
<WorkflowDiagram workflow={{"name":"orderClaimItemWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":3},{"type":"step","name":"orderClaimItemValidationStep","description":"This step validates that claim items can be added to a claim.","link":"../core_flows.Order.orderClaimItemValidationStep/page.mdx","depth":4},{"type":"workflow","name":"createOrderChangeActionsWorkflow","description":"This workflow creates order change actions.","link":"../core_flows.Order.createOrderChangeActionsWorkflow/page.mdx","depth":5},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../core_flows.Order.previewOrderChangeStep/page.mdx","depth":6}]}} />
|
||||
|
||||
## Input
|
||||
|
||||
|
||||
+1
-1
@@ -13,7 +13,7 @@ This workflow requests one or more items to be returned as part of a claim.
|
||||
|
||||
## Diagram
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"orderClaimRequestItemReturnWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":1},{"type":"when","condition":"{\n return orderClaim.return_id\n }","depth":"2","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":2}]},{"type":"when","condition":"{\n return !orderClaim.return_id\n }","depth":"3","steps":[{"type":"step","name":"createReturnsStep","description":"This step creates returns.","link":"../core_flows.Order.createReturnsStep/page.mdx","depth":3}]},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":4},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":5},{"type":"step","name":"orderClaimRequestItemReturnValidationStep","description":"This step validates that items can be requested to return as part of a claim.","link":"../core_flows.Order.orderClaimRequestItemReturnValidationStep/page.mdx","depth":7},{"type":"step","name":"createOrderChangeActionsStep","description":"This step creates order change actions.","link":"../core_flows.Order.createOrderChangeActionsStep/page.mdx","depth":9},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../core_flows.Order.previewOrderChangeStep/page.mdx","depth":10}]}} />
|
||||
<WorkflowDiagram workflow={{"name":"orderClaimRequestItemReturnWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":1},{"type":"when","condition":"{\n return orderClaim.return_id\n }","depth":"2","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":2}]},{"type":"when","condition":"{\n return !orderClaim.return_id\n }","depth":"3","steps":[{"type":"step","name":"createReturnsStep","description":"This step creates returns.","link":"../core_flows.Order.createReturnsStep/page.mdx","depth":3}]},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":4},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":5},{"type":"step","name":"orderClaimRequestItemReturnValidationStep","description":"This step validates that items can be requested to return as part of a claim.","link":"../core_flows.Order.orderClaimRequestItemReturnValidationStep/page.mdx","depth":7},{"type":"workflow","name":"createOrderChangeActionsWorkflow","description":"This workflow creates order change actions.","link":"../core_flows.Order.createOrderChangeActionsWorkflow/page.mdx","depth":9},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../core_flows.Order.previewOrderChangeStep/page.mdx","depth":10}]}} />
|
||||
|
||||
## Input
|
||||
|
||||
|
||||
+1
-1
@@ -13,7 +13,7 @@ This workflow adds new items to an exchange.
|
||||
|
||||
## Diagram
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"orderExchangeAddNewItemWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":3},{"type":"step","name":"exchangeAddNewItemValidationStep","description":"This step validates that new items can be added to an exchange.","link":"../core_flows.Order.exchangeAddNewItemValidationStep/page.mdx","depth":4},{"type":"workflow","name":"addOrderLineItemsWorkflow","description":"This workflow adds line items to an order.","link":"../core_flows.Order.addOrderLineItemsWorkflow/page.mdx","depth":5},{"type":"step","name":"createOrderChangeActionsStep","description":"This step creates order change actions.","link":"../core_flows.Order.createOrderChangeActionsStep/page.mdx","depth":6},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../core_flows.Order.previewOrderChangeStep/page.mdx","depth":7}]}} />
|
||||
<WorkflowDiagram workflow={{"name":"orderExchangeAddNewItemWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":3},{"type":"step","name":"exchangeAddNewItemValidationStep","description":"This step validates that new items can be added to an exchange.","link":"../core_flows.Order.exchangeAddNewItemValidationStep/page.mdx","depth":4},{"type":"workflow","name":"addOrderLineItemsWorkflow","description":"This workflow adds line items to an order.","link":"../core_flows.Order.addOrderLineItemsWorkflow/page.mdx","depth":5},{"type":"workflow","name":"createOrderChangeActionsWorkflow","description":"This workflow creates order change actions.","link":"../core_flows.Order.createOrderChangeActionsWorkflow/page.mdx","depth":6},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../core_flows.Order.previewOrderChangeStep/page.mdx","depth":7}]}} />
|
||||
|
||||
## Input
|
||||
|
||||
|
||||
+1
-1
@@ -13,7 +13,7 @@ This workflow adds items to be retuned as part of the exchange.
|
||||
|
||||
## Diagram
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"orderExchangeRequestItemReturnWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":1},{"type":"when","condition":"{\n return orderExchange.return_id\n }","depth":"2","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":2}]},{"type":"when","condition":"{\n return !orderExchange.return_id\n }","depth":"3","steps":[{"type":"step","name":"createReturnsStep","description":"This step creates returns.","link":"../core_flows.Order.createReturnsStep/page.mdx","depth":3}]},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":4},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":5},{"type":"step","name":"exchangeRequestItemReturnValidationStep","description":"This step validates that items can be returned as part of an exchange.","link":"../core_flows.Order.exchangeRequestItemReturnValidationStep/page.mdx","depth":6},{"type":"when","condition":"{\n return !orderExchange.return_id\n }","depth":"7","steps":[{"type":"step","name":"updateOrderExchangesStep","description":"This step update order changes.","link":"../core_flows.Order.updateOrderExchangesStep/page.mdx","depth":7}]},{"type":"step","name":"createOrderChangeActionsStep","description":"This step creates order change actions.","link":"../core_flows.Order.createOrderChangeActionsStep/page.mdx","depth":8},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../core_flows.Order.previewOrderChangeStep/page.mdx","depth":9}]}} />
|
||||
<WorkflowDiagram workflow={{"name":"orderExchangeRequestItemReturnWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":1},{"type":"when","condition":"{\n return orderExchange.return_id\n }","depth":"2","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":2}]},{"type":"when","condition":"{\n return !orderExchange.return_id\n }","depth":"3","steps":[{"type":"step","name":"createReturnsStep","description":"This step creates returns.","link":"../core_flows.Order.createReturnsStep/page.mdx","depth":3}]},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":4},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":5},{"type":"step","name":"exchangeRequestItemReturnValidationStep","description":"This step validates that items can be returned as part of an exchange.","link":"../core_flows.Order.exchangeRequestItemReturnValidationStep/page.mdx","depth":6},{"type":"when","condition":"{\n return !orderExchange.return_id\n }","depth":"7","steps":[{"type":"step","name":"updateOrderExchangesStep","description":"This step update order changes.","link":"../core_flows.Order.updateOrderExchangesStep/page.mdx","depth":7}]},{"type":"workflow","name":"createOrderChangeActionsWorkflow","description":"This workflow creates order change actions.","link":"../core_flows.Order.createOrderChangeActionsWorkflow/page.mdx","depth":8},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../core_flows.Order.previewOrderChangeStep/page.mdx","depth":9}]}} />
|
||||
|
||||
## Input
|
||||
|
||||
|
||||
+1
-1
@@ -13,7 +13,7 @@ This workflow marks return items as received.
|
||||
|
||||
## Diagram
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"receiveItemReturnRequestWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":3},{"type":"step","name":"receiveItemReturnRequestValidationStep","description":"This step validates that a return's items can be marked as received.","link":"../core_flows.Order.receiveItemReturnRequestValidationStep/page.mdx","depth":4},{"type":"step","name":"createOrderChangeActionsStep","description":"This step creates order change actions.","link":"../core_flows.Order.createOrderChangeActionsStep/page.mdx","depth":5},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../core_flows.Order.previewOrderChangeStep/page.mdx","depth":6}]}} />
|
||||
<WorkflowDiagram workflow={{"name":"receiveItemReturnRequestWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":3},{"type":"step","name":"receiveItemReturnRequestValidationStep","description":"This step validates that a return's items can be marked as received.","link":"../core_flows.Order.receiveItemReturnRequestValidationStep/page.mdx","depth":4},{"type":"workflow","name":"createOrderChangeActionsWorkflow","description":"This workflow creates order change actions.","link":"../core_flows.Order.createOrderChangeActionsWorkflow/page.mdx","depth":5},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../core_flows.Order.previewOrderChangeStep/page.mdx","depth":6}]}} />
|
||||
|
||||
## Input
|
||||
|
||||
|
||||
+1
-1
@@ -13,7 +13,7 @@ This workflow adds items to a return.
|
||||
|
||||
## Diagram
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"requestItemReturnWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":3},{"type":"step","name":"requestItemReturnValidationStep","description":"This step validates that itens can be added to a return.","link":"../core_flows.Order.requestItemReturnValidationStep/page.mdx","depth":4},{"type":"step","name":"createOrderChangeActionsStep","description":"This step creates order change actions.","link":"../core_flows.Order.createOrderChangeActionsStep/page.mdx","depth":5},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../core_flows.Order.previewOrderChangeStep/page.mdx","depth":6}]}} />
|
||||
<WorkflowDiagram workflow={{"name":"requestItemReturnWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":3},{"type":"step","name":"requestItemReturnValidationStep","description":"This step validates that itens can be added to a return.","link":"../core_flows.Order.requestItemReturnValidationStep/page.mdx","depth":4},{"type":"workflow","name":"createOrderChangeActionsWorkflow","description":"This workflow creates order change actions.","link":"../core_flows.Order.createOrderChangeActionsWorkflow/page.mdx","depth":5},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../core_flows.Order.previewOrderChangeStep/page.mdx","depth":6}]}} />
|
||||
|
||||
## Input
|
||||
|
||||
|
||||
-5
@@ -1,5 +0,0 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# createOrderChangeActionsStepId
|
||||
|
||||
`Const` **createOrderChangeActionsStepId**: `"create-order-change-actions"`
|
||||
+1
-1
@@ -13,7 +13,7 @@ This workflow captures a payment.
|
||||
|
||||
## Diagram
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"capturePaymentWorkflow","steps":[{"type":"step","name":"capturePaymentStep","description":"This step captures a payment.","link":"../core_flows.Payment.capturePaymentStep/page.mdx","depth":1},{"type":"step","name":"emitEventStep","description":"Emit an event.\n\n","link":"../../../Common/functions/core_flows.Common.emitEventStep/page.mdx","depth":2}]}} />
|
||||
<WorkflowDiagram workflow={{"name":"capturePaymentWorkflow","steps":[{"type":"step","name":"capturePaymentStep","description":"This step captures a payment.","link":"../core_flows.Payment.capturePaymentStep/page.mdx","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":2},{"type":"when","condition":"{\n return !!orderPayment?.order?.id\n }","depth":"3","steps":[{"type":"step","name":"addOrderTransactionStep","description":"This step creates an order transaction.","link":"../../../Order/functions/core_flows.Order.addOrderTransactionStep/page.mdx","depth":3}]},{"type":"step","name":"emitEventStep","description":"Emit an event.\n\n","link":"../../../Common/functions/core_flows.Common.emitEventStep/page.mdx","depth":4}]}} />
|
||||
|
||||
## Input
|
||||
|
||||
|
||||
@@ -485,7 +485,6 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
- [deleteClaimsStepId](../../modules/core_flows/page.mdx#deleteclaimsstepid)
|
||||
- [completeOrdersStepId](../../modules/core_flows/page.mdx#completeordersstepid)
|
||||
- [createOrderLineItemsStepId](../../modules/core_flows/page.mdx#createorderlineitemsstepid)
|
||||
- [createOrderChangeActionsStepId](../../modules/core_flows/page.mdx#createorderchangeactionsstepid)
|
||||
- [createOrderChangeStepId](../../modules/core_flows/page.mdx#createorderchangestepid)
|
||||
- [createOrdersStepId](../../modules/core_flows/page.mdx#createordersstepid)
|
||||
- [declineOrderChangeStepId](../../modules/core_flows/page.mdx#declineorderchangestepid)
|
||||
@@ -585,7 +584,6 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
- [deleteClaimsStep](../../modules/core_flows/page.mdx#deleteclaimsstep)
|
||||
- [completeOrdersStep](../../modules/core_flows/page.mdx#completeordersstep)
|
||||
- [createOrderLineItemsStep](../../modules/core_flows/page.mdx#createorderlineitemsstep)
|
||||
- [createOrderChangeActionsStep](../../modules/core_flows/page.mdx#createorderchangeactionsstep)
|
||||
- [createOrderChangeStep](../../modules/core_flows/page.mdx#createorderchangestep)
|
||||
- [createOrdersStep](../../modules/core_flows/page.mdx#createordersstep)
|
||||
- [declineOrderChangeStep](../../modules/core_flows/page.mdx#declineorderchangestep)
|
||||
@@ -803,12 +801,6 @@ ___
|
||||
|
||||
___
|
||||
|
||||
## createOrderChangeActionsStepId
|
||||
|
||||
`Const` **createOrderChangeActionsStepId**: `"create-order-change-actions"`
|
||||
|
||||
___
|
||||
|
||||
## createOrderChangeStepId
|
||||
|
||||
`Const` **createOrderChangeStepId**: `"create-order-change"`
|
||||
@@ -1457,20 +1449,6 @@ This step creates order line items.
|
||||
|
||||
___
|
||||
|
||||
## createOrderChangeActionsStep
|
||||
|
||||
This step creates order change actions.
|
||||
|
||||
### Input
|
||||
|
||||
<TypeList types={[{"name":"CreateOrderChangeActionDTO[]","type":"[CreateOrderChangeActionDTO](../../order/interfaces/order.CreateOrderChangeActionDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"CreateOrderChangeActionDTO","type":"[CreateOrderChangeActionDTO](../../order/interfaces/order.CreateOrderChangeActionDTO/page.mdx)","optional":false,"defaultValue":"","description":"The data of the order change action to be created.","expandable":false,"children":[{"name":"action","type":"[ChangeActionType](../../order/types/order.ChangeActionType/page.mdx)","description":"The type of action.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_change_id","type":"`string`","description":"The associated order change's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The associated claim's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The associated exchange's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order change action.\nOnce the order change action is confirmed, this\nbecomes the order's version.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`string`","description":"The name of the data model that this action\nreferences. For example, `return`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the record references of the data model\nspecified in [reference](../../order/interfaces/order.CreateOrderChangeActionDTO/page.mdx#reference).\n\nFor example, if `reference` is `return`, the `reference_id`\nis the ID of the return.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"The internal note of the order change action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberInput](../../order/types/order.BigNumberInput/page.mdx)","description":"The amount of the order change action.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../order/types/order.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"details","type":"`Record<string, unknown>`","description":"The details of the order change action.\n\nThis could include the returned items or their changed\nquantity, based on the type of this action.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} sectionTitle="createOrderChangeActionsStep"/>
|
||||
|
||||
### Output
|
||||
|
||||
<TypeList types={[{"name":"OrderChangeActionDTO[]","type":"[OrderChangeActionDTO](../../fulfillment/interfaces/fulfillment.OrderChangeActionDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"OrderChangeActionDTO","type":"[OrderChangeActionDTO](../../fulfillment/interfaces/fulfillment.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](../../fulfillment/interfaces/fulfillment.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](../../fulfillment/interfaces/fulfillment.OrderDTO/page.mdx)","description":"The associated order","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"return_order","type":"[ReturnDTO](../../fulfillment/interfaces/fulfillment.ReturnDTO/page.mdx)","description":"The associated return order","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"exchange","type":"[OrderExchangeDTO](../../fulfillment/interfaces/fulfillment.OrderExchangeDTO/page.mdx)","description":"The associated exchange order","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"claim","type":"[OrderClaimDTO](../../fulfillment/interfaces/fulfillment.OrderClaimDTO/page.mdx)","description":"The associated claim order","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"actions","type":"[OrderChangeActionDTO](../../fulfillment/interfaces/fulfillment.OrderChangeActionDTO/page.mdx)[]","description":"The actions of the order change","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"status","type":"`string`","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":"","expLine truncated
|
||||
|
||||
___
|
||||
|
||||
## createOrderChangeStep
|
||||
|
||||
This step creates an order change.
|
||||
@@ -2008,7 +1986,7 @@ This workflow adds a new item to a claim.
|
||||
|
||||
### Diagram
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"orderClaimAddNewItemWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":3},{"type":"step","name":"orderClaimAddNewItemValidationStep","description":"This step validates that a new item can be added to the claim.","link":"../Order/functions/core_flows.Order.orderClaimAddNewItemValidationStep/page.mdx","depth":4},{"type":"workflow","name":"addOrderLineItemsWorkflow","description":"This workflow adds line items to an order.","link":"../Order/functions/core_flows.Order.addOrderLineItemsWorkflow/page.mdx","depth":5},{"type":"step","name":"createOrderChangeActionsStep","description":"This step creates order change actions.","link":"../Order/functions/core_flows.Order.createOrderChangeActionsStep/page.mdx","depth":6},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../Order/functions/core_flows.Order.previewOrderChangeStep/page.mdx","depth":7}]}} />
|
||||
<WorkflowDiagram workflow={{"name":"orderClaimAddNewItemWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":3},{"type":"step","name":"orderClaimAddNewItemValidationStep","description":"This step validates that a new item can be added to the claim.","link":"../Order/functions/core_flows.Order.orderClaimAddNewItemValidationStep/page.mdx","depth":4},{"type":"workflow","name":"addOrderLineItemsWorkflow","description":"This workflow adds line items to an order.","link":"../Order/functions/core_flows.Order.addOrderLineItemsWorkflow/page.mdx","depth":5},{"type":"workflow","name":"createOrderChangeActionsWorkflow","description":"This workflow creates order change actions.","link":"../Order/functions/core_flows.Order.createOrderChangeActionsWorkflow/page.mdx","depth":6},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../Order/functions/core_flows.Order.previewOrderChangeStep/page.mdx","depth":7}]}} />
|
||||
|
||||
### Input
|
||||
|
||||
@@ -2036,7 +2014,7 @@ This workflow adds claim items to a claim.
|
||||
|
||||
### Diagram
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"orderClaimItemWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":3},{"type":"step","name":"orderClaimItemValidationStep","description":"This step validates that claim items can be added to a claim.","link":"../Order/functions/core_flows.Order.orderClaimItemValidationStep/page.mdx","depth":4},{"type":"step","name":"createOrderChangeActionsStep","description":"This step creates order change actions.","link":"../Order/functions/core_flows.Order.createOrderChangeActionsStep/page.mdx","depth":5},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../Order/functions/core_flows.Order.previewOrderChangeStep/page.mdx","depth":6}]}} />
|
||||
<WorkflowDiagram workflow={{"name":"orderClaimItemWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":3},{"type":"step","name":"orderClaimItemValidationStep","description":"This step validates that claim items can be added to a claim.","link":"../Order/functions/core_flows.Order.orderClaimItemValidationStep/page.mdx","depth":4},{"type":"workflow","name":"createOrderChangeActionsWorkflow","description":"This workflow creates order change actions.","link":"../Order/functions/core_flows.Order.createOrderChangeActionsWorkflow/page.mdx","depth":5},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../Order/functions/core_flows.Order.previewOrderChangeStep/page.mdx","depth":6}]}} />
|
||||
|
||||
### Input
|
||||
|
||||
@@ -2064,7 +2042,7 @@ This workflow requests one or more items to be returned as part of a claim.
|
||||
|
||||
### Diagram
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"orderClaimRequestItemReturnWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":1},{"type":"when","condition":"{\n return orderClaim.return_id\n }","depth":"2","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":2}]},{"type":"when","condition":"{\n return !orderClaim.return_id\n }","depth":"3","steps":[{"type":"step","name":"createReturnsStep","description":"This step creates returns.","link":"../Order/functions/core_flows.Order.createReturnsStep/page.mdx","depth":3}]},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":4},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":5},{"type":"step","name":"orderClaimRequestItemReturnValidationStep","description":"This step validates that items can be requested to return as part of a claim.","link":"../Order/functions/core_flows.Order.orderClaimRequestItemReturnValidationStep/page.mdx","depth":7},{"type":"step","name":"createOrderChangeActionsStep","description":"This step creates order change actions.","link":"../Order/functions/core_flows.Order.createOrderChangeActionsStep/page.mdx","depth":9},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../Order/functions/core_flows.Order.previewOrderChangeStep/page.mdx","depth":10}]}} />
|
||||
<WorkflowDiagram workflow={{"name":"orderClaimRequestItemReturnWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":1},{"type":"when","condition":"{\n return orderClaim.return_id\n }","depth":"2","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":2}]},{"type":"when","condition":"{\n return !orderClaim.return_id\n }","depth":"3","steps":[{"type":"step","name":"createReturnsStep","description":"This step creates returns.","link":"../Order/functions/core_flows.Order.createReturnsStep/page.mdx","depth":3}]},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":4},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":5},{"type":"step","name":"orderClaimRequestItemReturnValidationStep","description":"This step validates that items can be requested to return as part of a claim.","link":"../Order/functions/core_flows.Order.orderClaimRequestItemReturnValidationStep/page.mdx","depth":7},{"type":"workflow","name":"createOrderChangeActionsWorkflow","description":"This workflow creates order change actions.","link":"../Order/functions/core_flows.Order.createOrderChangeActionsWorkflow/page.mdx","depth":9},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../Order/functions/core_flows.Order.previewOrderChangeStep/page.mdx","depth":10}]}} />
|
||||
|
||||
### Input
|
||||
|
||||
@@ -2092,7 +2070,7 @@ This workflow confirms a requested claim.
|
||||
|
||||
### Diagram
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"confirmClaimRequestWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":3},{"type":"step","name":"confirmClaimRequestValidationStep","description":"This step validates that a requested claim can be confirmed.","link":"../Order/functions/core_flows.Order.confirmClaimRequestValidationStep/page.mdx","depth":4},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../Order/functions/core_flows.Order.previewOrderChangeStep/page.mdx","depth":5},{"type":"step","name":"createOrderClaimItemsFromActionsStep","description":"This step creates claim items from a change action.","link":"../Order/functions/core_flows.Order.createOrderClaimItemsFromActionsStep/page.mdx","depth":6},{"type":"step","name":"updateReturnsStep","description":"This step updates one or more returns.","link":"../Order/functions/core_flows.Order.updateReturnsStep/page.mdx","depth":7},{"type":"when","condition":"{\n return !!claimShippingMethod\n }","depth":"8","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":8},{"type":"step","name":"reserveInventoryStep","description":"This step reserves the quantity of line items from the associated\nvariant's inventory.","link":"../Definition/functions/core_flows.Definition.reserveInventoryStep/page.mdx","depth":8}]},{"type":"when","condition":"{\n return !!returnShippingMethod\n }","depth":"9","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":9},{"type":"workflow","name":"createReturnFulfillmentWorkflow","description":"This workflow creates a fulfillment for a return.","link":"../Fulfillment/functions/core_flows.Fulfillment.createReturnFulfillmentWorkflow/page.mdx","depth":9},{"type":"step","name":"createRemoteLinkStep","description":"This step creates remote links between two records of linked data models.\n\nLearn more in the [Remote Link documentation.](https://docs.medusajs.com/v2/advanced-development/modules/remote-link#create-link).\n\n","link":"../Common/functions/core_flows.Common.createRemoteLinkStep/page.mdx","depth":9}]}]}} />
|
||||
<WorkflowDiagram workflow={{"name":"confirmClaimRequestWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":3},{"type":"step","name":"confirmClaimRequestValidationStep","description":"This step validates that a requested claim can be confirmed.","link":"../Order/functions/core_flows.Order.confirmClaimRequestValidationStep/page.mdx","depth":4},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../Order/functions/core_flows.Order.previewOrderChangeStep/page.mdx","depth":5},{"type":"step","name":"createOrderClaimItemsFromActionsStep","description":"This step creates claim items from a change action.","link":"../Order/functions/core_flows.Order.createOrderClaimItemsFromActionsStep/page.mdx","depth":6},{"type":"when","condition":"{\n return !!returnId\n }","depth":"7","steps":[{"type":"step","name":"updateReturnsStep","description":"This step updates one or more returns.","link":"../Order/functions/core_flows.Order.updateReturnsStep/page.mdx","depth":7}]},{"type":"when","condition":"{\n return !!claimShippingMethod\n }","depth":"8","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":8},{"type":"step","name":"reserveInventoryStep","description":"This step reserves the quantity of line items from the associated\nvariant's inventory.","link":"../Definition/functions/core_flows.Definition.reserveInventoryStep/page.mdx","depth":8}]},{"type":"when","condition":"{\n return !!returnShippingMethod && !!returnId\n }","depth":"9","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":9},{"type":"workflow","name":"createReturnFulfillmentWorkflow","description":"This workflow creates a fulfillment for a return.","link":"../Fulfillment/functions/core_flows.Fulfillment.createReturnFulfillmentWorkflow/page.mdx","depth":9},{"type":"step","name":"createRemoteLinkStep","description":"This step creates remote links between two records of linked data models.\n\nLearn more in the [Remote Link documentation.](https://docs.medusajs.com/v2/advanced-development/modules/remote-link#create-link).\n\n","link":"../Common/functions/core_flows.Common.createRemoteLinkStep/page.mdx","depth":9}]}]}} />
|
||||
|
||||
### Input
|
||||
|
||||
@@ -2120,7 +2098,7 @@ This workflow creates a shipping method for a claim.
|
||||
|
||||
### Diagram
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"createClaimShippingMethodWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":3},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":4},{"type":"step","name":"createClaimShippingMethodValidationStep","description":"This step confirms that a shipping method can be created for a claim.","link":"../Order/functions/core_flows.Order.createClaimShippingMethodValidationStep/page.mdx","depth":5},{"type":"step","name":"createOrderChangeActionsStep","description":"This step creates order change actions.","link":"../Order/functions/core_flows.Order.createOrderChangeActionsStep/page.mdx","depth":6},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../Order/functions/core_flows.Order.previewOrderChangeStep/page.mdx","depth":7}]}} />
|
||||
<WorkflowDiagram workflow={{"name":"createClaimShippingMethodWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":3},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":4},{"type":"step","name":"createClaimShippingMethodValidationStep","description":"This step confirms that a shipping method can be created for a claim.","link":"../Order/functions/core_flows.Order.createClaimShippingMethodValidationStep/page.mdx","depth":5},{"type":"workflow","name":"createOrderChangeActionsWorkflow","description":"This workflow creates order change actions.","link":"../Order/functions/core_flows.Order.createOrderChangeActionsWorkflow/page.mdx","depth":6},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../Order/functions/core_flows.Order.previewOrderChangeStep/page.mdx","depth":7}]}} />
|
||||
|
||||
### Input
|
||||
|
||||
@@ -2394,10 +2372,6 @@ ___
|
||||
|
||||
This workflow creates order change actions.
|
||||
|
||||
### Diagram
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"createOrderChangeActionsWorkflow","steps":[{"type":"step","name":"createOrderChangeActionsStep","description":"This step creates order change actions.","link":"../Order/functions/core_flows.Order.createOrderChangeActionsStep/page.mdx","depth":1}]}} />
|
||||
|
||||
### Input
|
||||
|
||||
<TypeList types={[{"name":"CreateOrderChangeActionDTO[]","type":"[CreateOrderChangeActionDTO](../../order/interfaces/order.CreateOrderChangeActionDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"CreateOrderChangeActionDTO","type":"[CreateOrderChangeActionDTO](../../order/interfaces/order.CreateOrderChangeActionDTO/page.mdx)","optional":false,"defaultValue":"","description":"The data of the order change action to be created.","expandable":false,"children":[{"name":"action","type":"[ChangeActionType](../../order/types/order.ChangeActionType/page.mdx)","description":"The type of action.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_change_id","type":"`string`","description":"The associated order change's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The associated claim's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The associated exchange's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order change action.\nOnce the order change action is confirmed, this\nbecomes the order's version.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`string`","description":"The name of the data model that this action\nreferences. For example, `return`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the record references of the data model\nspecified in [reference](../../order/interfaces/order.CreateOrderChangeActionDTO/page.mdx#reference).\n\nFor example, if `reference` is `return`, the `reference_id`\nis the ID of the return.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"The internal note of the order change action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberInput](../../order/types/order.BigNumberInput/page.mdx)","description":"The amount of the order change action.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../order/types/order.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"details","type":"`Record<string, unknown>`","description":"The details of the order change action.\n\nThis could include the returned items or their changed\nquantity, based on the type of this action.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} sectionTitle="createOrderChangeActionsWorkflow"/>
|
||||
@@ -2678,7 +2652,7 @@ This workflow creates a shipping method for an exchange.
|
||||
|
||||
### Diagram
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"createExchangeShippingMethodWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":3},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":4},{"type":"step","name":"createExchangeShippingMethodValidationStep","description":"This step validates that a shipping method can be created for an exchange.","link":"../Order/functions/core_flows.Order.createExchangeShippingMethodValidationStep/page.mdx","depth":5},{"type":"step","name":"createOrderChangeActionsStep","description":"This step creates order change actions.","link":"../Order/functions/core_flows.Order.createOrderChangeActionsStep/page.mdx","depth":6},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../Order/functions/core_flows.Order.previewOrderChangeStep/page.mdx","depth":7}]}} />
|
||||
<WorkflowDiagram workflow={{"name":"createExchangeShippingMethodWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":3},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":4},{"type":"step","name":"createExchangeShippingMethodValidationStep","description":"This step validates that a shipping method can be created for an exchange.","link":"../Order/functions/core_flows.Order.createExchangeShippingMethodValidationStep/page.mdx","depth":5},{"type":"workflow","name":"createOrderChangeActionsWorkflow","description":"This workflow creates order change actions.","link":"../Order/functions/core_flows.Order.createOrderChangeActionsWorkflow/page.mdx","depth":6},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../Order/functions/core_flows.Order.previewOrderChangeStep/page.mdx","depth":7}]}} />
|
||||
|
||||
### Input
|
||||
|
||||
@@ -2706,7 +2680,7 @@ This workflow adds new items to an exchange.
|
||||
|
||||
### Diagram
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"orderExchangeAddNewItemWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":3},{"type":"step","name":"exchangeAddNewItemValidationStep","description":"This step validates that new items can be added to an exchange.","link":"../Order/functions/core_flows.Order.exchangeAddNewItemValidationStep/page.mdx","depth":4},{"type":"workflow","name":"addOrderLineItemsWorkflow","description":"This workflow adds line items to an order.","link":"../Order/functions/core_flows.Order.addOrderLineItemsWorkflow/page.mdx","depth":5},{"type":"step","name":"createOrderChangeActionsStep","description":"This step creates order change actions.","link":"../Order/functions/core_flows.Order.createOrderChangeActionsStep/page.mdx","depth":6},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../Order/functions/core_flows.Order.previewOrderChangeStep/page.mdx","depth":7}]}} />
|
||||
<WorkflowDiagram workflow={{"name":"orderExchangeAddNewItemWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":3},{"type":"step","name":"exchangeAddNewItemValidationStep","description":"This step validates that new items can be added to an exchange.","link":"../Order/functions/core_flows.Order.exchangeAddNewItemValidationStep/page.mdx","depth":4},{"type":"workflow","name":"addOrderLineItemsWorkflow","description":"This workflow adds line items to an order.","link":"../Order/functions/core_flows.Order.addOrderLineItemsWorkflow/page.mdx","depth":5},{"type":"workflow","name":"createOrderChangeActionsWorkflow","description":"This workflow creates order change actions.","link":"../Order/functions/core_flows.Order.createOrderChangeActionsWorkflow/page.mdx","depth":6},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../Order/functions/core_flows.Order.previewOrderChangeStep/page.mdx","depth":7}]}} />
|
||||
|
||||
### Input
|
||||
|
||||
@@ -2734,7 +2708,7 @@ This workflow adds items to be retuned as part of the exchange.
|
||||
|
||||
### Diagram
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"orderExchangeRequestItemReturnWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":1},{"type":"when","condition":"{\n return orderExchange.return_id\n }","depth":"2","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":2}]},{"type":"when","condition":"{\n return !orderExchange.return_id\n }","depth":"3","steps":[{"type":"step","name":"createReturnsStep","description":"This step creates returns.","link":"../Order/functions/core_flows.Order.createReturnsStep/page.mdx","depth":3}]},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":4},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":5},{"type":"step","name":"exchangeRequestItemReturnValidationStep","description":"This step validates that items can be returned as part of an exchange.","link":"../Order/functions/core_flows.Order.exchangeRequestItemReturnValidationStep/page.mdx","depth":6},{"type":"when","condition":"{\n return !orderExchange.return_id\n }","depth":"7","steps":[{"type":"step","name":"updateOrderExchangesStep","description":"This step update order changes.","link":"../Order/functions/core_flows.Order.updateOrderExchangesStep/page.mdx","depth":7}]},{"type":"step","name":"createOrderChangeActionsStep","description":"This step creates order change actions.","link":"../Order/functions/core_flows.Order.createOrderChangeActionsStep/page.mdx","depth":8},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../Order/functions/core_flows.Order.previewOrderChangeStep/page.mdx","depth":9}]}} />
|
||||
<WorkflowDiagram workflow={{"name":"orderExchangeRequestItemReturnWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":1},{"type":"when","condition":"{\n return orderExchange.return_id\n }","depth":"2","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":2}]},{"type":"when","condition":"{\n return !orderExchange.return_id\n }","depth":"3","steps":[{"type":"step","name":"createReturnsStep","description":"This step creates returns.","link":"../Order/functions/core_flows.Order.createReturnsStep/page.mdx","depth":3}]},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":4},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":5},{"type":"step","name":"exchangeRequestItemReturnValidationStep","description":"This step validates that items can be returned as part of an exchange.","link":"../Order/functions/core_flows.Order.exchangeRequestItemReturnValidationStep/page.mdx","depth":6},{"type":"when","condition":"{\n return !orderExchange.return_id\n }","depth":"7","steps":[{"type":"step","name":"updateOrderExchangesStep","description":"This step update order changes.","link":"../Order/functions/core_flows.Order.updateOrderExchangesStep/page.mdx","depth":7}]},{"type":"workflow","name":"createOrderChangeActionsWorkflow","description":"This workflow creates order change actions.","link":"../Order/functions/core_flows.Order.createOrderChangeActionsWorkflow/page.mdx","depth":8},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../Order/functions/core_flows.Order.previewOrderChangeStep/page.mdx","depth":9}]}} />
|
||||
|
||||
### Input
|
||||
|
||||
@@ -3118,7 +3092,7 @@ This workflow creates a shipping method for a return.
|
||||
|
||||
### Diagram
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"createReturnShippingMethodWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":3},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":4},{"type":"step","name":"createReturnShippingMethodValidationStep","description":"This step validates that a shipping method can be created for a return.","link":"../Order/functions/core_flows.Order.createReturnShippingMethodValidationStep/page.mdx","depth":5},{"type":"step","name":"createOrderChangeActionsStep","description":"This step creates order change actions.","link":"../Order/functions/core_flows.Order.createOrderChangeActionsStep/page.mdx","depth":6},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../Order/functions/core_flows.Order.previewOrderChangeStep/page.mdx","depth":7}]}} />
|
||||
<WorkflowDiagram workflow={{"name":"createReturnShippingMethodWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":3},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":4},{"type":"step","name":"createReturnShippingMethodValidationStep","description":"This step validates that a shipping method can be created for a return.","link":"../Order/functions/core_flows.Order.createReturnShippingMethodValidationStep/page.mdx","depth":5},{"type":"workflow","name":"createOrderChangeActionsWorkflow","description":"This workflow creates order change actions.","link":"../Order/functions/core_flows.Order.createOrderChangeActionsWorkflow/page.mdx","depth":6},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../Order/functions/core_flows.Order.previewOrderChangeStep/page.mdx","depth":7}]}} />
|
||||
|
||||
### Input
|
||||
|
||||
@@ -3146,7 +3120,7 @@ This workflow dismisses items from a return request.
|
||||
|
||||
### Diagram
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"dismissItemReturnRequestWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":3},{"type":"step","name":"dismissItemReturnRequestValidationStep","description":"This step validates that a return request can have its items dismissed.","link":"../Order/functions/core_flows.Order.dismissItemReturnRequestValidationStep/page.mdx","depth":4},{"type":"step","name":"createOrderChangeActionsStep","description":"This step creates order change actions.","link":"../Order/functions/core_flows.Order.createOrderChangeActionsStep/page.mdx","depth":5},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../Order/functions/core_flows.Order.previewOrderChangeStep/page.mdx","depth":6}]}} />
|
||||
<WorkflowDiagram workflow={{"name":"dismissItemReturnRequestWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":3},{"type":"step","name":"dismissItemReturnRequestValidationStep","description":"This step validates that a return request can have its items dismissed.","link":"../Order/functions/core_flows.Order.dismissItemReturnRequestValidationStep/page.mdx","depth":4},{"type":"workflow","name":"createOrderChangeActionsWorkflow","description":"This workflow creates order change actions.","link":"../Order/functions/core_flows.Order.createOrderChangeActionsWorkflow/page.mdx","depth":5},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../Order/functions/core_flows.Order.previewOrderChangeStep/page.mdx","depth":6}]}} />
|
||||
|
||||
### Input
|
||||
|
||||
@@ -3202,7 +3176,7 @@ This workflow marks return items as received.
|
||||
|
||||
### Diagram
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"receiveItemReturnRequestWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":3},{"type":"step","name":"receiveItemReturnRequestValidationStep","description":"This step validates that a return's items can be marked as received.","link":"../Order/functions/core_flows.Order.receiveItemReturnRequestValidationStep/page.mdx","depth":4},{"type":"step","name":"createOrderChangeActionsStep","description":"This step creates order change actions.","link":"../Order/functions/core_flows.Order.createOrderChangeActionsStep/page.mdx","depth":5},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../Order/functions/core_flows.Order.previewOrderChangeStep/page.mdx","depth":6}]}} />
|
||||
<WorkflowDiagram workflow={{"name":"receiveItemReturnRequestWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":3},{"type":"step","name":"receiveItemReturnRequestValidationStep","description":"This step validates that a return's items can be marked as received.","link":"../Order/functions/core_flows.Order.receiveItemReturnRequestValidationStep/page.mdx","depth":4},{"type":"workflow","name":"createOrderChangeActionsWorkflow","description":"This workflow creates order change actions.","link":"../Order/functions/core_flows.Order.createOrderChangeActionsWorkflow/page.mdx","depth":5},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../Order/functions/core_flows.Order.previewOrderChangeStep/page.mdx","depth":6}]}} />
|
||||
|
||||
### Input
|
||||
|
||||
@@ -3314,7 +3288,7 @@ This workflow adds items to a return.
|
||||
|
||||
### Diagram
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"requestItemReturnWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":3},{"type":"step","name":"requestItemReturnValidationStep","description":"This step validates that itens can be added to a return.","link":"../Order/functions/core_flows.Order.requestItemReturnValidationStep/page.mdx","depth":4},{"type":"step","name":"createOrderChangeActionsStep","description":"This step creates order change actions.","link":"../Order/functions/core_flows.Order.createOrderChangeActionsStep/page.mdx","depth":5},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../Order/functions/core_flows.Order.previewOrderChangeStep/page.mdx","depth":6}]}} />
|
||||
<WorkflowDiagram workflow={{"name":"requestItemReturnWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":3},{"type":"step","name":"requestItemReturnValidationStep","description":"This step validates that itens can be added to a return.","link":"../Order/functions/core_flows.Order.requestItemReturnValidationStep/page.mdx","depth":4},{"type":"workflow","name":"createOrderChangeActionsWorkflow","description":"This workflow creates order change actions.","link":"../Order/functions/core_flows.Order.createOrderChangeActionsWorkflow/page.mdx","depth":5},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../Order/functions/core_flows.Order.previewOrderChangeStep/page.mdx","depth":6}]}} />
|
||||
|
||||
### Input
|
||||
|
||||
|
||||
@@ -161,7 +161,7 @@ This workflow captures a payment.
|
||||
|
||||
### Diagram
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"capturePaymentWorkflow","steps":[{"type":"step","name":"capturePaymentStep","description":"This step captures a payment.","link":"../Payment/functions/core_flows.Payment.capturePaymentStep/page.mdx","depth":1},{"type":"step","name":"emitEventStep","description":"Emit an event.\n\n","link":"../Common/functions/core_flows.Common.emitEventStep/page.mdx","depth":2}]}} />
|
||||
<WorkflowDiagram workflow={{"name":"capturePaymentWorkflow","steps":[{"type":"step","name":"capturePaymentStep","description":"This step captures a payment.","link":"../Payment/functions/core_flows.Payment.capturePaymentStep/page.mdx","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":2},{"type":"when","condition":"{\n return !!orderPayment?.order?.id\n }","depth":"3","steps":[{"type":"step","name":"addOrderTransactionStep","description":"This step creates an order transaction.","link":"../Order/functions/core_flows.Order.addOrderTransactionStep/page.mdx","depth":3}]},{"type":"step","name":"emitEventStep","description":"Emit an event.\n\n","link":"../Common/functions/core_flows.Common.emitEventStep/page.mdx","depth":4}]}} />
|
||||
|
||||
### Input
|
||||
|
||||
|
||||
@@ -448,7 +448,6 @@ import { TypeList } from "docs-ui"
|
||||
- [deleteClaimsStepId](page.mdx#deleteclaimsstepid)
|
||||
- [completeOrdersStepId](page.mdx#completeordersstepid)
|
||||
- [createOrderLineItemsStepId](page.mdx#createorderlineitemsstepid)
|
||||
- [createOrderChangeActionsStepId](page.mdx#createorderchangeactionsstepid)
|
||||
- [createOrderChangeStepId](page.mdx#createorderchangestepid)
|
||||
- [createOrdersStepId](page.mdx#createordersstepid)
|
||||
- [declineOrderChangeStepId](page.mdx#declineorderchangestepid)
|
||||
@@ -899,7 +898,6 @@ import { TypeList } from "docs-ui"
|
||||
- [deleteClaimsStep](page.mdx#deleteclaimsstep)
|
||||
- [completeOrdersStep](page.mdx#completeordersstep)
|
||||
- [createOrderLineItemsStep](page.mdx#createorderlineitemsstep)
|
||||
- [createOrderChangeActionsStep](page.mdx#createorderchangeactionsstep)
|
||||
- [createOrderChangeStep](page.mdx#createorderchangestep)
|
||||
- [createOrdersStep](page.mdx#createordersstep)
|
||||
- [declineOrderChangeStep](page.mdx#declineorderchangestep)
|
||||
@@ -1939,10 +1937,6 @@ ___
|
||||
|
||||
`Const` **createOrderLineItemsStepId**: `"create-order-line-items-step"`
|
||||
|
||||
### createOrderChangeActionsStepId
|
||||
|
||||
`Const` **createOrderChangeActionsStepId**: `"create-order-change-actions"`
|
||||
|
||||
### createOrderChangeStepId
|
||||
|
||||
`Const` **createOrderChangeStepId**: `"create-order-change"`
|
||||
@@ -5457,18 +5451,6 @@ This step creates order line items.
|
||||
|
||||
<TypeList types={[{"name":"OrderLineItemDTO[]","type":"[OrderLineItemDTO](../../fulfillment/interfaces/fulfillment.OrderLineItemDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"OrderLineItemDTO","type":"[OrderLineItemDTO](../../fulfillment/interfaces/fulfillment.OrderLineItemDTO/page.mdx)","optional":false,"defaultValue":"","description":"The line item details.","expandable":false,"children":[{"name":"original_total","type":"[BigNumberValue](../../fulfillment/types/fulfillment.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](../../fulfillment/types/fulfillment.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](../../fulfillment/types/fulfillment.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](../../fulfillment/types/fulfillment.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](../../fulfillment/types/fulfillment.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](../../fulfillment/types/fulfillment.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](../../fulfillment/types/fulfillment.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](../../fulfillment/types/fulfillment.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](../../fulfillment/types/fulfillment.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](../../fulfillment/types/fulfillment.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](../../fulfillment/types/fulfillment.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](../../fulfillment/types/fulfillment.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](../../fulfillment/types/fulfillment.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](../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"",Line truncated
|
||||
|
||||
### createOrderChangeActionsStep
|
||||
|
||||
This step creates order change actions.
|
||||
|
||||
#### Input
|
||||
|
||||
<TypeList types={[{"name":"CreateOrderChangeActionDTO[]","type":"[CreateOrderChangeActionDTO](../../order/interfaces/order.CreateOrderChangeActionDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"CreateOrderChangeActionDTO","type":"[CreateOrderChangeActionDTO](../../order/interfaces/order.CreateOrderChangeActionDTO/page.mdx)","optional":false,"defaultValue":"","description":"The data of the order change action to be created.","expandable":false,"children":[{"name":"action","type":"[ChangeActionType](../../order/types/order.ChangeActionType/page.mdx)","description":"The type of action.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_change_id","type":"`string`","description":"The associated order change's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The associated claim's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The associated exchange's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order change action.\nOnce the order change action is confirmed, this\nbecomes the order's version.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`string`","description":"The name of the data model that this action\nreferences. For example, `return`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the record references of the data model\nspecified in [reference](../../order/interfaces/order.CreateOrderChangeActionDTO/page.mdx#reference).\n\nFor example, if `reference` is `return`, the `reference_id`\nis the ID of the return.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"The internal note of the order change action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberInput](../../order/types/order.BigNumberInput/page.mdx)","description":"The amount of the order change action.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../order/types/order.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"details","type":"`Record<string, unknown>`","description":"The details of the order change action.\n\nThis could include the returned items or their changed\nquantity, based on the type of this action.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} sectionTitle="createOrderChangeActionsStep"/>
|
||||
|
||||
#### Output
|
||||
|
||||
<TypeList types={[{"name":"OrderChangeActionDTO[]","type":"[OrderChangeActionDTO](../../fulfillment/interfaces/fulfillment.OrderChangeActionDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"OrderChangeActionDTO","type":"[OrderChangeActionDTO](../../fulfillment/interfaces/fulfillment.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](../../fulfillment/interfaces/fulfillment.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](../../fulfillment/interfaces/fulfillment.OrderDTO/page.mdx)","description":"The associated order","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"return_order","type":"[ReturnDTO](../../fulfillment/interfaces/fulfillment.ReturnDTO/page.mdx)","description":"The associated return order","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"exchange","type":"[OrderExchangeDTO](../../fulfillment/interfaces/fulfillment.OrderExchangeDTO/page.mdx)","description":"The associated exchange order","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"claim","type":"[OrderClaimDTO](../../fulfillment/interfaces/fulfillment.OrderClaimDTO/page.mdx)","description":"The associated claim order","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"actions","type":"[OrderChangeActionDTO](../../fulfillment/interfaces/fulfillment.OrderChangeActionDTO/page.mdx)[]","description":"The actions of the order change","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"status","type":"`string`","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":"","expLine truncated
|
||||
|
||||
### createOrderChangeStep
|
||||
|
||||
This step creates an order change.
|
||||
@@ -5928,7 +5910,7 @@ This workflow adds a new item to a claim.
|
||||
|
||||
#### Diagram
|
||||
|
||||
<undefined workflow={{"name":"orderClaimAddNewItemWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":3},{"type":"step","name":"orderClaimAddNewItemValidationStep","description":"This step validates that a new item can be added to the claim.","link":"../../core_flows/Order/functions/core_flows.Order.orderClaimAddNewItemValidationStep/page.mdx","depth":4},{"type":"workflow","name":"addOrderLineItemsWorkflow","description":"This workflow adds line items to an order.","link":"../../core_flows/Order/functions/core_flows.Order.addOrderLineItemsWorkflow/page.mdx","depth":5},{"type":"step","name":"createOrderChangeActionsStep","description":"This step creates order change actions.","link":"../../core_flows/Order/functions/core_flows.Order.createOrderChangeActionsStep/page.mdx","depth":6},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/Order/functions/core_flows.Order.previewOrderChangeStep/page.mdx","depth":7}]}} />
|
||||
<undefined workflow={{"name":"orderClaimAddNewItemWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":3},{"type":"step","name":"orderClaimAddNewItemValidationStep","description":"This step validates that a new item can be added to the claim.","link":"../../core_flows/Order/functions/core_flows.Order.orderClaimAddNewItemValidationStep/page.mdx","depth":4},{"type":"workflow","name":"addOrderLineItemsWorkflow","description":"This workflow adds line items to an order.","link":"../../core_flows/Order/functions/core_flows.Order.addOrderLineItemsWorkflow/page.mdx","depth":5},{"type":"workflow","name":"createOrderChangeActionsWorkflow","description":"This workflow creates order change actions.","link":"../../core_flows/Order/functions/core_flows.Order.createOrderChangeActionsWorkflow/page.mdx","depth":6},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/Order/functions/core_flows.Order.previewOrderChangeStep/page.mdx","depth":7}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -5952,7 +5934,7 @@ This workflow adds claim items to a claim.
|
||||
|
||||
#### Diagram
|
||||
|
||||
<undefined workflow={{"name":"orderClaimItemWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":3},{"type":"step","name":"orderClaimItemValidationStep","description":"This step validates that claim items can be added to a claim.","link":"../../core_flows/Order/functions/core_flows.Order.orderClaimItemValidationStep/page.mdx","depth":4},{"type":"step","name":"createOrderChangeActionsStep","description":"This step creates order change actions.","link":"../../core_flows/Order/functions/core_flows.Order.createOrderChangeActionsStep/page.mdx","depth":5},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/Order/functions/core_flows.Order.previewOrderChangeStep/page.mdx","depth":6}]}} />
|
||||
<undefined workflow={{"name":"orderClaimItemWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":3},{"type":"step","name":"orderClaimItemValidationStep","description":"This step validates that claim items can be added to a claim.","link":"../../core_flows/Order/functions/core_flows.Order.orderClaimItemValidationStep/page.mdx","depth":4},{"type":"workflow","name":"createOrderChangeActionsWorkflow","description":"This workflow creates order change actions.","link":"../../core_flows/Order/functions/core_flows.Order.createOrderChangeActionsWorkflow/page.mdx","depth":5},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/Order/functions/core_flows.Order.previewOrderChangeStep/page.mdx","depth":6}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -5976,7 +5958,7 @@ This workflow requests one or more items to be returned as part of a claim.
|
||||
|
||||
#### Diagram
|
||||
|
||||
<undefined workflow={{"name":"orderClaimRequestItemReturnWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":1},{"type":"when","condition":"{\n return orderClaim.return_id\n }","depth":"2","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":2}]},{"type":"when","condition":"{\n return !orderClaim.return_id\n }","depth":"3","steps":[{"type":"step","name":"createReturnsStep","description":"This step creates returns.","link":"../../core_flows/Order/functions/core_flows.Order.createReturnsStep/page.mdx","depth":3}]},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":4},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":5},{"type":"step","name":"orderClaimRequestItemReturnValidationStep","description":"This step validates that items can be requested to return as part of a claim.","link":"../../core_flows/Order/functions/core_flows.Order.orderClaimRequestItemReturnValidationStep/page.mdx","depth":7},{"type":"step","name":"createOrderChangeActionsStep","description":"This step creates order change actions.","link":"../../core_flows/Order/functions/core_flows.Order.createOrderChangeActionsStep/page.mdx","depth":9},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/Order/functions/core_flows.Order.previewOrderChangeStep/page.mdx","depth":10}]}} />
|
||||
<undefined workflow={{"name":"orderClaimRequestItemReturnWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":1},{"type":"when","condition":"{\n return orderClaim.return_id\n }","depth":"2","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":2}]},{"type":"when","condition":"{\n return !orderClaim.return_id\n }","depth":"3","steps":[{"type":"step","name":"createReturnsStep","description":"This step creates returns.","link":"../../core_flows/Order/functions/core_flows.Order.createReturnsStep/page.mdx","depth":3}]},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":4},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":5},{"type":"step","name":"orderClaimRequestItemReturnValidationStep","description":"This step validates that items can be requested to return as part of a claim.","link":"../../core_flows/Order/functions/core_flows.Order.orderClaimRequestItemReturnValidationStep/page.mdx","depth":7},{"type":"workflow","name":"createOrderChangeActionsWorkflow","description":"This workflow creates order change actions.","link":"../../core_flows/Order/functions/core_flows.Order.createOrderChangeActionsWorkflow/page.mdx","depth":9},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/Order/functions/core_flows.Order.previewOrderChangeStep/page.mdx","depth":10}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -6000,7 +5982,7 @@ This workflow confirms a requested claim.
|
||||
|
||||
#### Diagram
|
||||
|
||||
<undefined workflow={{"name":"confirmClaimRequestWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":3},{"type":"step","name":"confirmClaimRequestValidationStep","description":"This step validates that a requested claim can be confirmed.","link":"../../core_flows/Order/functions/core_flows.Order.confirmClaimRequestValidationStep/page.mdx","depth":4},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/Order/functions/core_flows.Order.previewOrderChangeStep/page.mdx","depth":5},{"type":"step","name":"createOrderClaimItemsFromActionsStep","description":"This step creates claim items from a change action.","link":"../../core_flows/Order/functions/core_flows.Order.createOrderClaimItemsFromActionsStep/page.mdx","depth":6},{"type":"step","name":"updateReturnsStep","description":"This step updates one or more returns.","link":"../../core_flows/Order/functions/core_flows.Order.updateReturnsStep/page.mdx","depth":7},{"type":"when","condition":"{\n return !!claimShippingMethod\n }","depth":"8","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":8},{"type":"step","name":"reserveInventoryStep","description":"This step reserves the quantity of line items from the associated\nvariant's inventory.","link":"../../core_flows/Definition/functions/core_flows.Definition.reserveInventoryStep/page.mdx","depth":8}]},{"type":"when","condition":"{\n return !!returnShippingMethod\n }","depth":"9","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":9},{"type":"workflow","name":"createReturnFulfillmentWorkflow","description":"This workflow creates a fulfillment for a return.","link":"../../core_flows/Fulfillment/functions/core_flows.Fulfillment.createReturnFulfillmentWorkflow/page.mdx","depth":9},{"type":"step","name":"createRemoteLinkStep","description":"This step creates remote links between two records of linked data models.\n\nLearn more in the [Remote Link documentation.](https://docs.medusajs.com/v2/advanced-development/modules/remote-link#create-link).\n\n","link":"../../core_flows/Common/functions/core_flows.Common.createRemoteLinkStep/page.mdx","depth":9}]}]}} />
|
||||
<undefined workflow={{"name":"confirmClaimRequestWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":3},{"type":"step","name":"confirmClaimRequestValidationStep","description":"This step validates that a requested claim can be confirmed.","link":"../../core_flows/Order/functions/core_flows.Order.confirmClaimRequestValidationStep/page.mdx","depth":4},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/Order/functions/core_flows.Order.previewOrderChangeStep/page.mdx","depth":5},{"type":"step","name":"createOrderClaimItemsFromActionsStep","description":"This step creates claim items from a change action.","link":"../../core_flows/Order/functions/core_flows.Order.createOrderClaimItemsFromActionsStep/page.mdx","depth":6},{"type":"when","condition":"{\n return !!returnId\n }","depth":"7","steps":[{"type":"step","name":"updateReturnsStep","description":"This step updates one or more returns.","link":"../../core_flows/Order/functions/core_flows.Order.updateReturnsStep/page.mdx","depth":7}]},{"type":"when","condition":"{\n return !!claimShippingMethod\n }","depth":"8","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":8},{"type":"step","name":"reserveInventoryStep","description":"This step reserves the quantity of line items from the associated\nvariant's inventory.","link":"../../core_flows/Definition/functions/core_flows.Definition.reserveInventoryStep/page.mdx","depth":8}]},{"type":"when","condition":"{\n return !!returnShippingMethod && !!returnId\n }","depth":"9","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":9},{"type":"workflow","name":"createReturnFulfillmentWorkflow","description":"This workflow creates a fulfillment for a return.","link":"../../core_flows/Fulfillment/functions/core_flows.Fulfillment.createReturnFulfillmentWorkflow/page.mdx","depth":9},{"type":"step","name":"createRemoteLinkStep","description":"This step creates remote links between two records of linked data models.\n\nLearn more in the [Remote Link documentation.](https://docs.medusajs.com/v2/advanced-development/modules/remote-link#create-link).\n\n","link":"../../core_flows/Common/functions/core_flows.Common.createRemoteLinkStep/page.mdx","depth":9}]}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -6024,7 +6006,7 @@ This workflow creates a shipping method for a claim.
|
||||
|
||||
#### Diagram
|
||||
|
||||
<undefined workflow={{"name":"createClaimShippingMethodWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":3},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":4},{"type":"step","name":"createClaimShippingMethodValidationStep","description":"This step confirms that a shipping method can be created for a claim.","link":"../../core_flows/Order/functions/core_flows.Order.createClaimShippingMethodValidationStep/page.mdx","depth":5},{"type":"step","name":"createOrderChangeActionsStep","description":"This step creates order change actions.","link":"../../core_flows/Order/functions/core_flows.Order.createOrderChangeActionsStep/page.mdx","depth":6},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/Order/functions/core_flows.Order.previewOrderChangeStep/page.mdx","depth":7}]}} />
|
||||
<undefined workflow={{"name":"createClaimShippingMethodWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":3},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":4},{"type":"step","name":"createClaimShippingMethodValidationStep","description":"This step confirms that a shipping method can be created for a claim.","link":"../../core_flows/Order/functions/core_flows.Order.createClaimShippingMethodValidationStep/page.mdx","depth":5},{"type":"workflow","name":"createOrderChangeActionsWorkflow","description":"This workflow creates order change actions.","link":"../../core_flows/Order/functions/core_flows.Order.createOrderChangeActionsWorkflow/page.mdx","depth":6},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/Order/functions/core_flows.Order.previewOrderChangeStep/page.mdx","depth":7}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -6266,10 +6248,6 @@ Handlers consuming this hook accept the following input.
|
||||
|
||||
This workflow creates order change actions.
|
||||
|
||||
#### Diagram
|
||||
|
||||
<undefined workflow={{"name":"createOrderChangeActionsWorkflow","steps":[{"type":"step","name":"createOrderChangeActionsStep","description":"This step creates order change actions.","link":"../../core_flows/Order/functions/core_flows.Order.createOrderChangeActionsStep/page.mdx","depth":1}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
<TypeList types={[{"name":"CreateOrderChangeActionDTO[]","type":"[CreateOrderChangeActionDTO](../../order/interfaces/order.CreateOrderChangeActionDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"CreateOrderChangeActionDTO","type":"[CreateOrderChangeActionDTO](../../order/interfaces/order.CreateOrderChangeActionDTO/page.mdx)","optional":false,"defaultValue":"","description":"The data of the order change action to be created.","expandable":false,"children":[{"name":"action","type":"[ChangeActionType](../../order/types/order.ChangeActionType/page.mdx)","description":"The type of action.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_change_id","type":"`string`","description":"The associated order change's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The associated claim's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The associated exchange's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order change action.\nOnce the order change action is confirmed, this\nbecomes the order's version.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`string`","description":"The name of the data model that this action\nreferences. For example, `return`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the record references of the data model\nspecified in [reference](../../order/interfaces/order.CreateOrderChangeActionDTO/page.mdx#reference).\n\nFor example, if `reference` is `return`, the `reference_id`\nis the ID of the return.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"The internal note of the order change action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberInput](../../order/types/order.BigNumberInput/page.mdx)","description":"The amount of the order change action.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../order/types/order.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"details","type":"`Record<string, unknown>`","description":"The details of the order change action.\n\nThis could include the returned items or their changed\nquantity, based on the type of this action.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} sectionTitle="createOrderChangeActionsWorkflow"/>
|
||||
@@ -6516,7 +6494,7 @@ This workflow creates a shipping method for an exchange.
|
||||
|
||||
#### Diagram
|
||||
|
||||
<undefined workflow={{"name":"createExchangeShippingMethodWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":3},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":4},{"type":"step","name":"createExchangeShippingMethodValidationStep","description":"This step validates that a shipping method can be created for an exchange.","link":"../../core_flows/Order/functions/core_flows.Order.createExchangeShippingMethodValidationStep/page.mdx","depth":5},{"type":"step","name":"createOrderChangeActionsStep","description":"This step creates order change actions.","link":"../../core_flows/Order/functions/core_flows.Order.createOrderChangeActionsStep/page.mdx","depth":6},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/Order/functions/core_flows.Order.previewOrderChangeStep/page.mdx","depth":7}]}} />
|
||||
<undefined workflow={{"name":"createExchangeShippingMethodWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":3},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":4},{"type":"step","name":"createExchangeShippingMethodValidationStep","description":"This step validates that a shipping method can be created for an exchange.","link":"../../core_flows/Order/functions/core_flows.Order.createExchangeShippingMethodValidationStep/page.mdx","depth":5},{"type":"workflow","name":"createOrderChangeActionsWorkflow","description":"This workflow creates order change actions.","link":"../../core_flows/Order/functions/core_flows.Order.createOrderChangeActionsWorkflow/page.mdx","depth":6},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/Order/functions/core_flows.Order.previewOrderChangeStep/page.mdx","depth":7}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -6540,7 +6518,7 @@ This workflow adds new items to an exchange.
|
||||
|
||||
#### Diagram
|
||||
|
||||
<undefined workflow={{"name":"orderExchangeAddNewItemWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":3},{"type":"step","name":"exchangeAddNewItemValidationStep","description":"This step validates that new items can be added to an exchange.","link":"../../core_flows/Order/functions/core_flows.Order.exchangeAddNewItemValidationStep/page.mdx","depth":4},{"type":"workflow","name":"addOrderLineItemsWorkflow","description":"This workflow adds line items to an order.","link":"../../core_flows/Order/functions/core_flows.Order.addOrderLineItemsWorkflow/page.mdx","depth":5},{"type":"step","name":"createOrderChangeActionsStep","description":"This step creates order change actions.","link":"../../core_flows/Order/functions/core_flows.Order.createOrderChangeActionsStep/page.mdx","depth":6},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/Order/functions/core_flows.Order.previewOrderChangeStep/page.mdx","depth":7}]}} />
|
||||
<undefined workflow={{"name":"orderExchangeAddNewItemWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":3},{"type":"step","name":"exchangeAddNewItemValidationStep","description":"This step validates that new items can be added to an exchange.","link":"../../core_flows/Order/functions/core_flows.Order.exchangeAddNewItemValidationStep/page.mdx","depth":4},{"type":"workflow","name":"addOrderLineItemsWorkflow","description":"This workflow adds line items to an order.","link":"../../core_flows/Order/functions/core_flows.Order.addOrderLineItemsWorkflow/page.mdx","depth":5},{"type":"workflow","name":"createOrderChangeActionsWorkflow","description":"This workflow creates order change actions.","link":"../../core_flows/Order/functions/core_flows.Order.createOrderChangeActionsWorkflow/page.mdx","depth":6},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/Order/functions/core_flows.Order.previewOrderChangeStep/page.mdx","depth":7}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -6564,7 +6542,7 @@ This workflow adds items to be retuned as part of the exchange.
|
||||
|
||||
#### Diagram
|
||||
|
||||
<undefined workflow={{"name":"orderExchangeRequestItemReturnWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":1},{"type":"when","condition":"{\n return orderExchange.return_id\n }","depth":"2","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":2}]},{"type":"when","condition":"{\n return !orderExchange.return_id\n }","depth":"3","steps":[{"type":"step","name":"createReturnsStep","description":"This step creates returns.","link":"../../core_flows/Order/functions/core_flows.Order.createReturnsStep/page.mdx","depth":3}]},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":4},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":5},{"type":"step","name":"exchangeRequestItemReturnValidationStep","description":"This step validates that items can be returned as part of an exchange.","link":"../../core_flows/Order/functions/core_flows.Order.exchangeRequestItemReturnValidationStep/page.mdx","depth":6},{"type":"when","condition":"{\n return !orderExchange.return_id\n }","depth":"7","steps":[{"type":"step","name":"updateOrderExchangesStep","description":"This step update order changes.","link":"../../core_flows/Order/functions/core_flows.Order.updateOrderExchangesStep/page.mdx","depth":7}]},{"type":"step","name":"createOrderChangeActionsStep","description":"This step creates order change actions.","link":"../../core_flows/Order/functions/core_flows.Order.createOrderChangeActionsStep/page.mdx","depth":8},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/Order/functions/core_flows.Order.previewOrderChangeStep/page.mdx","depth":9}]}} />
|
||||
<undefined workflow={{"name":"orderExchangeRequestItemReturnWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":1},{"type":"when","condition":"{\n return orderExchange.return_id\n }","depth":"2","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":2}]},{"type":"when","condition":"{\n return !orderExchange.return_id\n }","depth":"3","steps":[{"type":"step","name":"createReturnsStep","description":"This step creates returns.","link":"../../core_flows/Order/functions/core_flows.Order.createReturnsStep/page.mdx","depth":3}]},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":4},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":5},{"type":"step","name":"exchangeRequestItemReturnValidationStep","description":"This step validates that items can be returned as part of an exchange.","link":"../../core_flows/Order/functions/core_flows.Order.exchangeRequestItemReturnValidationStep/page.mdx","depth":6},{"type":"when","condition":"{\n return !orderExchange.return_id\n }","depth":"7","steps":[{"type":"step","name":"updateOrderExchangesStep","description":"This step update order changes.","link":"../../core_flows/Order/functions/core_flows.Order.updateOrderExchangesStep/page.mdx","depth":7}]},{"type":"workflow","name":"createOrderChangeActionsWorkflow","description":"This workflow creates order change actions.","link":"../../core_flows/Order/functions/core_flows.Order.createOrderChangeActionsWorkflow/page.mdx","depth":8},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/Order/functions/core_flows.Order.previewOrderChangeStep/page.mdx","depth":9}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -6892,7 +6870,7 @@ This workflow creates a shipping method for a return.
|
||||
|
||||
#### Diagram
|
||||
|
||||
<undefined workflow={{"name":"createReturnShippingMethodWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":3},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":4},{"type":"step","name":"createReturnShippingMethodValidationStep","description":"This step validates that a shipping method can be created for a return.","link":"../../core_flows/Order/functions/core_flows.Order.createReturnShippingMethodValidationStep/page.mdx","depth":5},{"type":"step","name":"createOrderChangeActionsStep","description":"This step creates order change actions.","link":"../../core_flows/Order/functions/core_flows.Order.createOrderChangeActionsStep/page.mdx","depth":6},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/Order/functions/core_flows.Order.previewOrderChangeStep/page.mdx","depth":7}]}} />
|
||||
<undefined workflow={{"name":"createReturnShippingMethodWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":3},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":4},{"type":"step","name":"createReturnShippingMethodValidationStep","description":"This step validates that a shipping method can be created for a return.","link":"../../core_flows/Order/functions/core_flows.Order.createReturnShippingMethodValidationStep/page.mdx","depth":5},{"type":"workflow","name":"createOrderChangeActionsWorkflow","description":"This workflow creates order change actions.","link":"../../core_flows/Order/functions/core_flows.Order.createOrderChangeActionsWorkflow/page.mdx","depth":6},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/Order/functions/core_flows.Order.previewOrderChangeStep/page.mdx","depth":7}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -6916,7 +6894,7 @@ This workflow dismisses items from a return request.
|
||||
|
||||
#### Diagram
|
||||
|
||||
<undefined workflow={{"name":"dismissItemReturnRequestWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":3},{"type":"step","name":"dismissItemReturnRequestValidationStep","description":"This step validates that a return request can have its items dismissed.","link":"../../core_flows/Order/functions/core_flows.Order.dismissItemReturnRequestValidationStep/page.mdx","depth":4},{"type":"step","name":"createOrderChangeActionsStep","description":"This step creates order change actions.","link":"../../core_flows/Order/functions/core_flows.Order.createOrderChangeActionsStep/page.mdx","depth":5},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/Order/functions/core_flows.Order.previewOrderChangeStep/page.mdx","depth":6}]}} />
|
||||
<undefined workflow={{"name":"dismissItemReturnRequestWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":3},{"type":"step","name":"dismissItemReturnRequestValidationStep","description":"This step validates that a return request can have its items dismissed.","link":"../../core_flows/Order/functions/core_flows.Order.dismissItemReturnRequestValidationStep/page.mdx","depth":4},{"type":"workflow","name":"createOrderChangeActionsWorkflow","description":"This workflow creates order change actions.","link":"../../core_flows/Order/functions/core_flows.Order.createOrderChangeActionsWorkflow/page.mdx","depth":5},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/Order/functions/core_flows.Order.previewOrderChangeStep/page.mdx","depth":6}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -6964,7 +6942,7 @@ This workflow marks return items as received.
|
||||
|
||||
#### Diagram
|
||||
|
||||
<undefined workflow={{"name":"receiveItemReturnRequestWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":3},{"type":"step","name":"receiveItemReturnRequestValidationStep","description":"This step validates that a return's items can be marked as received.","link":"../../core_flows/Order/functions/core_flows.Order.receiveItemReturnRequestValidationStep/page.mdx","depth":4},{"type":"step","name":"createOrderChangeActionsStep","description":"This step creates order change actions.","link":"../../core_flows/Order/functions/core_flows.Order.createOrderChangeActionsStep/page.mdx","depth":5},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/Order/functions/core_flows.Order.previewOrderChangeStep/page.mdx","depth":6}]}} />
|
||||
<undefined workflow={{"name":"receiveItemReturnRequestWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":3},{"type":"step","name":"receiveItemReturnRequestValidationStep","description":"This step validates that a return's items can be marked as received.","link":"../../core_flows/Order/functions/core_flows.Order.receiveItemReturnRequestValidationStep/page.mdx","depth":4},{"type":"workflow","name":"createOrderChangeActionsWorkflow","description":"This workflow creates order change actions.","link":"../../core_flows/Order/functions/core_flows.Order.createOrderChangeActionsWorkflow/page.mdx","depth":5},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/Order/functions/core_flows.Order.previewOrderChangeStep/page.mdx","depth":6}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -7060,7 +7038,7 @@ This workflow adds items to a return.
|
||||
|
||||
#### Diagram
|
||||
|
||||
<undefined workflow={{"name":"requestItemReturnWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":3},{"type":"step","name":"requestItemReturnValidationStep","description":"This step validates that itens can be added to a return.","link":"../../core_flows/Order/functions/core_flows.Order.requestItemReturnValidationStep/page.mdx","depth":4},{"type":"step","name":"createOrderChangeActionsStep","description":"This step creates order change actions.","link":"../../core_flows/Order/functions/core_flows.Order.createOrderChangeActionsStep/page.mdx","depth":5},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/Order/functions/core_flows.Order.previewOrderChangeStep/page.mdx","depth":6}]}} />
|
||||
<undefined workflow={{"name":"requestItemReturnWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":3},{"type":"step","name":"requestItemReturnValidationStep","description":"This step validates that itens can be added to a return.","link":"../../core_flows/Order/functions/core_flows.Order.requestItemReturnValidationStep/page.mdx","depth":4},{"type":"workflow","name":"createOrderChangeActionsWorkflow","description":"This workflow creates order change actions.","link":"../../core_flows/Order/functions/core_flows.Order.createOrderChangeActionsWorkflow/page.mdx","depth":5},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/Order/functions/core_flows.Order.previewOrderChangeStep/page.mdx","depth":6}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -7387,7 +7365,7 @@ This workflow captures a payment.
|
||||
|
||||
#### Diagram
|
||||
|
||||
<undefined workflow={{"name":"capturePaymentWorkflow","steps":[{"type":"step","name":"capturePaymentStep","description":"This step captures a payment.","link":"../../core_flows/Payment/functions/core_flows.Payment.capturePaymentStep/page.mdx","depth":1},{"type":"step","name":"emitEventStep","description":"Emit an event.\n\n","link":"../../core_flows/Common/functions/core_flows.Common.emitEventStep/page.mdx","depth":2}]}} />
|
||||
<undefined workflow={{"name":"capturePaymentWorkflow","steps":[{"type":"step","name":"capturePaymentStep","description":"This step captures a payment.","link":"../../core_flows/Payment/functions/core_flows.Payment.capturePaymentStep/page.mdx","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/Common/functions/core_flows.Common.useRemoteQueryStep/page.mdx","depth":2},{"type":"when","condition":"{\n return !!orderPayment?.order?.id\n }","depth":"3","steps":[{"type":"step","name":"addOrderTransactionStep","description":"This step creates an order transaction.","link":"../../core_flows/Order/functions/core_flows.Order.addOrderTransactionStep/page.mdx","depth":3}]},{"type":"step","name":"emitEventStep","description":"Emit an event.\n\n","link":"../../core_flows/Common/functions/core_flows.Common.emitEventStep/page.mdx","depth":4}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
|
||||
+1
-1
@@ -4,4 +4,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"order_preview","type":"[OrderDTO](../../../../fulfillment/interfaces/fulfillment.OrderDTO/page.mdx)","description":"","optional":false,"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":"status","type":"[OrderStatus](../../../../fulfillment/types/fulfillment.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":"original_item_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"originalLine truncated
|
||||
<TypeList types={[{"name":"order_preview","type":"[OrderDTO](../../../../fulfillment/interfaces/fulfillment.OrderDTO/page.mdx)","description":"","optional":false,"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":"status","type":"[OrderStatus](../../../../fulfillment/types/fulfillment.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":"original_item_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"originalLine truncated
|
||||
+1
-1
@@ -4,4 +4,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"order_preview","type":"[OrderDTO](../../../../fulfillment/interfaces/fulfillment.OrderDTO/page.mdx)","description":"","optional":false,"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":"status","type":"[OrderStatus](../../../../fulfillment/types/fulfillment.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":"original_item_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"originalLine truncated
|
||||
<TypeList types={[{"name":"order_preview","type":"[OrderDTO](../../../../fulfillment/interfaces/fulfillment.OrderDTO/page.mdx)","description":"","optional":false,"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":"status","type":"[OrderStatus](../../../../fulfillment/types/fulfillment.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":"original_item_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"originalLine truncated
|
||||
+1
-1
@@ -4,4 +4,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_items","type":"[AdminReturnItem](../types.HttpTypes.AdminReturnItem/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"received_quantity","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reason_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"note","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_items","type":"[BaseExchangeItem](../../../interfaces/types.BaseExchangeItem/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"no_notification","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"difference_due","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return","type":"[AdminReturn](../types.HttpTypes.AdminReturn/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_version","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[BaseReturnItem](../../../interfaces/types.BaseReturnItem/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"received_quantity","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reason_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"note","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"status","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}Line truncated
|
||||
<TypeList types={[{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_items","type":"[AdminReturnItem](../types.HttpTypes.AdminReturnItem/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"received_quantity","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reason_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"note","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_items","type":"[BaseExchangeItem](../../../interfaces/types.BaseExchangeItem/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"no_notification","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"difference_due","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return","type":"[AdminReturn](../types.HttpTypes.AdminReturn/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_version","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[BaseReturnItem](../../../interfaces/types.BaseReturnItem/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"received_quantity","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reason_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"note","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"received_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]Line truncated
|
||||
+1
-1
@@ -4,4 +4,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"order","type":"[OrderDTO](../../../../fulfillment/interfaces/fulfillment.OrderDTO/page.mdx)","description":"","optional":false,"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":"status","type":"[OrderStatus](../../../../fulfillment/types/fulfillment.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":"original_item_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"original_total",Line truncated
|
||||
<TypeList types={[{"name":"order","type":"[OrderDTO](../../../../fulfillment/interfaces/fulfillment.OrderDTO/page.mdx)","description":"","optional":false,"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":"status","type":"[OrderStatus](../../../../fulfillment/types/fulfillment.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":"original_item_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"original_total",Line truncated
|
||||
+1
-1
@@ -4,4 +4,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"order_preview","type":"[OrderDTO](../../../../fulfillment/interfaces/fulfillment.OrderDTO/page.mdx)","description":"","optional":false,"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":"status","type":"[OrderStatus](../../../../fulfillment/types/fulfillment.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":"original_item_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"originalLine truncated
|
||||
<TypeList types={[{"name":"order_preview","type":"[OrderDTO](../../../../fulfillment/interfaces/fulfillment.OrderDTO/page.mdx)","description":"","optional":false,"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":"status","type":"[OrderStatus](../../../../fulfillment/types/fulfillment.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":"original_item_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"originalLine truncated
|
||||
+1
-1
@@ -4,4 +4,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"order_preview","type":"[OrderDTO](../../../../fulfillment/interfaces/fulfillment.OrderDTO/page.mdx)","description":"","optional":false,"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":"status","type":"[OrderStatus](../../../../fulfillment/types/fulfillment.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":"original_item_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"originalLine truncated
|
||||
<TypeList types={[{"name":"order_preview","type":"[OrderDTO](../../../../fulfillment/interfaces/fulfillment.OrderDTO/page.mdx)","description":"","optional":false,"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":"status","type":"[OrderStatus](../../../../fulfillment/types/fulfillment.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":"original_item_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"originalLine truncated
|
||||
+1
-1
@@ -4,4 +4,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"exchange","type":"[AdminExchange](../types.HttpTypes.AdminExchange/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_items","type":"[AdminReturnItem](../types.HttpTypes.AdminReturnItem/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"received_quantity","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reason_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"note","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_items","type":"[BaseExchangeItem](../../../interfaces/types.BaseExchangeItem/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"no_notification","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"difference_due","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return","type":"[AdminReturn](../types.HttpTypes.AdminReturn/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_version","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[BaseReturnItem](../../../interfaces/types.BaseReturnItem/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refund_amount","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"return_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="AdminExchangeResponse"/>
|
||||
<TypeList types={[{"name":"exchange","type":"[AdminExchange](../types.HttpTypes.AdminExchange/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_items","type":"[AdminReturnItem](../types.HttpTypes.AdminReturnItem/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"received_quantity","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reason_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"note","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_items","type":"[BaseExchangeItem](../../../interfaces/types.BaseExchangeItem/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"no_notification","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"difference_due","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return","type":"[AdminReturn](../types.HttpTypes.AdminReturn/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_version","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[BaseReturnItem](../../../interfaces/types.BaseReturnItem/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"received_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refund_amount","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"return_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="AdminExchangeResponse"/>
|
||||
+1
-1
@@ -4,4 +4,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"order_preview","type":"[OrderDTO](../../../../fulfillment/interfaces/fulfillment.OrderDTO/page.mdx)","description":"","optional":false,"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":"status","type":"[OrderStatus](../../../../fulfillment/types/fulfillment.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":"original_item_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"originalLine truncated
|
||||
<TypeList types={[{"name":"order_preview","type":"[OrderDTO](../../../../fulfillment/interfaces/fulfillment.OrderDTO/page.mdx)","description":"","optional":false,"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":"status","type":"[OrderStatus](../../../../fulfillment/types/fulfillment.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":"original_item_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"originalLine truncated
|
||||
+1
-1
@@ -4,4 +4,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"order","type":"[OrderDTO](../../../../fulfillment/interfaces/fulfillment.OrderDTO/page.mdx)","description":"","optional":false,"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":"status","type":"[OrderStatus](../../../../fulfillment/types/fulfillment.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":"original_item_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"original_total",Line truncated
|
||||
<TypeList types={[{"name":"order","type":"[OrderDTO](../../../../fulfillment/interfaces/fulfillment.OrderDTO/page.mdx)","description":"","optional":false,"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":"status","type":"[OrderStatus](../../../../fulfillment/types/fulfillment.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":"original_item_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.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](../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"original_total",Line truncated
|
||||
+1
-1
@@ -4,4 +4,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_version","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[BaseReturnItem](../../../interfaces/types.BaseReturnItem/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"received_quantity","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reason_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"note","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"status","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refund_amount","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="AdminReturn"/>
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_version","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[BaseReturnItem](../../../interfaces/types.BaseReturnItem/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"received_quantity","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reason_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"note","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"received_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refund_amount","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="AdminReturn"/>
|
||||
+1
-1
@@ -4,4 +4,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"order_preview","type":"`AdminOrderPreview`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return","type":"[AdminReturn](../types.HttpTypes.AdminReturn/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_version","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[BaseReturnItem](../../../interfaces/types.BaseReturnItem/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"received_quantity","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reason_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"note","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"status","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refund_amount","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="AdminReturnPreviewResponse"/>
|
||||
<TypeList types={[{"name":"order_preview","type":"`AdminOrderPreview`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return","type":"[AdminReturn](../types.HttpTypes.AdminReturn/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_version","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[BaseReturnItem](../../../interfaces/types.BaseReturnItem/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"received_quantity","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reason_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"note","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"received_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refund_amount","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="AdminReturnPreviewResponse"/>
|
||||
+1
-1
@@ -4,4 +4,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"return","type":"[AdminReturn](../types.HttpTypes.AdminReturn/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_version","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[BaseReturnItem](../../../interfaces/types.BaseReturnItem/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"received_quantity","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reason_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"note","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"status","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refund_amount","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="AdminReturnResponse"/>
|
||||
<TypeList types={[{"name":"return","type":"[AdminReturn](../types.HttpTypes.AdminReturn/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_version","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[BaseReturnItem](../../../interfaces/types.BaseReturnItem/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"received_quantity","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reason_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"note","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"received_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refund_amount","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="AdminReturnResponse"/>
|
||||
@@ -4,4 +4,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_items","type":"[AdminReturnItem](../../HttpTypes/interfaces/types.HttpTypes.AdminReturnItem/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"received_quantity","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reason_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"note","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_items","type":"[BaseExchangeItem](../types.BaseExchangeItem/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"no_notification","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"difference_due","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return","type":"[AdminReturn](../../HttpTypes/interfaces/types.HttpTypes.AdminReturn/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_version","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[BaseReturnItem](../types.BaseReturnItem/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"received_quantity","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reason_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"note","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"status","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,Line truncated
|
||||
<TypeList types={[{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_items","type":"[AdminReturnItem](../../HttpTypes/interfaces/types.HttpTypes.AdminReturnItem/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"received_quantity","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reason_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"note","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_items","type":"[BaseExchangeItem](../types.BaseExchangeItem/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"no_notification","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"difference_due","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return","type":"[AdminReturn](../../HttpTypes/interfaces/types.HttpTypes.AdminReturn/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_version","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[BaseReturnItem](../types.BaseReturnItem/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"received_quantity","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reason_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"note","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"received_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":falseLine truncated
|
||||
@@ -4,4 +4,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_version","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[BaseReturnItem](../types.BaseReturnItem/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"received_quantity","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reason_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"note","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"status","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refund_amount","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="BaseReturn"/>
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_version","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[BaseReturnItem](../types.BaseReturnItem/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"received_quantity","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reason_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"note","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"received_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refund_amount","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="BaseReturn"/>
|
||||
File diff suppressed because it is too large.
Load diff
File diff suppressed because it is too large.
Load diff
File diff suppressed because it is too large.
Load diff
File diff suppressed because it is too large.
Load diff
@@ -1,12 +1,12 @@
|
||||
{
|
||||
"id": 31515,
|
||||
"id": 31506,
|
||||
"name": "medusa-config",
|
||||
"variant": "project",
|
||||
"kind": 1,
|
||||
"flags": {},
|
||||
"children": [
|
||||
{
|
||||
"id": 31516,
|
||||
"id": 31507,
|
||||
"name": "AdminOptions",
|
||||
"variant": "declaration",
|
||||
"kind": 256,
|
||||
@@ -21,7 +21,7 @@
|
||||
},
|
||||
"children": [
|
||||
{
|
||||
"id": 31517,
|
||||
"id": 31508,
|
||||
"name": "disable",
|
||||
"variant": "declaration",
|
||||
"kind": 1024,
|
||||
@@ -58,7 +58,7 @@
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 31518,
|
||||
"id": 31509,
|
||||
"name": "path",
|
||||
"variant": "declaration",
|
||||
"kind": 1024,
|
||||
@@ -124,7 +124,7 @@
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 31519,
|
||||
"id": 31510,
|
||||
"name": "outDir",
|
||||
"variant": "declaration",
|
||||
"kind": 1024,
|
||||
@@ -153,7 +153,7 @@
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 31520,
|
||||
"id": 31511,
|
||||
"name": "backendUrl",
|
||||
"variant": "declaration",
|
||||
"kind": 1024,
|
||||
@@ -174,7 +174,7 @@
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 31521,
|
||||
"id": 31512,
|
||||
"name": "vite",
|
||||
"variant": "declaration",
|
||||
"kind": 1024,
|
||||
@@ -200,21 +200,21 @@
|
||||
"type": {
|
||||
"type": "reflection",
|
||||
"declaration": {
|
||||
"id": 31522,
|
||||
"id": 31513,
|
||||
"name": "__type",
|
||||
"variant": "declaration",
|
||||
"kind": 65536,
|
||||
"flags": {},
|
||||
"signatures": [
|
||||
{
|
||||
"id": 31523,
|
||||
"id": 31514,
|
||||
"name": "__type",
|
||||
"variant": "signature",
|
||||
"kind": 4096,
|
||||
"flags": {},
|
||||
"parameters": [
|
||||
{
|
||||
"id": 31524,
|
||||
"id": 31515,
|
||||
"name": "config",
|
||||
"variant": "param",
|
||||
"kind": 32768,
|
||||
@@ -249,17 +249,17 @@
|
||||
{
|
||||
"title": "Properties",
|
||||
"children": [
|
||||
31517,
|
||||
31518,
|
||||
31519,
|
||||
31520,
|
||||
31521
|
||||
31508,
|
||||
31509,
|
||||
31510,
|
||||
31511,
|
||||
31512
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": 31525,
|
||||
"id": 31516,
|
||||
"name": "HttpCompressionOptions",
|
||||
"variant": "declaration",
|
||||
"kind": 256,
|
||||
@@ -274,7 +274,7 @@
|
||||
},
|
||||
"children": [
|
||||
{
|
||||
"id": 31526,
|
||||
"id": 31517,
|
||||
"name": "enabled",
|
||||
"variant": "declaration",
|
||||
"kind": 1024,
|
||||
@@ -303,7 +303,7 @@
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 31527,
|
||||
"id": 31518,
|
||||
"name": "level",
|
||||
"variant": "declaration",
|
||||
"kind": 1024,
|
||||
@@ -332,7 +332,7 @@
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 31528,
|
||||
"id": 31519,
|
||||
"name": "memLevel",
|
||||
"variant": "declaration",
|
||||
"kind": 1024,
|
||||
@@ -361,7 +361,7 @@
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 31529,
|
||||
"id": 31520,
|
||||
"name": "threshold",
|
||||
"variant": "declaration",
|
||||
"kind": 1024,
|
||||
@@ -403,16 +403,16 @@
|
||||
{
|
||||
"title": "Properties",
|
||||
"children": [
|
||||
31526,
|
||||
31527,
|
||||
31528,
|
||||
31529
|
||||
31517,
|
||||
31518,
|
||||
31519,
|
||||
31520
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": 31530,
|
||||
"id": 31521,
|
||||
"name": "ProjectConfigOptions",
|
||||
"variant": "declaration",
|
||||
"kind": 256,
|
||||
@@ -427,7 +427,7 @@
|
||||
},
|
||||
"children": [
|
||||
{
|
||||
"id": 31531,
|
||||
"id": 31522,
|
||||
"name": "databaseName",
|
||||
"variant": "declaration",
|
||||
"kind": 1024,
|
||||
@@ -467,7 +467,7 @@
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 31532,
|
||||
"id": 31523,
|
||||
"name": "databaseUrl",
|
||||
"variant": "declaration",
|
||||
"kind": 1024,
|
||||
@@ -607,7 +607,7 @@
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 31533,
|
||||
"id": 31524,
|
||||
"name": "databaseSchema",
|
||||
"variant": "declaration",
|
||||
"kind": 1024,
|
||||
@@ -640,7 +640,7 @@
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 31534,
|
||||
"id": 31525,
|
||||
"name": "databaseLogging",
|
||||
"variant": "declaration",
|
||||
"kind": 1024,
|
||||
@@ -749,7 +749,7 @@
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 31536,
|
||||
"id": 31527,
|
||||
"name": "databaseDriverOptions",
|
||||
"variant": "declaration",
|
||||
"kind": 1024,
|
||||
@@ -848,14 +848,14 @@
|
||||
{
|
||||
"type": "reflection",
|
||||
"declaration": {
|
||||
"id": 31537,
|
||||
"id": 31528,
|
||||
"name": "__type",
|
||||
"variant": "declaration",
|
||||
"kind": 65536,
|
||||
"flags": {},
|
||||
"children": [
|
||||
{
|
||||
"id": 31538,
|
||||
"id": 31529,
|
||||
"name": "connection",
|
||||
"variant": "declaration",
|
||||
"kind": 1024,
|
||||
@@ -865,14 +865,14 @@
|
||||
"type": {
|
||||
"type": "reflection",
|
||||
"declaration": {
|
||||
"id": 31539,
|
||||
"id": 31530,
|
||||
"name": "__type",
|
||||
"variant": "declaration",
|
||||
"kind": 65536,
|
||||
"flags": {},
|
||||
"children": [
|
||||
{
|
||||
"id": 31540,
|
||||
"id": 31531,
|
||||
"name": "ssl",
|
||||
"variant": "declaration",
|
||||
"kind": 1024,
|
||||
@@ -890,14 +890,14 @@
|
||||
"type": {
|
||||
"type": "reflection",
|
||||
"declaration": {
|
||||
"id": 31541,
|
||||
"id": 31532,
|
||||
"name": "__type",
|
||||
"variant": "declaration",
|
||||
"kind": 65536,
|
||||
"flags": {},
|
||||
"children": [
|
||||
{
|
||||
"id": 31542,
|
||||
"id": 31533,
|
||||
"name": "rejectUnauthorized",
|
||||
"variant": "declaration",
|
||||
"kind": 1024,
|
||||
@@ -922,7 +922,7 @@
|
||||
{
|
||||
"title": "Properties",
|
||||
"children": [
|
||||
31542
|
||||
31533
|
||||
]
|
||||
}
|
||||
]
|
||||
@@ -934,7 +934,7 @@
|
||||
{
|
||||
"title": "Properties",
|
||||
"children": [
|
||||
31540
|
||||
31531
|
||||
]
|
||||
}
|
||||
]
|
||||
@@ -946,7 +946,7 @@
|
||||
{
|
||||
"title": "Properties",
|
||||
"children": [
|
||||
31538
|
||||
31529
|
||||
]
|
||||
}
|
||||
]
|
||||
@@ -956,7 +956,7 @@
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 31543,
|
||||
"id": 31534,
|
||||
"name": "redisUrl",
|
||||
"variant": "declaration",
|
||||
"kind": 1024,
|
||||
@@ -1004,7 +1004,7 @@
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 31544,
|
||||
"id": 31535,
|
||||
"name": "redisPrefix",
|
||||
"variant": "declaration",
|
||||
"kind": 1024,
|
||||
@@ -1052,7 +1052,7 @@
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 31545,
|
||||
"id": 31536,
|
||||
"name": "redisOptions",
|
||||
"variant": "declaration",
|
||||
"kind": 1024,
|
||||
@@ -1089,7 +1089,7 @@
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 31546,
|
||||
"id": 31537,
|
||||
"name": "sessionOptions",
|
||||
"variant": "declaration",
|
||||
"kind": 1024,
|
||||
@@ -1126,7 +1126,7 @@
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 31548,
|
||||
"id": 31539,
|
||||
"name": "jobsBatchSize",
|
||||
"variant": "declaration",
|
||||
"kind": 1024,
|
||||
@@ -1166,7 +1166,7 @@
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 31549,
|
||||
"id": 31540,
|
||||
"name": "workerMode",
|
||||
"variant": "declaration",
|
||||
"kind": 1024,
|
||||
@@ -1267,7 +1267,7 @@
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 31550,
|
||||
"id": 31541,
|
||||
"name": "http",
|
||||
"variant": "declaration",
|
||||
"kind": 1024,
|
||||
@@ -1294,14 +1294,14 @@
|
||||
"type": {
|
||||
"type": "reflection",
|
||||
"declaration": {
|
||||
"id": 31551,
|
||||
"id": 31542,
|
||||
"name": "__type",
|
||||
"variant": "declaration",
|
||||
"kind": 65536,
|
||||
"flags": {},
|
||||
"children": [
|
||||
{
|
||||
"id": 31552,
|
||||
"id": 31543,
|
||||
"name": "jwtSecret",
|
||||
"variant": "declaration",
|
||||
"kind": 1024,
|
||||
@@ -1341,7 +1341,7 @@
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 31553,
|
||||
"id": 31544,
|
||||
"name": "jwtExpiresIn",
|
||||
"variant": "declaration",
|
||||
"kind": 1024,
|
||||
@@ -1381,7 +1381,7 @@
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 31554,
|
||||
"id": 31545,
|
||||
"name": "cookieSecret",
|
||||
"variant": "declaration",
|
||||
"kind": 1024,
|
||||
@@ -1421,7 +1421,7 @@
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 31555,
|
||||
"id": 31546,
|
||||
"name": "authCors",
|
||||
"variant": "declaration",
|
||||
"kind": 1024,
|
||||
@@ -1535,7 +1535,7 @@
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 31556,
|
||||
"id": 31547,
|
||||
"name": "compression",
|
||||
"variant": "declaration",
|
||||
"kind": 1024,
|
||||
@@ -1571,13 +1571,13 @@
|
||||
},
|
||||
"type": {
|
||||
"type": "reference",
|
||||
"target": 31525,
|
||||
"target": 31516,
|
||||
"name": "HttpCompressionOptions",
|
||||
"package": "@medusajs/types"
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 31557,
|
||||
"id": 31548,
|
||||
"name": "storeCors",
|
||||
"variant": "declaration",
|
||||
"kind": 1024,
|
||||
@@ -1683,7 +1683,7 @@
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 31558,
|
||||
"id": 31549,
|
||||
"name": "adminCors",
|
||||
"variant": "declaration",
|
||||
"kind": 1024,
|
||||
@@ -1789,7 +1789,7 @@
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 31559,
|
||||
"id": 31550,
|
||||
"name": "authMethodsPerActor",
|
||||
"variant": "declaration",
|
||||
"kind": 1024,
|
||||
@@ -1879,14 +1879,14 @@
|
||||
{
|
||||
"title": "Properties",
|
||||
"children": [
|
||||
31552,
|
||||
31553,
|
||||
31554,
|
||||
31555,
|
||||
31556,
|
||||
31557,
|
||||
31558,
|
||||
31559
|
||||
31543,
|
||||
31544,
|
||||
31545,
|
||||
31546,
|
||||
31547,
|
||||
31548,
|
||||
31549,
|
||||
31550
|
||||
]
|
||||
}
|
||||
]
|
||||
@@ -1898,24 +1898,24 @@
|
||||
{
|
||||
"title": "Properties",
|
||||
"children": [
|
||||
31531,
|
||||
31532,
|
||||
31533,
|
||||
31522,
|
||||
31523,
|
||||
31524,
|
||||
31525,
|
||||
31527,
|
||||
31534,
|
||||
31535,
|
||||
31536,
|
||||
31543,
|
||||
31544,
|
||||
31545,
|
||||
31546,
|
||||
31548,
|
||||
31549,
|
||||
31550
|
||||
31537,
|
||||
31539,
|
||||
31540,
|
||||
31541
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": 31560,
|
||||
"id": 31551,
|
||||
"name": "ConfigModule",
|
||||
"variant": "declaration",
|
||||
"kind": 256,
|
||||
@@ -1946,7 +1946,7 @@
|
||||
"kind": "inline-tag",
|
||||
"tag": "@link",
|
||||
"text": "projectConfig",
|
||||
"target": 31561,
|
||||
"target": 31552,
|
||||
"tsLinkText": "projectConfig"
|
||||
},
|
||||
{
|
||||
@@ -1957,7 +1957,7 @@
|
||||
"kind": "inline-tag",
|
||||
"tag": "@link",
|
||||
"text": "admin",
|
||||
"target": 31562,
|
||||
"target": 31553,
|
||||
"tsLinkText": "admin"
|
||||
},
|
||||
{
|
||||
@@ -1982,7 +1982,7 @@
|
||||
"kind": "inline-tag",
|
||||
"tag": "@link",
|
||||
"text": "modules",
|
||||
"target": 31567,
|
||||
"target": 31558,
|
||||
"tsLinkText": "modules"
|
||||
},
|
||||
{
|
||||
@@ -1993,7 +1993,7 @@
|
||||
"kind": "inline-tag",
|
||||
"tag": "@link",
|
||||
"text": "featureFlags",
|
||||
"target": 31568,
|
||||
"target": 31559,
|
||||
"tsLinkText": "featureFlags"
|
||||
},
|
||||
{
|
||||
@@ -2028,7 +2028,7 @@
|
||||
},
|
||||
"children": [
|
||||
{
|
||||
"id": 31561,
|
||||
"id": 31552,
|
||||
"name": "projectConfig",
|
||||
"variant": "declaration",
|
||||
"kind": 1024,
|
||||
@@ -2043,13 +2043,13 @@
|
||||
},
|
||||
"type": {
|
||||
"type": "reference",
|
||||
"target": 31530,
|
||||
"target": 31521,
|
||||
"name": "ProjectConfigOptions",
|
||||
"package": "@medusajs/types"
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 31562,
|
||||
"id": 31553,
|
||||
"name": "admin",
|
||||
"variant": "declaration",
|
||||
"kind": 1024,
|
||||
@@ -2077,13 +2077,13 @@
|
||||
},
|
||||
"type": {
|
||||
"type": "reference",
|
||||
"target": 31516,
|
||||
"target": 31507,
|
||||
"name": "AdminOptions",
|
||||
"package": "@medusajs/types"
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 31567,
|
||||
"id": 31558,
|
||||
"name": "modules",
|
||||
"variant": "declaration",
|
||||
"kind": 1024,
|
||||
@@ -2225,7 +2225,7 @@
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 31568,
|
||||
"id": 31559,
|
||||
"name": "featureFlags",
|
||||
"variant": "declaration",
|
||||
"kind": 1024,
|
||||
@@ -2322,16 +2322,16 @@
|
||||
{
|
||||
"title": "Properties",
|
||||
"children": [
|
||||
31561,
|
||||
31562,
|
||||
31567,
|
||||
31568
|
||||
31552,
|
||||
31553,
|
||||
31558,
|
||||
31559
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": 31569,
|
||||
"id": 31560,
|
||||
"name": "PluginDetails",
|
||||
"variant": "declaration",
|
||||
"kind": 2097152,
|
||||
@@ -2339,14 +2339,14 @@
|
||||
"type": {
|
||||
"type": "reflection",
|
||||
"declaration": {
|
||||
"id": 31570,
|
||||
"id": 31561,
|
||||
"name": "__type",
|
||||
"variant": "declaration",
|
||||
"kind": 65536,
|
||||
"flags": {},
|
||||
"children": [
|
||||
{
|
||||
"id": 31571,
|
||||
"id": 31562,
|
||||
"name": "resolve",
|
||||
"variant": "declaration",
|
||||
"kind": 1024,
|
||||
@@ -2357,7 +2357,7 @@
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 31572,
|
||||
"id": 31563,
|
||||
"name": "name",
|
||||
"variant": "declaration",
|
||||
"kind": 1024,
|
||||
@@ -2368,7 +2368,7 @@
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 31573,
|
||||
"id": 31564,
|
||||
"name": "id",
|
||||
"variant": "declaration",
|
||||
"kind": 1024,
|
||||
@@ -2379,7 +2379,7 @@
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 31574,
|
||||
"id": 31565,
|
||||
"name": "options",
|
||||
"variant": "declaration",
|
||||
"kind": 1024,
|
||||
@@ -2405,7 +2405,7 @@
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 31575,
|
||||
"id": 31566,
|
||||
"name": "version",
|
||||
"variant": "declaration",
|
||||
"kind": 1024,
|
||||
@@ -2420,11 +2420,11 @@
|
||||
{
|
||||
"title": "Properties",
|
||||
"children": [
|
||||
31571,
|
||||
31572,
|
||||
31573,
|
||||
31574,
|
||||
31575
|
||||
31562,
|
||||
31563,
|
||||
31564,
|
||||
31565,
|
||||
31566
|
||||
]
|
||||
}
|
||||
]
|
||||
@@ -2436,238 +2436,238 @@
|
||||
{
|
||||
"title": "Interfaces",
|
||||
"children": [
|
||||
31507,
|
||||
31516,
|
||||
31525,
|
||||
31530,
|
||||
31560
|
||||
31521,
|
||||
31551
|
||||
]
|
||||
},
|
||||
{
|
||||
"title": "Type Aliases",
|
||||
"children": [
|
||||
31569
|
||||
31560
|
||||
]
|
||||
}
|
||||
],
|
||||
"packageName": "@medusajs/types",
|
||||
"symbolIdMap": {
|
||||
"31515": {
|
||||
"31506": {
|
||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||
"qualifiedName": ""
|
||||
},
|
||||
"31516": {
|
||||
"31507": {
|
||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||
"qualifiedName": "AdminOptions"
|
||||
},
|
||||
"31517": {
|
||||
"31508": {
|
||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||
"qualifiedName": "__type.disable"
|
||||
},
|
||||
"31518": {
|
||||
"31509": {
|
||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||
"qualifiedName": "__type.path"
|
||||
},
|
||||
"31519": {
|
||||
"31510": {
|
||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||
"qualifiedName": "__type.outDir"
|
||||
},
|
||||
"31520": {
|
||||
"31511": {
|
||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||
"qualifiedName": "__type.backendUrl"
|
||||
},
|
||||
"31521": {
|
||||
"31512": {
|
||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||
"qualifiedName": "__type.vite"
|
||||
},
|
||||
"31522": {
|
||||
"31513": {
|
||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||
"qualifiedName": "__type"
|
||||
},
|
||||
"31523": {
|
||||
"31514": {
|
||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||
"qualifiedName": "__type"
|
||||
},
|
||||
"31524": {
|
||||
"31515": {
|
||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||
"qualifiedName": "config"
|
||||
},
|
||||
"31525": {
|
||||
"31516": {
|
||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||
"qualifiedName": "HttpCompressionOptions"
|
||||
},
|
||||
"31526": {
|
||||
"31517": {
|
||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||
"qualifiedName": "__type.enabled"
|
||||
},
|
||||
"31527": {
|
||||
"31518": {
|
||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||
"qualifiedName": "__type.level"
|
||||
},
|
||||
"31528": {
|
||||
"31519": {
|
||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||
"qualifiedName": "__type.memLevel"
|
||||
},
|
||||
"31529": {
|
||||
"31520": {
|
||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||
"qualifiedName": "__type.threshold"
|
||||
},
|
||||
"31530": {
|
||||
"31521": {
|
||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||
"qualifiedName": "ProjectConfigOptions"
|
||||
},
|
||||
"31531": {
|
||||
"31522": {
|
||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||
"qualifiedName": "__type.databaseName"
|
||||
},
|
||||
"31532": {
|
||||
"31523": {
|
||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||
"qualifiedName": "__type.databaseUrl"
|
||||
},
|
||||
"31533": {
|
||||
"31524": {
|
||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||
"qualifiedName": "__type.databaseSchema"
|
||||
},
|
||||
"31534": {
|
||||
"31525": {
|
||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||
"qualifiedName": "__type.databaseLogging"
|
||||
},
|
||||
"31536": {
|
||||
"31527": {
|
||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||
"qualifiedName": "__type.databaseDriverOptions"
|
||||
},
|
||||
"31537": {
|
||||
"31528": {
|
||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||
"qualifiedName": "__type"
|
||||
},
|
||||
"31538": {
|
||||
"31529": {
|
||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||
"qualifiedName": "__type.connection"
|
||||
},
|
||||
"31539": {
|
||||
"31530": {
|
||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||
"qualifiedName": "__type"
|
||||
},
|
||||
"31540": {
|
||||
"31531": {
|
||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||
"qualifiedName": "__type.ssl"
|
||||
},
|
||||
"31541": {
|
||||
"31532": {
|
||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||
"qualifiedName": "__type"
|
||||
},
|
||||
"31542": {
|
||||
"31533": {
|
||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||
"qualifiedName": "__type.rejectUnauthorized"
|
||||
},
|
||||
"31543": {
|
||||
"31534": {
|
||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||
"qualifiedName": "__type.redisUrl"
|
||||
},
|
||||
"31544": {
|
||||
"31535": {
|
||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||
"qualifiedName": "__type.redisPrefix"
|
||||
},
|
||||
"31545": {
|
||||
"31536": {
|
||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||
"qualifiedName": "__type.redisOptions"
|
||||
},
|
||||
"31546": {
|
||||
"31537": {
|
||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||
"qualifiedName": "__type.sessionOptions"
|
||||
},
|
||||
"31548": {
|
||||
"31539": {
|
||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||
"qualifiedName": "__type.jobsBatchSize"
|
||||
},
|
||||
"31549": {
|
||||
"31540": {
|
||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||
"qualifiedName": "__type.workerMode"
|
||||
},
|
||||
"31550": {
|
||||
"31541": {
|
||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||
"qualifiedName": "__type.http"
|
||||
},
|
||||
"31551": {
|
||||
"31542": {
|
||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||
"qualifiedName": "__type"
|
||||
},
|
||||
"31552": {
|
||||
"31543": {
|
||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||
"qualifiedName": "__type.jwtSecret"
|
||||
},
|
||||
"31553": {
|
||||
"31544": {
|
||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||
"qualifiedName": "__type.jwtExpiresIn"
|
||||
},
|
||||
"31554": {
|
||||
"31545": {
|
||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||
"qualifiedName": "__type.cookieSecret"
|
||||
},
|
||||
"31555": {
|
||||
"31546": {
|
||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||
"qualifiedName": "__type.authCors"
|
||||
},
|
||||
"31556": {
|
||||
"31547": {
|
||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||
"qualifiedName": "__type.compression"
|
||||
},
|
||||
"31557": {
|
||||
"31548": {
|
||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||
"qualifiedName": "__type.storeCors"
|
||||
},
|
||||
"31558": {
|
||||
"31549": {
|
||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||
"qualifiedName": "__type.adminCors"
|
||||
},
|
||||
"31559": {
|
||||
"31550": {
|
||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||
"qualifiedName": "__type.authMethodsPerActor"
|
||||
},
|
||||
"31560": {
|
||||
"31551": {
|
||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||
"qualifiedName": "ConfigModule"
|
||||
},
|
||||
"31561": {
|
||||
"31552": {
|
||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||
"qualifiedName": "__type.projectConfig"
|
||||
},
|
||||
"31562": {
|
||||
"31553": {
|
||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||
"qualifiedName": "__type.admin"
|
||||
},
|
||||
"31567": {
|
||||
"31558": {
|
||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||
"qualifiedName": "__type.modules"
|
||||
},
|
||||
"31568": {
|
||||
"31559": {
|
||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||
"qualifiedName": "__type.featureFlags"
|
||||
},
|
||||
"31569": {
|
||||
"31560": {
|
||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||
"qualifiedName": "PluginDetails"
|
||||
},
|
||||
"31570": {
|
||||
"31561": {
|
||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||
"qualifiedName": "__type"
|
||||
},
|
||||
"31571": {
|
||||
"31562": {
|
||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||
"qualifiedName": "__type.resolve"
|
||||
},
|
||||
"31572": {
|
||||
"31563": {
|
||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||
"qualifiedName": "__type.name"
|
||||
},
|
||||
"31573": {
|
||||
"31564": {
|
||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||
"qualifiedName": "__type.id"
|
||||
},
|
||||
"31574": {
|
||||
"31565": {
|
||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||
"qualifiedName": "__type.options"
|
||||
},
|
||||
"31575": {
|
||||
"31566": {
|
||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||
"qualifiedName": "__type.version"
|
||||
}
|
||||
@@ -2677,7 +2677,7 @@
|
||||
"1": "../../../../packages/core/types/src/common/config-module.ts"
|
||||
},
|
||||
"reflections": {
|
||||
"1": 31515
|
||||
"1": 31506
|
||||
}
|
||||
}
|
||||
}
|
||||
File diff suppressed because it is too large.
Load diff
@@ -1,12 +1,12 @@
|
||||
{
|
||||
"id": 32581,
|
||||
"id": 32572,
|
||||
"name": "tax-provider",
|
||||
"variant": "project",
|
||||
"kind": 1,
|
||||
"flags": {},
|
||||
"children": [
|
||||
{
|
||||
"id": 32582,
|
||||
"id": 32573,
|
||||
"name": "ShippingTaxCalculationLine",
|
||||
"variant": "declaration",
|
||||
"kind": 2097152,
|
||||
@@ -22,14 +22,14 @@
|
||||
"type": {
|
||||
"type": "reflection",
|
||||
"declaration": {
|
||||
"id": 32583,
|
||||
"id": 32574,
|
||||
"name": "__type",
|
||||
"variant": "declaration",
|
||||
"kind": 65536,
|
||||
"flags": {},
|
||||
"children": [
|
||||
{
|
||||
"id": 32584,
|
||||
"id": 32575,
|
||||
"name": "shipping_line",
|
||||
"variant": "declaration",
|
||||
"kind": 1024,
|
||||
@@ -53,7 +53,7 @@
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 32585,
|
||||
"id": 32576,
|
||||
"name": "rates",
|
||||
"variant": "declaration",
|
||||
"kind": 1024,
|
||||
@@ -84,8 +84,8 @@
|
||||
{
|
||||
"title": "Properties",
|
||||
"children": [
|
||||
32584,
|
||||
32585
|
||||
32575,
|
||||
32576
|
||||
]
|
||||
}
|
||||
]
|
||||
@@ -93,7 +93,7 @@
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 32586,
|
||||
"id": 32577,
|
||||
"name": "ItemTaxCalculationLine",
|
||||
"variant": "declaration",
|
||||
"kind": 2097152,
|
||||
@@ -109,14 +109,14 @@
|
||||
"type": {
|
||||
"type": "reflection",
|
||||
"declaration": {
|
||||
"id": 32587,
|
||||
"id": 32578,
|
||||
"name": "__type",
|
||||
"variant": "declaration",
|
||||
"kind": 65536,
|
||||
"flags": {},
|
||||
"children": [
|
||||
{
|
||||
"id": 32588,
|
||||
"id": 32579,
|
||||
"name": "line_item",
|
||||
"variant": "declaration",
|
||||
"kind": 1024,
|
||||
@@ -140,7 +140,7 @@
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 32589,
|
||||
"id": 32580,
|
||||
"name": "rates",
|
||||
"variant": "declaration",
|
||||
"kind": 1024,
|
||||
@@ -171,8 +171,8 @@
|
||||
{
|
||||
"title": "Properties",
|
||||
"children": [
|
||||
32588,
|
||||
32589
|
||||
32579,
|
||||
32580
|
||||
]
|
||||
}
|
||||
]
|
||||
@@ -180,7 +180,7 @@
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 32590,
|
||||
"id": 32581,
|
||||
"name": "ITaxProvider",
|
||||
"variant": "declaration",
|
||||
"kind": 256,
|
||||
@@ -283,14 +283,14 @@
|
||||
},
|
||||
"children": [
|
||||
{
|
||||
"id": 32593,
|
||||
"id": 32584,
|
||||
"name": "getTaxLines",
|
||||
"variant": "declaration",
|
||||
"kind": 2048,
|
||||
"flags": {},
|
||||
"signatures": [
|
||||
{
|
||||
"id": 32594,
|
||||
"id": 32585,
|
||||
"name": "getTaxLines",
|
||||
"variant": "signature",
|
||||
"kind": 4096,
|
||||
@@ -361,7 +361,7 @@
|
||||
},
|
||||
"parameters": [
|
||||
{
|
||||
"id": 32595,
|
||||
"id": 32586,
|
||||
"name": "itemLines",
|
||||
"variant": "param",
|
||||
"kind": 32768,
|
||||
@@ -378,14 +378,14 @@
|
||||
"type": "array",
|
||||
"elementType": {
|
||||
"type": "reference",
|
||||
"target": 32586,
|
||||
"target": 32577,
|
||||
"name": "ItemTaxCalculationLine",
|
||||
"package": "@medusajs/types"
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 32596,
|
||||
"id": 32587,
|
||||
"name": "shippingLines",
|
||||
"variant": "param",
|
||||
"kind": 32768,
|
||||
@@ -402,14 +402,14 @@
|
||||
"type": "array",
|
||||
"elementType": {
|
||||
"type": "reference",
|
||||
"target": 32582,
|
||||
"target": 32573,
|
||||
"name": "ShippingTaxCalculationLine",
|
||||
"package": "@medusajs/types"
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 32597,
|
||||
"id": 32588,
|
||||
"name": "context",
|
||||
"variant": "param",
|
||||
"kind": 32768,
|
||||
@@ -478,7 +478,7 @@
|
||||
{
|
||||
"title": "Methods",
|
||||
"children": [
|
||||
32593
|
||||
32584
|
||||
]
|
||||
}
|
||||
]
|
||||
@@ -488,76 +488,76 @@
|
||||
{
|
||||
"title": "Interfaces",
|
||||
"children": [
|
||||
32590
|
||||
32581
|
||||
]
|
||||
},
|
||||
{
|
||||
"title": "Type Aliases",
|
||||
"children": [
|
||||
32582,
|
||||
32586
|
||||
32573,
|
||||
32577
|
||||
]
|
||||
}
|
||||
],
|
||||
"packageName": "@medusajs/types",
|
||||
"symbolIdMap": {
|
||||
"32581": {
|
||||
"32572": {
|
||||
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
|
||||
"qualifiedName": ""
|
||||
},
|
||||
"32582": {
|
||||
"32573": {
|
||||
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
|
||||
"qualifiedName": "ShippingTaxCalculationLine"
|
||||
},
|
||||
"32583": {
|
||||
"32574": {
|
||||
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
|
||||
"qualifiedName": "__type"
|
||||
},
|
||||
"32584": {
|
||||
"32575": {
|
||||
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
|
||||
"qualifiedName": "__type.shipping_line"
|
||||
},
|
||||
"32585": {
|
||||
"32576": {
|
||||
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
|
||||
"qualifiedName": "__type.rates"
|
||||
},
|
||||
"32586": {
|
||||
"32577": {
|
||||
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
|
||||
"qualifiedName": "ItemTaxCalculationLine"
|
||||
},
|
||||
"32587": {
|
||||
"32578": {
|
||||
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
|
||||
"qualifiedName": "__type"
|
||||
},
|
||||
"32588": {
|
||||
"32579": {
|
||||
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
|
||||
"qualifiedName": "__type.line_item"
|
||||
},
|
||||
"32589": {
|
||||
"32580": {
|
||||
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
|
||||
"qualifiedName": "__type.rates"
|
||||
},
|
||||
"32590": {
|
||||
"32581": {
|
||||
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
|
||||
"qualifiedName": "ITaxProvider"
|
||||
},
|
||||
"32593": {
|
||||
"32584": {
|
||||
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
|
||||
"qualifiedName": "ITaxProvider.getTaxLines"
|
||||
},
|
||||
"32594": {
|
||||
"32585": {
|
||||
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
|
||||
"qualifiedName": "ITaxProvider.getTaxLines"
|
||||
},
|
||||
"32595": {
|
||||
"32586": {
|
||||
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
|
||||
"qualifiedName": "itemLines"
|
||||
},
|
||||
"32596": {
|
||||
"32587": {
|
||||
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
|
||||
"qualifiedName": "shippingLines"
|
||||
},
|
||||
"32597": {
|
||||
"32588": {
|
||||
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
|
||||
"qualifiedName": "context"
|
||||
}
|
||||
@@ -567,7 +567,7 @@
|
||||
"1": "../../../../packages/core/types/src/tax/provider.ts"
|
||||
},
|
||||
"reflections": {
|
||||
"1": 32581
|
||||
"1": 32572
|
||||
}
|
||||
}
|
||||
}
|
||||
File diff suppressed because it is too large.
Load diff
Reference in new issue
Block a user