docs: [9/n] generate core-flows reference (#8790)
This commit is contained in:
+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/deletePriceListsStep
|
||||||
|
sidebar_label: deletePriceListsStep
|
||||||
|
---
|
||||||
|
|
||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# deletePriceListsStep - Medusa Workflows API Reference
|
||||||
|
|
||||||
|
This documentation provides a reference to the `deletePriceListsStep`. It belongs to the `@medusajs/core-flows` package.
|
||||||
|
|
||||||
|
This step deletes one or more price lists.
|
||||||
|
|
||||||
|
## Input
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"string[]","type":"`string`[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="deletePriceListsStep"/>
|
||||||
+20
@@ -0,0 +1,20 @@
|
|||||||
|
---
|
||||||
|
slug: /references/medusa-workflows/steps/getExistingPriceListsPriceIdsStep
|
||||||
|
sidebar_label: getExistingPriceListsPriceIdsStep
|
||||||
|
---
|
||||||
|
|
||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# getExistingPriceListsPriceIdsStep - Medusa Workflows API Reference
|
||||||
|
|
||||||
|
This documentation provides a reference to the `getExistingPriceListsPriceIdsStep`. It belongs to the `@medusajs/core-flows` package.
|
||||||
|
|
||||||
|
This step retrieves prices of price lists.
|
||||||
|
|
||||||
|
## Input
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"price_list_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="getExistingPriceListsPriceIdsStep"/>
|
||||||
|
|
||||||
|
## Output
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"Record","type":"`Record<string, string[]>`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"string[]","type":"`string`[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="getExistingPriceListsPriceIdsStep"/>
|
||||||
+20
@@ -0,0 +1,20 @@
|
|||||||
|
---
|
||||||
|
slug: /references/medusa-workflows/steps/removePriceListPricesStep
|
||||||
|
sidebar_label: removePriceListPricesStep
|
||||||
|
---
|
||||||
|
|
||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# removePriceListPricesStep - Medusa Workflows API Reference
|
||||||
|
|
||||||
|
This documentation provides a reference to the `removePriceListPricesStep`. It belongs to the `@medusajs/core-flows` package.
|
||||||
|
|
||||||
|
This step removes prices from a price list.
|
||||||
|
|
||||||
|
## Input
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"string[]","type":"`string`[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="removePriceListPricesStep"/>
|
||||||
|
|
||||||
|
## Output
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"string[]","type":"`string`[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="removePriceListPricesStep"/>
|
||||||
+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
@@ -0,0 +1,20 @@
|
|||||||
|
---
|
||||||
|
slug: /references/medusa-workflows/steps/validateVariantPriceLinksStep
|
||||||
|
sidebar_label: validateVariantPriceLinksStep
|
||||||
|
---
|
||||||
|
|
||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# validateVariantPriceLinksStep - Medusa Workflows API Reference
|
||||||
|
|
||||||
|
This documentation provides a reference to the `validateVariantPriceLinksStep`. It belongs to the `@medusajs/core-flows` package.
|
||||||
|
|
||||||
|
This step validates that the specified variants have prices.
|
||||||
|
|
||||||
|
## Input
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"object[]","type":"`object`[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"prices","type":"`object`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"variant_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="validateVariantPriceLinksStep"/>
|
||||||
|
|
||||||
|
## Output
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"Record","type":"`Record<string, string>`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="validateVariantPriceLinksStep"/>
|
||||||
+5
@@ -0,0 +1,5 @@
|
|||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# createPriceListPricesStepId
|
||||||
|
|
||||||
|
`Const` **createPriceListPricesStepId**: `"create-price-list-prices"`
|
||||||
+5
@@ -0,0 +1,5 @@
|
|||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# createPriceListsStepId
|
||||||
|
|
||||||
|
`Const` **createPriceListsStepId**: `"create-price-lists"`
|
||||||
+5
@@ -0,0 +1,5 @@
|
|||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# deletePriceListsStepId
|
||||||
|
|
||||||
|
`Const` **deletePriceListsStepId**: `"delete-price-lists"`
|
||||||
+5
@@ -0,0 +1,5 @@
|
|||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# getExistingPriceListsPriceIdsStepId
|
||||||
|
|
||||||
|
`Const` **getExistingPriceListsPriceIdsStepId**: `"get-existing-price-lists-prices"`
|
||||||
+5
@@ -0,0 +1,5 @@
|
|||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# removePriceListPricesStepId
|
||||||
|
|
||||||
|
`Const` **removePriceListPricesStepId**: `"remove-price-list-prices"`
|
||||||
+5
@@ -0,0 +1,5 @@
|
|||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# updatePriceListPricesStepId
|
||||||
|
|
||||||
|
`Const` **updatePriceListPricesStepId**: `"update-price-list-prices"`
|
||||||
+5
@@ -0,0 +1,5 @@
|
|||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# updatePriceListsStepId
|
||||||
|
|
||||||
|
`Const` **updatePriceListsStepId**: `"update-price-lists"`
|
||||||
+5
@@ -0,0 +1,5 @@
|
|||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# validatePriceListsStepId
|
||||||
|
|
||||||
|
`Const` **validatePriceListsStepId**: `"validate-price-lists"`
|
||||||
+5
@@ -0,0 +1,5 @@
|
|||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# validateVariantPriceLinksStepId
|
||||||
|
|
||||||
|
`Const` **validateVariantPriceLinksStepId**: `"validate-variant-price-links"`
|
||||||
+24
@@ -0,0 +1,24 @@
|
|||||||
|
---
|
||||||
|
slug: /references/medusa-workflows/batchPriceListPricesWorkflow
|
||||||
|
sidebar_label: batchPriceListPricesWorkflow
|
||||||
|
---
|
||||||
|
|
||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# batchPriceListPricesWorkflow - Medusa Workflows API Reference
|
||||||
|
|
||||||
|
This documentation provides a reference to the `batchPriceListPricesWorkflow`. It belongs to the `@medusajs/core-flows` package.
|
||||||
|
|
||||||
|
This workflow manages price lists' prices by creating, updating, or removing them.
|
||||||
|
|
||||||
|
## Steps
|
||||||
|
|
||||||
|
<WorkflowDiagram workflow={{"name":"batchPriceListPricesWorkflow","steps":[{"type":"workflow","name":"createPriceListPricesWorkflow","description":"This workflow creates prices in price lists.","link":"../../../../core_flows.Workflows_Price_List/page.mdx#createpricelistpricesworkflow","depth":1},{"type":"workflow","name":"updatePriceListPricesWorkflow","description":"This workflow update price lists' prices.","link":"../../../../core_flows.Workflows_Price_List/page.mdx#updatepricelistpricesworkflow","depth":1},{"type":"workflow","name":"removePriceListPricesWorkflow","description":"This workflow removes price lists' prices.","link":"../../../../core_flows.Workflows_Price_List/page.mdx#removepricelistpricesworkflow","depth":1}]}} />
|
||||||
|
|
||||||
|
## Input
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"data","type":"`BatchPriceListPricesWorkflowDTO`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="batchPriceListPricesWorkflow"/>
|
||||||
|
|
||||||
|
## Output
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"BatchPriceListPricesWorkflowResult","type":"`BatchPriceListPricesWorkflowResult`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="batchPriceListPricesWorkflow"/>
|
||||||
+24
File diff suppressed because one or more lines are too long
+24
File diff suppressed because one or more lines are too long
+20
@@ -0,0 +1,20 @@
|
|||||||
|
---
|
||||||
|
slug: /references/medusa-workflows/deletePriceListsWorkflow
|
||||||
|
sidebar_label: deletePriceListsWorkflow
|
||||||
|
---
|
||||||
|
|
||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# deletePriceListsWorkflow - Medusa Workflows API Reference
|
||||||
|
|
||||||
|
This documentation provides a reference to the `deletePriceListsWorkflow`. It belongs to the `@medusajs/core-flows` package.
|
||||||
|
|
||||||
|
This workflow deletes one or more price lists.
|
||||||
|
|
||||||
|
## Steps
|
||||||
|
|
||||||
|
<WorkflowDiagram workflow={{"name":"deletePriceListsWorkflow","steps":[{"type":"step","name":"deletePriceListsStep","description":"This step deletes one or more price lists.","link":"../../../../core_flows.Steps_Price_List/page.mdx#deletepricelistsstep","depth":1}]}} />
|
||||||
|
|
||||||
|
## 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="deletePriceListsWorkflow"/>
|
||||||
+24
@@ -0,0 +1,24 @@
|
|||||||
|
---
|
||||||
|
slug: /references/medusa-workflows/removePriceListPricesWorkflow
|
||||||
|
sidebar_label: removePriceListPricesWorkflow
|
||||||
|
---
|
||||||
|
|
||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# removePriceListPricesWorkflow - Medusa Workflows API Reference
|
||||||
|
|
||||||
|
This documentation provides a reference to the `removePriceListPricesWorkflow`. It belongs to the `@medusajs/core-flows` package.
|
||||||
|
|
||||||
|
This workflow removes price lists' prices.
|
||||||
|
|
||||||
|
## Steps
|
||||||
|
|
||||||
|
<WorkflowDiagram workflow={{"name":"removePriceListPricesWorkflow","steps":[{"type":"step","name":"removePriceListPricesStep","description":"This step removes prices from a price list.","link":"../../../../core_flows.Steps_Price_List/page.mdx#removepricelistpricesstep","depth":1}]}} />
|
||||||
|
|
||||||
|
## 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="removePriceListPricesWorkflow"/>
|
||||||
|
|
||||||
|
## Output
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"string[]","type":"`string`[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="removePriceListPricesWorkflow"/>
|
||||||
+24
File diff suppressed because one or more lines are too long
+20
@@ -0,0 +1,20 @@
|
|||||||
|
---
|
||||||
|
slug: /references/medusa-workflows/updatePriceListsWorkflow
|
||||||
|
sidebar_label: updatePriceListsWorkflow
|
||||||
|
---
|
||||||
|
|
||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# updatePriceListsWorkflow - Medusa Workflows API Reference
|
||||||
|
|
||||||
|
This documentation provides a reference to the `updatePriceListsWorkflow`. It belongs to the `@medusajs/core-flows` package.
|
||||||
|
|
||||||
|
This workflow updates one or more price lists.
|
||||||
|
|
||||||
|
## Steps
|
||||||
|
|
||||||
|
<WorkflowDiagram workflow={{"name":"updatePriceListsWorkflow","steps":[{"type":"step","name":"validatePriceListsStep","description":"This step validates that the specified price lists exist.","link":"../../../../core_flows.Steps_Price_List/page.mdx#validatepricelistsstep","depth":1},{"type":"step","name":"updatePriceListsStep","description":"This step updates one or more price lists.","link":"../../../../core_flows.Steps_Price_List/page.mdx#updatepricelistsstep","depth":2}]}} />
|
||||||
|
|
||||||
|
## Input
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"price_lists_data","type":"`UpdatePriceListWorkflowInputDTO`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updatePriceListsWorkflow"/>
|
||||||
+5
@@ -0,0 +1,5 @@
|
|||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# batchPriceListPricesWorkflowId
|
||||||
|
|
||||||
|
`Const` **batchPriceListPricesWorkflowId**: `"batch-price-list-prices"`
|
||||||
+5
@@ -0,0 +1,5 @@
|
|||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# createPriceListPricesWorkflowId
|
||||||
|
|
||||||
|
`Const` **createPriceListPricesWorkflowId**: `"create-price-list-prices"`
|
||||||
+5
@@ -0,0 +1,5 @@
|
|||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# createPriceListsWorkflowId
|
||||||
|
|
||||||
|
`Const` **createPriceListsWorkflowId**: `"create-price-lists"`
|
||||||
+5
@@ -0,0 +1,5 @@
|
|||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# deletePriceListsWorkflowId
|
||||||
|
|
||||||
|
`Const` **deletePriceListsWorkflowId**: `"delete-price-lists"`
|
||||||
+5
@@ -0,0 +1,5 @@
|
|||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# removePriceListPricesWorkflowId
|
||||||
|
|
||||||
|
`Const` **removePriceListPricesWorkflowId**: `"remove-price-list-prices"`
|
||||||
+5
@@ -0,0 +1,5 @@
|
|||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# updatePriceListPricesWorkflowId
|
||||||
|
|
||||||
|
`Const` **updatePriceListPricesWorkflowId**: `"update-price-list-prices"`
|
||||||
+5
@@ -0,0 +1,5 @@
|
|||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# updatePriceListsWorkflowId
|
||||||
|
|
||||||
|
`Const` **updatePriceListsWorkflowId**: `"update-price-lists"`
|
||||||
+123
File diff suppressed because one or more lines are too long
+119
File diff suppressed because one or more lines are too long
+20
@@ -0,0 +1,20 @@
|
|||||||
|
---
|
||||||
|
slug: /references/medusa-workflows/steps/createPricePreferencesStep
|
||||||
|
sidebar_label: createPricePreferencesStep
|
||||||
|
---
|
||||||
|
|
||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# createPricePreferencesStep - Medusa Workflows API Reference
|
||||||
|
|
||||||
|
This documentation provides a reference to the `createPricePreferencesStep`. It belongs to the `@medusajs/core-flows` package.
|
||||||
|
|
||||||
|
This step creates one or more price preferences.
|
||||||
|
|
||||||
|
## Input
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"CreatePricePreferencesWorkflowInput[]","type":"`CreatePricePreferencesWorkflowInput`[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"CreatePricePreferencesWorkflowInput","type":"`CreatePricePreferencesWorkflowInput`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createPricePreferencesStep"/>
|
||||||
|
|
||||||
|
## Output
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"PricePreferenceDTO[]","type":"[PricePreferenceDTO](../../../../../pricing/interfaces/pricing.PricePreferenceDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"PricePreferenceDTO","type":"[PricePreferenceDTO](../../../../../pricing/interfaces/pricing.PricePreferenceDTO/page.mdx)","optional":false,"defaultValue":"","description":"A price preference's data.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of a price preference.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`null` \\| `string`","description":"The rule attribute for the preference","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`null` \\| `string`","description":"The rule value for the preference","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`boolean`","description":"Flag specifying whether prices for the specified rule are tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"When the price preference was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"When the price preference was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"When the price preference was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createPricePreferencesStep"/>
|
||||||
+20
File diff suppressed because one or more lines are too long
+16
@@ -0,0 +1,16 @@
|
|||||||
|
---
|
||||||
|
slug: /references/medusa-workflows/steps/deletePricePreferencesStep
|
||||||
|
sidebar_label: deletePricePreferencesStep
|
||||||
|
---
|
||||||
|
|
||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# deletePricePreferencesStep - Medusa Workflows API Reference
|
||||||
|
|
||||||
|
This documentation provides a reference to the `deletePricePreferencesStep`. It belongs to the `@medusajs/core-flows` package.
|
||||||
|
|
||||||
|
This step deletes one or more price preferences.
|
||||||
|
|
||||||
|
## Input
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"string[]","type":"`string`[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="deletePricePreferencesStep"/>
|
||||||
+20
@@ -0,0 +1,20 @@
|
|||||||
|
---
|
||||||
|
slug: /references/medusa-workflows/steps/updatePricePreferencesAsArrayStep
|
||||||
|
sidebar_label: updatePricePreferencesAsArrayStep
|
||||||
|
---
|
||||||
|
|
||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# updatePricePreferencesAsArrayStep - Medusa Workflows API Reference
|
||||||
|
|
||||||
|
This documentation provides a reference to the `updatePricePreferencesAsArrayStep`. It belongs to the `@medusajs/core-flows` package.
|
||||||
|
|
||||||
|
This step updates price preferences.
|
||||||
|
|
||||||
|
## Input
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"UpdatePricePreferencesAsArrayStepInput","type":"[UpdatePricePreferencesAsArrayStepInput](../../../../types/core_flows.UpdatePricePreferencesAsArrayStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"UpdatePricePreferencesAsArrayStepInput","type":"`PricingWorkflow.UpdatePricePreferencesWorkflowInput`[`\"update\"`][]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updatePricePreferencesAsArrayStep"/>
|
||||||
|
|
||||||
|
## Output
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"PricePreferenceDTO[]","type":"[PricePreferenceDTO](../../../../../pricing/interfaces/pricing.PricePreferenceDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"PricePreferenceDTO","type":"[PricePreferenceDTO](../../../../../pricing/interfaces/pricing.PricePreferenceDTO/page.mdx)","optional":false,"defaultValue":"","description":"A price preference's data.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of a price preference.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`null` \\| `string`","description":"The rule attribute for the preference","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`null` \\| `string`","description":"The rule value for the preference","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`boolean`","description":"Flag specifying whether prices for the specified rule are tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"When the price preference was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"When the price preference was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"When the price preference was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updatePricePreferencesAsArrayStep"/>
|
||||||
+20
@@ -0,0 +1,20 @@
|
|||||||
|
---
|
||||||
|
slug: /references/medusa-workflows/steps/updatePricePreferencesStep
|
||||||
|
sidebar_label: updatePricePreferencesStep
|
||||||
|
---
|
||||||
|
|
||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# updatePricePreferencesStep - Medusa Workflows API Reference
|
||||||
|
|
||||||
|
This documentation provides a reference to the `updatePricePreferencesStep`. It belongs to the `@medusajs/core-flows` package.
|
||||||
|
|
||||||
|
This step updates price preferences matching the specified filters.
|
||||||
|
|
||||||
|
## Input
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"UpdatePricePreferencesWorkflowInput","type":"`UpdatePricePreferencesWorkflowInput`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updatePricePreferencesStep"/>
|
||||||
|
|
||||||
|
## Output
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"PricePreferenceDTO[]","type":"[PricePreferenceDTO](../../../../../pricing/interfaces/pricing.PricePreferenceDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"PricePreferenceDTO","type":"[PricePreferenceDTO](../../../../../pricing/interfaces/pricing.PricePreferenceDTO/page.mdx)","optional":false,"defaultValue":"","description":"A price preference's data.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of a price preference.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`null` \\| `string`","description":"The rule attribute for the preference","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`null` \\| `string`","description":"The rule value for the preference","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`boolean`","description":"Flag specifying whether prices for the specified rule are tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"When the price preference was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"When the price preference was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"When the price preference was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updatePricePreferencesStep"/>
|
||||||
+20
File diff suppressed because one or more lines are too long
+5
@@ -0,0 +1,5 @@
|
|||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# createPricePreferencesStepId
|
||||||
|
|
||||||
|
`Const` **createPricePreferencesStepId**: `"create-price-preferences"`
|
||||||
+5
@@ -0,0 +1,5 @@
|
|||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# createPriceSetsStepId
|
||||||
|
|
||||||
|
`Const` **createPriceSetsStepId**: `"create-price-sets"`
|
||||||
+5
@@ -0,0 +1,5 @@
|
|||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# deletePricePreferencesStepId
|
||||||
|
|
||||||
|
`Const` **deletePricePreferencesStepId**: `"delete-price-preferences"`
|
||||||
+5
@@ -0,0 +1,5 @@
|
|||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# updatePricePreferencesAsArrayStepId
|
||||||
|
|
||||||
|
`Const` **updatePricePreferencesAsArrayStepId**: `"update-price-preferences-as-array"`
|
||||||
+5
@@ -0,0 +1,5 @@
|
|||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# updatePricePreferencesStepId
|
||||||
|
|
||||||
|
`Const` **updatePricePreferencesStepId**: `"update-price-preferences"`
|
||||||
+5
@@ -0,0 +1,5 @@
|
|||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# updatePriceSetsStepId
|
||||||
|
|
||||||
|
`Const` **updatePriceSetsStepId**: `"update-price-sets"`
|
||||||
+24
@@ -0,0 +1,24 @@
|
|||||||
|
---
|
||||||
|
slug: /references/medusa-workflows/createPricePreferencesWorkflow
|
||||||
|
sidebar_label: createPricePreferencesWorkflow
|
||||||
|
---
|
||||||
|
|
||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# createPricePreferencesWorkflow - Medusa Workflows API Reference
|
||||||
|
|
||||||
|
This documentation provides a reference to the `createPricePreferencesWorkflow`. It belongs to the `@medusajs/core-flows` package.
|
||||||
|
|
||||||
|
This workflow creates one or more price preferences.
|
||||||
|
|
||||||
|
## Steps
|
||||||
|
|
||||||
|
<WorkflowDiagram workflow={{"name":"createPricePreferencesWorkflow","steps":[{"type":"step","name":"createPricePreferencesStep","description":"This step creates one or more price preferences.","link":"../../../../core_flows.Steps_Pricing/page.mdx#createpricepreferencesstep","depth":1}]}} />
|
||||||
|
|
||||||
|
## Input
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"CreatePricePreferencesWorkflowInput[]","type":"`CreatePricePreferencesWorkflowInput`[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"CreatePricePreferencesWorkflowInput","type":"`CreatePricePreferencesWorkflowInput`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createPricePreferencesWorkflow"/>
|
||||||
|
|
||||||
|
## Output
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"PricePreferenceDTO[]","type":"[PricePreferenceDTO](../../../../../pricing/interfaces/pricing.PricePreferenceDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"PricePreferenceDTO","type":"[PricePreferenceDTO](../../../../../pricing/interfaces/pricing.PricePreferenceDTO/page.mdx)","optional":false,"defaultValue":"","description":"A price preference's data.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of a price preference.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`null` \\| `string`","description":"The rule attribute for the preference","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`null` \\| `string`","description":"The rule value for the preference","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`boolean`","description":"Flag specifying whether prices for the specified rule are tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"When the price preference was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"When the price preference was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"When the price preference was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createPricePreferencesWorkflow"/>
|
||||||
+20
@@ -0,0 +1,20 @@
|
|||||||
|
---
|
||||||
|
slug: /references/medusa-workflows/deletePricePreferencesWorkflow
|
||||||
|
sidebar_label: deletePricePreferencesWorkflow
|
||||||
|
---
|
||||||
|
|
||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# deletePricePreferencesWorkflow - Medusa Workflows API Reference
|
||||||
|
|
||||||
|
This documentation provides a reference to the `deletePricePreferencesWorkflow`. It belongs to the `@medusajs/core-flows` package.
|
||||||
|
|
||||||
|
This workflow deletes one or more price preferences.
|
||||||
|
|
||||||
|
## Steps
|
||||||
|
|
||||||
|
<WorkflowDiagram workflow={{"name":"deletePricePreferencesWorkflow","steps":[{"type":"step","name":"deletePricePreferencesStep","description":"This step deletes one or more price preferences.","link":"../../../../core_flows.Steps_Pricing/page.mdx#deletepricepreferencesstep","depth":1}]}} />
|
||||||
|
|
||||||
|
## Input
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"string[]","type":"`string`[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="deletePricePreferencesWorkflow"/>
|
||||||
+24
@@ -0,0 +1,24 @@
|
|||||||
|
---
|
||||||
|
slug: /references/medusa-workflows/updatePricePreferencesWorkflow
|
||||||
|
sidebar_label: updatePricePreferencesWorkflow
|
||||||
|
---
|
||||||
|
|
||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# updatePricePreferencesWorkflow - Medusa Workflows API Reference
|
||||||
|
|
||||||
|
This documentation provides a reference to the `updatePricePreferencesWorkflow`. It belongs to the `@medusajs/core-flows` package.
|
||||||
|
|
||||||
|
This workflow updates one or more price preferences.
|
||||||
|
|
||||||
|
## Steps
|
||||||
|
|
||||||
|
<WorkflowDiagram workflow={{"name":"updatePricePreferencesWorkflow","steps":[{"type":"step","name":"updatePricePreferencesStep","description":"This step updates price preferences matching the specified filters.","link":"../../../../core_flows.Steps_Pricing/page.mdx#updatepricepreferencesstep","depth":1}]}} />
|
||||||
|
|
||||||
|
## Input
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"UpdatePricePreferencesWorkflowInput","type":"`UpdatePricePreferencesWorkflowInput`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updatePricePreferencesWorkflow"/>
|
||||||
|
|
||||||
|
## Output
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"PricePreferenceDTO[]","type":"[PricePreferenceDTO](../../../../../pricing/interfaces/pricing.PricePreferenceDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"PricePreferenceDTO","type":"[PricePreferenceDTO](../../../../../pricing/interfaces/pricing.PricePreferenceDTO/page.mdx)","optional":false,"defaultValue":"","description":"A price preference's data.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of a price preference.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`null` \\| `string`","description":"The rule attribute for the preference","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`null` \\| `string`","description":"The rule value for the preference","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`boolean`","description":"Flag specifying whether prices for the specified rule are tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"When the price preference was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"When the price preference was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"When the price preference was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updatePricePreferencesWorkflow"/>
|
||||||
+5
@@ -0,0 +1,5 @@
|
|||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# createPricePreferencesWorkflowId
|
||||||
|
|
||||||
|
`Const` **createPricePreferencesWorkflowId**: `"create-price-preferences"`
|
||||||
+5
@@ -0,0 +1,5 @@
|
|||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# deletePricePreferencesWorkflowId
|
||||||
|
|
||||||
|
`Const` **deletePricePreferencesWorkflowId**: `"delete-price-preferences"`
|
||||||
+5
@@ -0,0 +1,5 @@
|
|||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# updatePricePreferencesWorkflowId
|
||||||
|
|
||||||
|
`Const` **updatePricePreferencesWorkflowId**: `"update-price-preferences"`
|
||||||
+81
File diff suppressed because one or more lines are too long
+51
@@ -0,0 +1,51 @@
|
|||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# Workflows\_Pricing
|
||||||
|
|
||||||
|
## createPricePreferencesWorkflow
|
||||||
|
|
||||||
|
This workflow creates one or more price preferences.
|
||||||
|
|
||||||
|
### Steps
|
||||||
|
|
||||||
|
<WorkflowDiagram workflow={{"name":"createPricePreferencesWorkflow","steps":[{"type":"step","name":"createPricePreferencesStep","description":"This step creates one or more price preferences.","link":"../../core_flows.Steps_Pricing/page.mdx#createpricepreferencesstep","depth":1}]}} />
|
||||||
|
|
||||||
|
### Input
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"CreatePricePreferencesWorkflowInput[]","type":"`CreatePricePreferencesWorkflowInput`[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"CreatePricePreferencesWorkflowInput","type":"`CreatePricePreferencesWorkflowInput`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createPricePreferencesWorkflow"/>
|
||||||
|
|
||||||
|
### Output
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"PricePreferenceDTO[]","type":"[PricePreferenceDTO](../../../pricing/interfaces/pricing.PricePreferenceDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"PricePreferenceDTO","type":"[PricePreferenceDTO](../../../pricing/interfaces/pricing.PricePreferenceDTO/page.mdx)","optional":false,"defaultValue":"","description":"A price preference's data.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of a price preference.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`null` \\| `string`","description":"The rule attribute for the preference","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`null` \\| `string`","description":"The rule value for the preference","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`boolean`","description":"Flag specifying whether prices for the specified rule are tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"When the price preference was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"When the price preference was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"When the price preference was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createPricePreferencesWorkflow"/>
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
## deletePricePreferencesWorkflow
|
||||||
|
|
||||||
|
This workflow deletes one or more price preferences.
|
||||||
|
|
||||||
|
### Steps
|
||||||
|
|
||||||
|
<WorkflowDiagram workflow={{"name":"deletePricePreferencesWorkflow","steps":[{"type":"step","name":"deletePricePreferencesStep","description":"This step deletes one or more price preferences.","link":"../../core_flows.Steps_Pricing/page.mdx#deletepricepreferencesstep","depth":1}]}} />
|
||||||
|
|
||||||
|
### Input
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"string[]","type":"`string`[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="deletePricePreferencesWorkflow"/>
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
## updatePricePreferencesWorkflow
|
||||||
|
|
||||||
|
This workflow updates one or more price preferences.
|
||||||
|
|
||||||
|
### Steps
|
||||||
|
|
||||||
|
<WorkflowDiagram workflow={{"name":"updatePricePreferencesWorkflow","steps":[{"type":"step","name":"updatePricePreferencesStep","description":"This step updates price preferences matching the specified filters.","link":"../../core_flows.Steps_Pricing/page.mdx#updatepricepreferencesstep","depth":1}]}} />
|
||||||
|
|
||||||
|
### Input
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"UpdatePricePreferencesWorkflowInput","type":"`UpdatePricePreferencesWorkflowInput`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updatePricePreferencesWorkflow"/>
|
||||||
|
|
||||||
|
### Output
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"PricePreferenceDTO[]","type":"[PricePreferenceDTO](../../../pricing/interfaces/pricing.PricePreferenceDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"PricePreferenceDTO","type":"[PricePreferenceDTO](../../../pricing/interfaces/pricing.PricePreferenceDTO/page.mdx)","optional":false,"defaultValue":"","description":"A price preference's data.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of a price preference.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`null` \\| `string`","description":"The rule attribute for the preference","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`null` \\| `string`","description":"The rule value for the preference","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`boolean`","description":"Flag specifying whether prices for the specified rule are tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"When the price preference was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"When the price preference was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"When the price preference was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updatePricePreferencesWorkflow"/>
|
||||||
+20
File diff suppressed because one or more lines are too long
+16
@@ -0,0 +1,16 @@
|
|||||||
|
---
|
||||||
|
slug: /references/medusa-workflows/steps/deleteReturnReasonStep
|
||||||
|
sidebar_label: deleteReturnReasonStep
|
||||||
|
---
|
||||||
|
|
||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# deleteReturnReasonStep - Medusa Workflows API Reference
|
||||||
|
|
||||||
|
This documentation provides a reference to the `deleteReturnReasonStep`. It belongs to the `@medusajs/core-flows` package.
|
||||||
|
|
||||||
|
This step deletes one or more return reasons.
|
||||||
|
|
||||||
|
## Input
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"string[]","type":"`string`[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="deleteReturnReasonStep"/>
|
||||||
+20
File diff suppressed because one or more lines are too long
+5
@@ -0,0 +1,5 @@
|
|||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# createReturnReasonsStepId
|
||||||
|
|
||||||
|
`Const` **createReturnReasonsStepId**: `"create-return-reasons"`
|
||||||
+5
@@ -0,0 +1,5 @@
|
|||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# deleteReturnReasonStepId
|
||||||
|
|
||||||
|
`Const` **deleteReturnReasonStepId**: `"delete-return-reasons"`
|
||||||
+5
@@ -0,0 +1,5 @@
|
|||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# updateReturnReasonStepId
|
||||||
|
|
||||||
|
`Const` **updateReturnReasonStepId**: `"update-return-reasons"`
|
||||||
+24
File diff suppressed because one or more lines are too long
+20
@@ -0,0 +1,20 @@
|
|||||||
|
---
|
||||||
|
slug: /references/medusa-workflows/deleteReturnReasonsWorkflow
|
||||||
|
sidebar_label: deleteReturnReasonsWorkflow
|
||||||
|
---
|
||||||
|
|
||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# deleteReturnReasonsWorkflow - Medusa Workflows API Reference
|
||||||
|
|
||||||
|
This documentation provides a reference to the `deleteReturnReasonsWorkflow`. It belongs to the `@medusajs/core-flows` package.
|
||||||
|
|
||||||
|
This workflow deletes one or more return reasons.
|
||||||
|
|
||||||
|
## Steps
|
||||||
|
|
||||||
|
<WorkflowDiagram workflow={{"name":"deleteReturnReasonsWorkflow","steps":[{"type":"step","name":"deleteReturnReasonStep","description":"This step deletes one or more return reasons.","link":"../../../../core_flows.Steps_Return_Reason/page.mdx#deletereturnreasonstep","depth":1}]}} />
|
||||||
|
|
||||||
|
## Input
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"DeleteReturnReasonsWorkflowInput","type":"[DeleteReturnReasonsWorkflowInput](../../../../types/core_flows.DeleteReturnReasonsWorkflowInput/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="deleteReturnReasonsWorkflow"/>
|
||||||
+24
File diff suppressed because one or more lines are too long
+5
@@ -0,0 +1,5 @@
|
|||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# createReturnReasonsWorkflowId
|
||||||
|
|
||||||
|
`Const` **createReturnReasonsWorkflowId**: `"create-return-reasons"`
|
||||||
+5
@@ -0,0 +1,5 @@
|
|||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# deleteReturnReasonsWorkflowId
|
||||||
|
|
||||||
|
`Const` **deleteReturnReasonsWorkflowId**: `"delete-return-reasons"`
|
||||||
+5
@@ -0,0 +1,5 @@
|
|||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# updateReturnReasonsWorkflowId
|
||||||
|
|
||||||
|
`Const` **updateReturnReasonsWorkflowId**: `"update-return-reasons"`
|
||||||
+39
File diff suppressed because one or more lines are too long
+51
File diff suppressed because one or more lines are too long
@@ -0,0 +1,8 @@
|
|||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# Price List
|
||||||
|
|
||||||
|
## Namespaces
|
||||||
|
|
||||||
|
- [Steps\_Price List](../core_flows.Steps_Price_List/page.mdx)
|
||||||
|
- [Workflows\_Price List](../core_flows.Workflows_Price_List/page.mdx)
|
||||||
@@ -0,0 +1,8 @@
|
|||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# Pricing
|
||||||
|
|
||||||
|
## Namespaces
|
||||||
|
|
||||||
|
- [Steps\_Pricing](../core_flows.Steps_Pricing/page.mdx)
|
||||||
|
- [Workflows\_Pricing](../core_flows.Workflows_Pricing/page.mdx)
|
||||||
@@ -0,0 +1,8 @@
|
|||||||
|
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||||
|
|
||||||
|
# Return Reason
|
||||||
|
|
||||||
|
## Namespaces
|
||||||
|
|
||||||
|
- [Steps\_Return Reason](../core_flows.Steps_Return_Reason/page.mdx)
|
||||||
|
- [Workflows\_Return Reason](../core_flows.Workflows_Return_Reason/page.mdx)
|
||||||
Reference in New Issue
Block a user