docs: [4/n] generate core-flows reference (#8785)
This commit is contained in:
Shahed Nasser
GitHub
+20
File diff suppressed because one or more lines are too long
+20
File diff suppressed because one or more lines are too long
+16
@@ -0,0 +1,16 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/steps/cancelOrderChangeStep
|
||||
sidebar_label: cancelOrderChangeStep
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# cancelOrderChangeStep - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `cancelOrderChangeStep`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This step cancels an order change.
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"CancelOrderChangeDTO","type":"[CancelOrderChangeDTO](../../../../../order/interfaces/order.CancelOrderChangeDTO/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order change.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_by","type":"`string`","description":"The user or customer that canceled the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="cancelOrderChangeStep"/>
|
||||
+16
@@ -0,0 +1,16 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/steps/cancelOrderClaimStep
|
||||
sidebar_label: cancelOrderClaimStep
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# cancelOrderClaimStep - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `cancelOrderClaimStep`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This step cancels a claim.
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"CancelOrderClaimDTO","type":"[CancelOrderClaimDTO](../../../../../order/interfaces/order.CancelOrderClaimDTO/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The associated claim's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return'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":"description","type":"`string`","description":"The description of the action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`string`","description":"The internal note of the action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`string`","description":"The name of the data model the action\nreferences. For example, `return`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the record of the data model\nspecified in [reference](../../../../../order/interfaces/order.CancelOrderClaimDTO/page.mdx#reference).\n\nFor example, if `reference` is `return`, the\nvalue is `return_123`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"The user or customer that created this action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="cancelOrderClaimStep"/>
|
||||
+16
@@ -0,0 +1,16 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/steps/cancelOrderExchangeStep
|
||||
sidebar_label: cancelOrderExchangeStep
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# cancelOrderExchangeStep - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `cancelOrderExchangeStep`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This step cancels an exchange.
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"CancelOrderExchangeDTO","type":"[CancelOrderExchangeDTO](../../../../../order/interfaces/order.CancelOrderExchangeDTO/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The associated exchange's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The associated claim's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`string`","description":"The internal note of the action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`string`","description":"The name of the data model the action\nreferences. For example, `return`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the record of the data model\nspecified in [reference](../../../../../order/interfaces/order.CancelOrderExchangeDTO/page.mdx#reference).\n\nFor example, if `reference` is `return`, the\nvalue is `return_123`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"The user or customer that created this action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="cancelOrderExchangeStep"/>
|
||||
+16
@@ -0,0 +1,16 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/steps/cancelOrderFulfillmentStep
|
||||
sidebar_label: cancelOrderFulfillmentStep
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# cancelOrderFulfillmentStep - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `cancelOrderFulfillmentStep`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This step cancels an order's fulfillment.
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"CancelOrderFulfillmentDTO","type":"[CancelOrderFulfillmentDTO](../../../../../order/interfaces/order.CancelOrderFulfillmentDTO/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[BaseOrderBundledItemActionsDTO](../../../../../order/interfaces/order.BaseOrderBundledItemActionsDTO/page.mdx)[]","description":"The items whose fulfillment is canceled.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"[BigNumberInput](../../../../../order/types/order.BigNumberInput/page.mdx)","description":"The quantity of the item.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../../../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":"internal_note","type":"`string`","description":"The internal note of the item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"note","type":"`null` \\| `string`","description":"The note of the item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"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":"description","type":"`string`","description":"The description of the action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`string`","description":"The internal note of the action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`string`","description":"The name of the data model the action\nreferences. For example, `return`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the record of the data model\nspecified in [reference](../../../../../order/interfaces/order.CancelOrderFulfillmentDTO/page.mdx#reference).\n\nFor example, if `reference` is `return`, the\nvalue is `return_123`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"The user or customer that created this action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="cancelOrderFulfillmentStep"/>
|
||||
+16
@@ -0,0 +1,16 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/steps/cancelOrderReturnStep
|
||||
sidebar_label: cancelOrderReturnStep
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# cancelOrderReturnStep - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `cancelOrderReturnStep`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This step cancels a return.
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"CancelOrderReturnDTO","type":"[CancelOrderReturnDTO](../../../../../order/interfaces/order.CancelOrderReturnDTO/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":false,"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":"description","type":"`string`","description":"The description of the action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`string`","description":"The internal note of the action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`string`","description":"The name of the data model the action\nreferences. For example, `return`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the record of the data model\nspecified in [reference](../../../../../order/interfaces/order.CancelOrderReturnDTO/page.mdx#reference).\n\nFor example, if `reference` is `return`, the\nvalue is `return_123`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"The user or customer that created this action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="cancelOrderReturnStep"/>
|
||||
+20
File diff suppressed because one or more lines are too long
+20
File diff suppressed because one or more lines are too long
+20
File diff suppressed because one or more lines are too long
+20
File diff suppressed because one or more lines are too long
+20
File diff suppressed because one or more lines are too long
+20
File diff suppressed because one or more lines are too long
+20
File diff suppressed because one or more lines are too long
+20
File diff suppressed because one or more lines are too long
+20
File diff suppressed because one or more lines are too long
+20
File diff suppressed because one or more lines are too long
+20
File diff suppressed because one or more lines are too long
+16
@@ -0,0 +1,16 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/steps/declineOrderChangeStep
|
||||
sidebar_label: declineOrderChangeStep
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# declineOrderChangeStep - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `declineOrderChangeStep`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This step declines an order change.
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"DeclineOrderChangeDTO","type":"[DeclineOrderChangeDTO](../../../../../order/interfaces/order.DeclineOrderChangeDTO/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order change.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_by","type":"`string`","description":"The user or customer who declined the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="declineOrderChangeStep"/>
|
||||
+16
@@ -0,0 +1,16 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/steps/deleteClaimsStep
|
||||
sidebar_label: deleteClaimsStep
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# deleteClaimsStep - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `deleteClaimsStep`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This step deletes one or more order claims.
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"ids","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="deleteClaimsStep"/>
|
||||
+16
@@ -0,0 +1,16 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/steps/deleteExchangesStep
|
||||
sidebar_label: deleteExchangesStep
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# deleteExchangesStep - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `deleteExchangesStep`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This step deletes one or more exchanges.
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"ids","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="deleteExchangesStep"/>
|
||||
+16
@@ -0,0 +1,16 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/steps/deleteOrderChangeActionsStep
|
||||
sidebar_label: deleteOrderChangeActionsStep
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# deleteOrderChangeActionsStep - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `deleteOrderChangeActionsStep`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This step deletes order change actions.
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"ids","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="deleteOrderChangeActionsStep"/>
|
||||
+16
@@ -0,0 +1,16 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/steps/deleteOrderChangesStep
|
||||
sidebar_label: deleteOrderChangesStep
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# deleteOrderChangesStep - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `deleteOrderChangesStep`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This step deletes order changes.
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"ids","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="deleteOrderChangesStep"/>
|
||||
+16
@@ -0,0 +1,16 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/steps/deleteOrderLineItems
|
||||
sidebar_label: deleteOrderLineItems
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# deleteOrderLineItems - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `deleteOrderLineItems`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This step deletes order line items.
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"DeleteOrderLineItemsStepInput","type":"[DeleteOrderLineItemsStepInput](../../../../interfaces/core_flows.DeleteOrderLineItemsStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"ids","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="deleteOrderLineItems"/>
|
||||
+16
@@ -0,0 +1,16 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/steps/deleteOrderShippingMethods
|
||||
sidebar_label: deleteOrderShippingMethods
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# deleteOrderShippingMethods - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `deleteOrderShippingMethods`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This step deletes order shipping methods.
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"DeleteOrderShippingMethodsStepInput","type":"[DeleteOrderShippingMethodsStepInput](../../../../interfaces/core_flows.DeleteOrderShippingMethodsStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"ids","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="deleteOrderShippingMethods"/>
|
||||
+16
@@ -0,0 +1,16 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/steps/deleteReturnsStep
|
||||
sidebar_label: deleteReturnsStep
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# deleteReturnsStep - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `deleteReturnsStep`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This step deletes one or more returns.
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"ids","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="deleteReturnsStep"/>
|
||||
+20
File diff suppressed because one or more lines are too long
+20
File diff suppressed because one or more lines are too long
+16
@@ -0,0 +1,16 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/steps/registerOrderFulfillmentStep
|
||||
sidebar_label: registerOrderFulfillmentStep
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# registerOrderFulfillmentStep - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `registerOrderFulfillmentStep`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This step registers a fulfillment for an order.
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"RegisterOrderFulfillmentDTO","type":"[RegisterOrderFulfillmentDTO](../../../../../order/interfaces/order.RegisterOrderFulfillmentDTO/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[BaseOrderBundledItemActionsDTO](../../../../../order/interfaces/order.BaseOrderBundledItemActionsDTO/page.mdx)[]","description":"The items of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"[BigNumberInput](../../../../../order/types/order.BigNumberInput/page.mdx)","description":"The quantity of the item.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../../../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":"internal_note","type":"`string`","description":"The internal note of the item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"note","type":"`null` \\| `string`","description":"The note of the item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"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":"description","type":"`string`","description":"The description of the action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`string`","description":"The internal note of the action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`string`","description":"The name of the data model the action\nreferences. For example, `return`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the record of the data model\nspecified in [reference](../../../../../order/interfaces/order.RegisterOrderFulfillmentDTO/page.mdx#reference).\n\nFor example, if `reference` is `return`, the\nvalue is `return_123`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"The user or customer that created this action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="registerOrderFulfillmentStep"/>
|
||||
+16
@@ -0,0 +1,16 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/steps/registerOrderShipmentStep
|
||||
sidebar_label: registerOrderShipmentStep
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# registerOrderShipmentStep - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `registerOrderShipmentStep`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This step registers a shipment for an order.
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"RegisterOrderShipmentDTO","type":"[RegisterOrderShipmentDTO](../../../../../order/interfaces/order.RegisterOrderShipmentDTO/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The associated claim's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The associated exchange's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`string`","description":"The internal note of the action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`string`","description":"The name of the data model the action\nreferences. For example, `return`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the record of the data model\nspecified in [reference](../../../../../order/interfaces/order.RegisterOrderShipmentDTO/page.mdx#reference).\n\nFor example, if `reference` is `return`, the\nvalue is `return_123`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"The user or customer that created this action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[BaseOrderBundledItemActionsDTO](../../../../../order/interfaces/order.BaseOrderBundledItemActionsDTO/page.mdx)[]","description":"The items of the shipment.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"[BigNumberInput](../../../../../order/types/order.BigNumberInput/page.mdx)","description":"The quantity of the item.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../../../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":"internal_note","type":"`string`","description":"The internal note of the item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"note","type":"`null` \\| `string`","description":"The note of the item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"no_notification","type":"`boolean`","description":"Whether the customer should receive notifications about the shipment.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="registerOrderShipmentStep"/>
|
||||
+16
File diff suppressed because one or more lines are too long
+20
File diff suppressed because one or more lines are too long
+20
File diff suppressed because one or more lines are too long
+20
File diff suppressed because one or more lines are too long
+20
File diff suppressed because one or more lines are too long
+16
@@ -0,0 +1,16 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/steps/updateReturnItemsStep
|
||||
sidebar_label: updateReturnItemsStep
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# updateReturnItemsStep - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `updateReturnItemsStep`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This step updates return items.
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"UpdateReturnItemBySelector[]","type":"[UpdateReturnItemBySelector](../../../../interfaces/core_flows.UpdateReturnItemBySelector/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"UpdateReturnItemBySelector","type":"[UpdateReturnItemBySelector](../../../../interfaces/core_flows.UpdateReturnItemBySelector/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateReturnItemsStep"/>
|
||||
+16
@@ -0,0 +1,16 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/steps/updateReturnsStep
|
||||
sidebar_label: updateReturnsStep
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# updateReturnsStep - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `updateReturnsStep`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This step updates one or more returns.
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"UpdateReturnDTO[]","type":"[UpdateReturnDTO](../../../../../order/interfaces/order.UpdateReturnDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"UpdateReturnDTO","type":"[UpdateReturnDTO](../../../../../order/interfaces/order.UpdateReturnDTO/page.mdx)","optional":false,"defaultValue":"","description":"The attributes to update in the return.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string`","description":"The ID of the location to return the items to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refund_amount","type":"[BigNumberInput](../../../../../order/types/order.BigNumberInput/page.mdx)","description":"The refund amount of the return.","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":"no_notification","type":"`boolean`","description":"Whether the customer should receive notifications related\nto updates on the return.","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":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"`object`[]","description":"The items of the return.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"quantity","type":"[BigNumberInput](../../../../../order/types/order.BigNumberInput/page.mdx)","description":"The quantity of the item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"The internal note of the item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"note","type":"`null` \\| `string`","description":"The note of the item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reason_id","type":"`null` \\| `string`","description":"The associated reason's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`null` \\| `string`","description":"The associated return's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"status","type":"[ReturnStatus](../../../../../order/types/order.ReturnStatus-1/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_at","type":"`Date`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateReturnsStep"/>
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# addOrderTransactionStepId
|
||||
|
||||
`Const` **addOrderTransactionStepId**: `"add-order-transaction"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# archiveOrdersStepId
|
||||
|
||||
`Const` **archiveOrdersStepId**: `"archive-orders"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# cancelOrderChangeStepId
|
||||
|
||||
`Const` **cancelOrderChangeStepId**: `"cancel-order-change"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# cancelOrderClaimStepId
|
||||
|
||||
`Const` **cancelOrderClaimStepId**: `"cancel-order-claim"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# cancelOrderExchangeStepId
|
||||
|
||||
`Const` **cancelOrderExchangeStepId**: `"cancel-order-swap"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# cancelOrderFulfillmentStepId
|
||||
|
||||
`Const` **cancelOrderFulfillmentStepId**: `"cancel-order-fulfillment"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# cancelOrderReturnStepId
|
||||
|
||||
`Const` **cancelOrderReturnStepId**: `"cancel-order-return"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# cancelOrdersStepId
|
||||
|
||||
`Const` **cancelOrdersStepId**: `"cancel-orders"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# completeOrdersStepId
|
||||
|
||||
`Const` **completeOrdersStepId**: `"complete-orders"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# createCompleteReturnStepId
|
||||
|
||||
`Const` **createCompleteReturnStepId**: `"create-complete-return"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# createOrderChangeStepId
|
||||
|
||||
`Const` **createOrderChangeStepId**: `"create-order-change"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# createOrderClaimsStepId
|
||||
|
||||
`Const` **createOrderClaimsStepId**: `"create-order-claims"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# createOrderExchangesStepId
|
||||
|
||||
`Const` **createOrderExchangesStepId**: `"create-order-exchanges"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# createOrderLineItemsStepId
|
||||
|
||||
`Const` **createOrderLineItemsStepId**: `"create-order-line-items-step"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# createOrdersStepId
|
||||
|
||||
`Const` **createOrdersStepId**: `"create-orders"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# createReturnsStepId
|
||||
|
||||
`Const` **createReturnsStepId**: `"create-returns"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# declineOrderChangeStepId
|
||||
|
||||
`Const` **declineOrderChangeStepId**: `"decline-order-change"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# deleteClaimsStepId
|
||||
|
||||
`Const` **deleteClaimsStepId**: `"delete-claims"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# deleteExchangesStepId
|
||||
|
||||
`Const` **deleteExchangesStepId**: `"delete-exchanges"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# deleteOrderChangeActionsStepId
|
||||
|
||||
`Const` **deleteOrderChangeActionsStepId**: `"delete-order-change-actions"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# deleteOrderChangesStepId
|
||||
|
||||
`Const` **deleteOrderChangesStepId**: `"delete-order-change"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# deleteReturnsStepId
|
||||
|
||||
`Const` **deleteReturnsStepId**: `"delete-return"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# getOrderItemTaxLinesStepId
|
||||
|
||||
`Const` **getOrderItemTaxLinesStepId**: `"get-order-item-tax-lines"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# previewOrderChangeStepId
|
||||
|
||||
`Const` **previewOrderChangeStepId**: `"preview-order-change"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# registerOrderFulfillmentStepId
|
||||
|
||||
`Const` **registerOrderFulfillmentStepId**: `"register-order-fullfillment"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# registerOrderShipmentStepId
|
||||
|
||||
`Const` **registerOrderShipmentStepId**: `"register-order-shipment"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# setOrderTaxLinesForItemsStepId
|
||||
|
||||
`Const` **setOrderTaxLinesForItemsStepId**: `"set-order-tax-lines-for-items"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# updateOrderChangeActionsStepId
|
||||
|
||||
`Const` **updateOrderChangeActionsStepId**: `"update-order-change-actions"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# updateOrderChangesStepId
|
||||
|
||||
`Const` **updateOrderChangesStepId**: `"update-order-shopping-methods"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# updateOrderExchangesStepId
|
||||
|
||||
`Const` **updateOrderExchangesStepId**: `"update-order-exchange"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# updateOrderShippingMethodsStepId
|
||||
|
||||
`Const` **updateOrderShippingMethodsStepId**: `"update-order-shopping-methods"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# updateReturnItemsStepId
|
||||
|
||||
`Const` **updateReturnItemsStepId**: `"update-return-items"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# updateReturnsStepId
|
||||
|
||||
`Const` **updateReturnsStepId**: `"update-returns"`
|
||||
File diff suppressed because one or more lines are too long
@@ -0,0 +1,8 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# Order
|
||||
|
||||
## Namespaces
|
||||
|
||||
- [Steps\_Order](../core_flows.Steps_Order/page.mdx)
|
||||
- [Workflows\_Order](../core_flows.Workflows_Order/page.mdx)
|
||||
Reference in New Issue
Block a user