From 842c26cb46f453431e975d58e89c1cb8c82c2acc Mon Sep 17 00:00:00 2001 From: Shahed Nasser Date: Tue, 27 Aug 2024 12:22:48 +0300 Subject: [PATCH] docs: [9/n] generate core-flows reference (#8790) --- .../page.mdx | 20 +++ .../page.mdx | 20 +++ .../page.mdx | 16 +++ .../page.mdx | 20 +++ .../page.mdx | 20 +++ .../page.mdx | 20 +++ .../page.mdx | 20 +++ .../page.mdx | 20 +++ .../page.mdx | 20 +++ .../page.mdx | 5 + .../page.mdx | 5 + .../page.mdx | 5 + .../page.mdx | 5 + .../page.mdx | 5 + .../page.mdx | 5 + .../page.mdx | 5 + .../page.mdx | 5 + .../page.mdx | 5 + .../page.mdx | 24 ++++ .../page.mdx | 24 ++++ .../page.mdx | 24 ++++ .../page.mdx | 20 +++ .../page.mdx | 24 ++++ .../page.mdx | 24 ++++ .../page.mdx | 20 +++ .../page.mdx | 5 + .../page.mdx | 5 + .../page.mdx | 5 + .../page.mdx | 5 + .../page.mdx | 5 + .../page.mdx | 5 + .../page.mdx | 5 + .../page.mdx | 123 ++++++++++++++++++ .../page.mdx | 119 +++++++++++++++++ .../page.mdx | 20 +++ .../page.mdx | 20 +++ .../page.mdx | 16 +++ .../page.mdx | 20 +++ .../page.mdx | 20 +++ .../page.mdx | 20 +++ .../page.mdx | 5 + .../page.mdx | 5 + .../page.mdx | 5 + .../page.mdx | 5 + .../page.mdx | 5 + .../page.mdx | 5 + .../page.mdx | 24 ++++ .../page.mdx | 20 +++ .../page.mdx | 24 ++++ .../page.mdx | 5 + .../page.mdx | 5 + .../page.mdx | 5 + .../core_flows.Pricing.Steps_Pricing/page.mdx | 81 ++++++++++++ .../page.mdx | 51 ++++++++ .../page.mdx | 20 +++ .../page.mdx | 16 +++ .../page.mdx | 20 +++ .../page.mdx | 5 + .../page.mdx | 5 + .../page.mdx | 5 + .../page.mdx | 24 ++++ .../page.mdx | 20 +++ .../page.mdx | 24 ++++ .../page.mdx | 5 + .../page.mdx | 5 + .../page.mdx | 5 + .../page.mdx | 39 ++++++ .../page.mdx | 51 ++++++++ .../core_flows/core_flows.Price_List/page.mdx | 8 ++ .../core_flows/core_flows.Pricing/page.mdx | 8 ++ .../core_flows.Return_Reason/page.mdx | 8 ++ 71 files changed, 1287 insertions(+) create mode 100644 www/apps/resources/references/core_flows/Price_List/Steps_Price_List/functions/core_flows.Price_List.Steps_Price_List.createPriceListPricesStep/page.mdx create mode 100644 www/apps/resources/references/core_flows/Price_List/Steps_Price_List/functions/core_flows.Price_List.Steps_Price_List.createPriceListsStep/page.mdx create mode 100644 www/apps/resources/references/core_flows/Price_List/Steps_Price_List/functions/core_flows.Price_List.Steps_Price_List.deletePriceListsStep/page.mdx create mode 100644 www/apps/resources/references/core_flows/Price_List/Steps_Price_List/functions/core_flows.Price_List.Steps_Price_List.getExistingPriceListsPriceIdsStep/page.mdx create mode 100644 www/apps/resources/references/core_flows/Price_List/Steps_Price_List/functions/core_flows.Price_List.Steps_Price_List.removePriceListPricesStep/page.mdx create mode 100644 www/apps/resources/references/core_flows/Price_List/Steps_Price_List/functions/core_flows.Price_List.Steps_Price_List.updatePriceListPricesStep/page.mdx create mode 100644 www/apps/resources/references/core_flows/Price_List/Steps_Price_List/functions/core_flows.Price_List.Steps_Price_List.updatePriceListsStep/page.mdx create mode 100644 www/apps/resources/references/core_flows/Price_List/Steps_Price_List/functions/core_flows.Price_List.Steps_Price_List.validatePriceListsStep/page.mdx create mode 100644 www/apps/resources/references/core_flows/Price_List/Steps_Price_List/functions/core_flows.Price_List.Steps_Price_List.validateVariantPriceLinksStep/page.mdx create mode 100644 www/apps/resources/references/core_flows/Price_List/Steps_Price_List/variables/core_flows.Price_List.Steps_Price_List.createPriceListPricesStepId/page.mdx create mode 100644 www/apps/resources/references/core_flows/Price_List/Steps_Price_List/variables/core_flows.Price_List.Steps_Price_List.createPriceListsStepId/page.mdx create mode 100644 www/apps/resources/references/core_flows/Price_List/Steps_Price_List/variables/core_flows.Price_List.Steps_Price_List.deletePriceListsStepId/page.mdx create mode 100644 www/apps/resources/references/core_flows/Price_List/Steps_Price_List/variables/core_flows.Price_List.Steps_Price_List.getExistingPriceListsPriceIdsStepId/page.mdx create mode 100644 www/apps/resources/references/core_flows/Price_List/Steps_Price_List/variables/core_flows.Price_List.Steps_Price_List.removePriceListPricesStepId/page.mdx create mode 100644 www/apps/resources/references/core_flows/Price_List/Steps_Price_List/variables/core_flows.Price_List.Steps_Price_List.updatePriceListPricesStepId/page.mdx create mode 100644 www/apps/resources/references/core_flows/Price_List/Steps_Price_List/variables/core_flows.Price_List.Steps_Price_List.updatePriceListsStepId/page.mdx create mode 100644 www/apps/resources/references/core_flows/Price_List/Steps_Price_List/variables/core_flows.Price_List.Steps_Price_List.validatePriceListsStepId/page.mdx create mode 100644 www/apps/resources/references/core_flows/Price_List/Steps_Price_List/variables/core_flows.Price_List.Steps_Price_List.validateVariantPriceLinksStepId/page.mdx create mode 100644 www/apps/resources/references/core_flows/Price_List/Workflows_Price_List/functions/core_flows.Price_List.Workflows_Price_List.batchPriceListPricesWorkflow/page.mdx create mode 100644 www/apps/resources/references/core_flows/Price_List/Workflows_Price_List/functions/core_flows.Price_List.Workflows_Price_List.createPriceListPricesWorkflow/page.mdx create mode 100644 www/apps/resources/references/core_flows/Price_List/Workflows_Price_List/functions/core_flows.Price_List.Workflows_Price_List.createPriceListsWorkflow/page.mdx create mode 100644 www/apps/resources/references/core_flows/Price_List/Workflows_Price_List/functions/core_flows.Price_List.Workflows_Price_List.deletePriceListsWorkflow/page.mdx create mode 100644 www/apps/resources/references/core_flows/Price_List/Workflows_Price_List/functions/core_flows.Price_List.Workflows_Price_List.removePriceListPricesWorkflow/page.mdx create mode 100644 www/apps/resources/references/core_flows/Price_List/Workflows_Price_List/functions/core_flows.Price_List.Workflows_Price_List.updatePriceListPricesWorkflow/page.mdx create mode 100644 www/apps/resources/references/core_flows/Price_List/Workflows_Price_List/functions/core_flows.Price_List.Workflows_Price_List.updatePriceListsWorkflow/page.mdx create mode 100644 www/apps/resources/references/core_flows/Price_List/Workflows_Price_List/variables/core_flows.Price_List.Workflows_Price_List.batchPriceListPricesWorkflowId/page.mdx create mode 100644 www/apps/resources/references/core_flows/Price_List/Workflows_Price_List/variables/core_flows.Price_List.Workflows_Price_List.createPriceListPricesWorkflowId/page.mdx create mode 100644 www/apps/resources/references/core_flows/Price_List/Workflows_Price_List/variables/core_flows.Price_List.Workflows_Price_List.createPriceListsWorkflowId/page.mdx create mode 100644 www/apps/resources/references/core_flows/Price_List/Workflows_Price_List/variables/core_flows.Price_List.Workflows_Price_List.deletePriceListsWorkflowId/page.mdx create mode 100644 www/apps/resources/references/core_flows/Price_List/Workflows_Price_List/variables/core_flows.Price_List.Workflows_Price_List.removePriceListPricesWorkflowId/page.mdx create mode 100644 www/apps/resources/references/core_flows/Price_List/Workflows_Price_List/variables/core_flows.Price_List.Workflows_Price_List.updatePriceListPricesWorkflowId/page.mdx create mode 100644 www/apps/resources/references/core_flows/Price_List/Workflows_Price_List/variables/core_flows.Price_List.Workflows_Price_List.updatePriceListsWorkflowId/page.mdx create mode 100644 www/apps/resources/references/core_flows/Price_List/core_flows.Price_List.Steps_Price_List/page.mdx create mode 100644 www/apps/resources/references/core_flows/Price_List/core_flows.Price_List.Workflows_Price_List/page.mdx create mode 100644 www/apps/resources/references/core_flows/Pricing/Steps_Pricing/functions/core_flows.Pricing.Steps_Pricing.createPricePreferencesStep/page.mdx create mode 100644 www/apps/resources/references/core_flows/Pricing/Steps_Pricing/functions/core_flows.Pricing.Steps_Pricing.createPriceSetsStep/page.mdx create mode 100644 www/apps/resources/references/core_flows/Pricing/Steps_Pricing/functions/core_flows.Pricing.Steps_Pricing.deletePricePreferencesStep/page.mdx create mode 100644 www/apps/resources/references/core_flows/Pricing/Steps_Pricing/functions/core_flows.Pricing.Steps_Pricing.updatePricePreferencesAsArrayStep/page.mdx create mode 100644 www/apps/resources/references/core_flows/Pricing/Steps_Pricing/functions/core_flows.Pricing.Steps_Pricing.updatePricePreferencesStep/page.mdx create mode 100644 www/apps/resources/references/core_flows/Pricing/Steps_Pricing/functions/core_flows.Pricing.Steps_Pricing.updatePriceSetsStep/page.mdx create mode 100644 www/apps/resources/references/core_flows/Pricing/Steps_Pricing/variables/core_flows.Pricing.Steps_Pricing.createPricePreferencesStepId/page.mdx create mode 100644 www/apps/resources/references/core_flows/Pricing/Steps_Pricing/variables/core_flows.Pricing.Steps_Pricing.createPriceSetsStepId/page.mdx create mode 100644 www/apps/resources/references/core_flows/Pricing/Steps_Pricing/variables/core_flows.Pricing.Steps_Pricing.deletePricePreferencesStepId/page.mdx create mode 100644 www/apps/resources/references/core_flows/Pricing/Steps_Pricing/variables/core_flows.Pricing.Steps_Pricing.updatePricePreferencesAsArrayStepId/page.mdx create mode 100644 www/apps/resources/references/core_flows/Pricing/Steps_Pricing/variables/core_flows.Pricing.Steps_Pricing.updatePricePreferencesStepId/page.mdx create mode 100644 www/apps/resources/references/core_flows/Pricing/Steps_Pricing/variables/core_flows.Pricing.Steps_Pricing.updatePriceSetsStepId/page.mdx create mode 100644 www/apps/resources/references/core_flows/Pricing/Workflows_Pricing/functions/core_flows.Pricing.Workflows_Pricing.createPricePreferencesWorkflow/page.mdx create mode 100644 www/apps/resources/references/core_flows/Pricing/Workflows_Pricing/functions/core_flows.Pricing.Workflows_Pricing.deletePricePreferencesWorkflow/page.mdx create mode 100644 www/apps/resources/references/core_flows/Pricing/Workflows_Pricing/functions/core_flows.Pricing.Workflows_Pricing.updatePricePreferencesWorkflow/page.mdx create mode 100644 www/apps/resources/references/core_flows/Pricing/Workflows_Pricing/variables/core_flows.Pricing.Workflows_Pricing.createPricePreferencesWorkflowId/page.mdx create mode 100644 www/apps/resources/references/core_flows/Pricing/Workflows_Pricing/variables/core_flows.Pricing.Workflows_Pricing.deletePricePreferencesWorkflowId/page.mdx create mode 100644 www/apps/resources/references/core_flows/Pricing/Workflows_Pricing/variables/core_flows.Pricing.Workflows_Pricing.updatePricePreferencesWorkflowId/page.mdx create mode 100644 www/apps/resources/references/core_flows/Pricing/core_flows.Pricing.Steps_Pricing/page.mdx create mode 100644 www/apps/resources/references/core_flows/Pricing/core_flows.Pricing.Workflows_Pricing/page.mdx create mode 100644 www/apps/resources/references/core_flows/Return_Reason/Steps_Return_Reason/functions/core_flows.Return_Reason.Steps_Return_Reason.createReturnReasonsStep/page.mdx create mode 100644 www/apps/resources/references/core_flows/Return_Reason/Steps_Return_Reason/functions/core_flows.Return_Reason.Steps_Return_Reason.deleteReturnReasonStep/page.mdx create mode 100644 www/apps/resources/references/core_flows/Return_Reason/Steps_Return_Reason/functions/core_flows.Return_Reason.Steps_Return_Reason.updateReturnReasonsStep/page.mdx create mode 100644 www/apps/resources/references/core_flows/Return_Reason/Steps_Return_Reason/variables/core_flows.Return_Reason.Steps_Return_Reason.createReturnReasonsStepId/page.mdx create mode 100644 www/apps/resources/references/core_flows/Return_Reason/Steps_Return_Reason/variables/core_flows.Return_Reason.Steps_Return_Reason.deleteReturnReasonStepId/page.mdx create mode 100644 www/apps/resources/references/core_flows/Return_Reason/Steps_Return_Reason/variables/core_flows.Return_Reason.Steps_Return_Reason.updateReturnReasonStepId/page.mdx create mode 100644 www/apps/resources/references/core_flows/Return_Reason/Workflows_Return_Reason/functions/core_flows.Return_Reason.Workflows_Return_Reason.createReturnReasonsWorkflow/page.mdx create mode 100644 www/apps/resources/references/core_flows/Return_Reason/Workflows_Return_Reason/functions/core_flows.Return_Reason.Workflows_Return_Reason.deleteReturnReasonsWorkflow/page.mdx create mode 100644 www/apps/resources/references/core_flows/Return_Reason/Workflows_Return_Reason/functions/core_flows.Return_Reason.Workflows_Return_Reason.updateReturnReasonsWorkflow/page.mdx create mode 100644 www/apps/resources/references/core_flows/Return_Reason/Workflows_Return_Reason/variables/core_flows.Return_Reason.Workflows_Return_Reason.createReturnReasonsWorkflowId/page.mdx create mode 100644 www/apps/resources/references/core_flows/Return_Reason/Workflows_Return_Reason/variables/core_flows.Return_Reason.Workflows_Return_Reason.deleteReturnReasonsWorkflowId/page.mdx create mode 100644 www/apps/resources/references/core_flows/Return_Reason/Workflows_Return_Reason/variables/core_flows.Return_Reason.Workflows_Return_Reason.updateReturnReasonsWorkflowId/page.mdx create mode 100644 www/apps/resources/references/core_flows/Return_Reason/core_flows.Return_Reason.Steps_Return_Reason/page.mdx create mode 100644 www/apps/resources/references/core_flows/Return_Reason/core_flows.Return_Reason.Workflows_Return_Reason/page.mdx create mode 100644 www/apps/resources/references/core_flows/core_flows.Price_List/page.mdx create mode 100644 www/apps/resources/references/core_flows/core_flows.Pricing/page.mdx create mode 100644 www/apps/resources/references/core_flows/core_flows.Return_Reason/page.mdx diff --git a/www/apps/resources/references/core_flows/Price_List/Steps_Price_List/functions/core_flows.Price_List.Steps_Price_List.createPriceListPricesStep/page.mdx b/www/apps/resources/references/core_flows/Price_List/Steps_Price_List/functions/core_flows.Price_List.Steps_Price_List.createPriceListPricesStep/page.mdx new file mode 100644 index 0000000000..86f418a8fa --- /dev/null +++ b/www/apps/resources/references/core_flows/Price_List/Steps_Price_List/functions/core_flows.Price_List.Steps_Price_List.createPriceListPricesStep/page.mdx @@ -0,0 +1,20 @@ +--- +slug: /references/medusa-workflows/steps/createPriceListPricesStep +sidebar_label: createPriceListPricesStep +--- + +import { TypeList, WorkflowDiagram } from "docs-ui" + +# createPriceListPricesStep - Medusa Workflows API Reference + +This documentation provides a reference to the `createPriceListPricesStep`. It belongs to the `@medusajs/core-flows` package. + +This step creates prices for a price list. + +## Input + + + +## Output + + diff --git a/www/apps/resources/references/core_flows/Price_List/Steps_Price_List/functions/core_flows.Price_List.Steps_Price_List.createPriceListsStep/page.mdx b/www/apps/resources/references/core_flows/Price_List/Steps_Price_List/functions/core_flows.Price_List.Steps_Price_List.createPriceListsStep/page.mdx new file mode 100644 index 0000000000..bf5fb87811 --- /dev/null +++ b/www/apps/resources/references/core_flows/Price_List/Steps_Price_List/functions/core_flows.Price_List.Steps_Price_List.createPriceListsStep/page.mdx @@ -0,0 +1,20 @@ +--- +slug: /references/medusa-workflows/steps/createPriceListsStep +sidebar_label: createPriceListsStep +--- + +import { TypeList, WorkflowDiagram } from "docs-ui" + +# createPriceListsStep - Medusa Workflows API Reference + +This documentation provides a reference to the `createPriceListsStep`. It belongs to the `@medusajs/core-flows` package. + +This step creates a price list. + +## Input + + + +## Output + + diff --git a/www/apps/resources/references/core_flows/Price_List/Steps_Price_List/functions/core_flows.Price_List.Steps_Price_List.deletePriceListsStep/page.mdx b/www/apps/resources/references/core_flows/Price_List/Steps_Price_List/functions/core_flows.Price_List.Steps_Price_List.deletePriceListsStep/page.mdx new file mode 100644 index 0000000000..cd3c0edac9 --- /dev/null +++ b/www/apps/resources/references/core_flows/Price_List/Steps_Price_List/functions/core_flows.Price_List.Steps_Price_List.deletePriceListsStep/page.mdx @@ -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 + + diff --git a/www/apps/resources/references/core_flows/Price_List/Steps_Price_List/functions/core_flows.Price_List.Steps_Price_List.getExistingPriceListsPriceIdsStep/page.mdx b/www/apps/resources/references/core_flows/Price_List/Steps_Price_List/functions/core_flows.Price_List.Steps_Price_List.getExistingPriceListsPriceIdsStep/page.mdx new file mode 100644 index 0000000000..edf9c1a0aa --- /dev/null +++ b/www/apps/resources/references/core_flows/Price_List/Steps_Price_List/functions/core_flows.Price_List.Steps_Price_List.getExistingPriceListsPriceIdsStep/page.mdx @@ -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 + + + +## Output + +`","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"/> diff --git a/www/apps/resources/references/core_flows/Price_List/Steps_Price_List/functions/core_flows.Price_List.Steps_Price_List.removePriceListPricesStep/page.mdx b/www/apps/resources/references/core_flows/Price_List/Steps_Price_List/functions/core_flows.Price_List.Steps_Price_List.removePriceListPricesStep/page.mdx new file mode 100644 index 0000000000..0646b2df18 --- /dev/null +++ b/www/apps/resources/references/core_flows/Price_List/Steps_Price_List/functions/core_flows.Price_List.Steps_Price_List.removePriceListPricesStep/page.mdx @@ -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 + + + +## Output + + diff --git a/www/apps/resources/references/core_flows/Price_List/Steps_Price_List/functions/core_flows.Price_List.Steps_Price_List.updatePriceListPricesStep/page.mdx b/www/apps/resources/references/core_flows/Price_List/Steps_Price_List/functions/core_flows.Price_List.Steps_Price_List.updatePriceListPricesStep/page.mdx new file mode 100644 index 0000000000..eb7a8ad0dd --- /dev/null +++ b/www/apps/resources/references/core_flows/Price_List/Steps_Price_List/functions/core_flows.Price_List.Steps_Price_List.updatePriceListPricesStep/page.mdx @@ -0,0 +1,20 @@ +--- +slug: /references/medusa-workflows/steps/updatePriceListPricesStep +sidebar_label: updatePriceListPricesStep +--- + +import { TypeList, WorkflowDiagram } from "docs-ui" + +# updatePriceListPricesStep - Medusa Workflows API Reference + +This documentation provides a reference to the `updatePriceListPricesStep`. It belongs to the `@medusajs/core-flows` package. + +This step updates a price list's prices. + +## Input + + + +## Output + + diff --git a/www/apps/resources/references/core_flows/Price_List/Steps_Price_List/functions/core_flows.Price_List.Steps_Price_List.updatePriceListsStep/page.mdx b/www/apps/resources/references/core_flows/Price_List/Steps_Price_List/functions/core_flows.Price_List.Steps_Price_List.updatePriceListsStep/page.mdx new file mode 100644 index 0000000000..3e85a1c27d --- /dev/null +++ b/www/apps/resources/references/core_flows/Price_List/Steps_Price_List/functions/core_flows.Price_List.Steps_Price_List.updatePriceListsStep/page.mdx @@ -0,0 +1,20 @@ +--- +slug: /references/medusa-workflows/steps/updatePriceListsStep +sidebar_label: updatePriceListsStep +--- + +import { TypeList, WorkflowDiagram } from "docs-ui" + +# updatePriceListsStep - Medusa Workflows API Reference + +This documentation provides a reference to the `updatePriceListsStep`. It belongs to the `@medusajs/core-flows` package. + +This step updates one or more price lists. + +## Input + + + +## Output + + diff --git a/www/apps/resources/references/core_flows/Price_List/Steps_Price_List/functions/core_flows.Price_List.Steps_Price_List.validatePriceListsStep/page.mdx b/www/apps/resources/references/core_flows/Price_List/Steps_Price_List/functions/core_flows.Price_List.Steps_Price_List.validatePriceListsStep/page.mdx new file mode 100644 index 0000000000..2898284c7c --- /dev/null +++ b/www/apps/resources/references/core_flows/Price_List/Steps_Price_List/functions/core_flows.Price_List.Steps_Price_List.validatePriceListsStep/page.mdx @@ -0,0 +1,20 @@ +--- +slug: /references/medusa-workflows/steps/validatePriceListsStep +sidebar_label: validatePriceListsStep +--- + +import { TypeList, WorkflowDiagram } from "docs-ui" + +# validatePriceListsStep - Medusa Workflows API Reference + +This documentation provides a reference to the `validatePriceListsStep`. It belongs to the `@medusajs/core-flows` package. + +This step validates that the specified price lists exist. + +## Input + + + +## Output + +`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"PriceListDTO","type":"[PriceListDTO](../../../../../pricing/interfaces/pricing.PriceListDTO/page.mdx)","optional":false,"defaultValue":"","description":"A price list's details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The price list's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The price list's title.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The price list's description.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`null` \\| `string`","description":"The price list is enabled starting from this date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PriceListStatus](../../../../../pricing/types/pricing.PriceListStatus/page.mdx)","description":"The price list's status.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[PriceListType](../../../../../pricing/types/pricing.PriceListType/page.mdx)","description":"The price list's type.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `string`","description":"The price list expires after this date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules_count","type":"`number`","description":"The number of rules associated with this price list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"[PriceDTO](../../../../../pricing/interfaces/pricing.PriceDTO/page.mdx)[]","description":"The associated price list money amounts.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of a price.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"When the price was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"When the price was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"When the price was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the price.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency code of this price.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberValue](../../../../../pricing/types/pricing.BigNumberValue/page.mdx)","description":"The price of this price.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"min_quantity","type":"[BigNumberValue](../../../../../pricing/types/pricing.BigNumberValue/page.mdx)","description":"The minimum quantity required to be purchased for this price to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"max_quantity","type":"[BigNumberValue](../../../../../pricing/types/pricing.BigNumberValue/page.mdx)","description":"The maximum quantity required to be purchased for this price to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"price_set","type":"[PriceSetDTO](../../../../../pricing/interfaces/pricing.PriceSetDTO/page.mdx)","description":"The price set associated with the price.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"price_list","type":"[PriceListDTO](../../../../../pricing/interfaces/pricing.PriceListDTO/page.mdx)","description":"The price list associated with the price.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"price_set_id","type":"`string`","description":"The ID of the associated price set.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"price_rules","type":"[PriceRuleDTO](../../../../../pricing/interfaces/pricing.PriceRuleDTO/page.mdx)[]","description":"The price rules associated with the price.","optional":true,"defaultValue":"","expandable":true,"children":[]}]},{"name":"money_amounts","type":"[MoneyAmountDTO](../../../../../pricing/interfaces/pricing.MoneyAmountDTO/page.mdx)[]","description":"The associated money amounts.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the money amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"When the money\\_amount was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"When the money\\_amount was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"When the money\\_amount was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency code of this money amount.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberValue](../../../../../pricing/types/pricing.BigNumberValue/page.mdx)","description":"The price of this money amount.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"min_quantity","type":"[BigNumberValue](../../../../../pricing/types/pricing.BigNumberValue/page.mdx)","description":"The minimum quantity required to be purchased for this price to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"max_quantity","type":"[BigNumberValue](../../../../../pricing/types/pricing.BigNumberValue/page.mdx)","description":"The maximum quantity required to be purchased for this price to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules_count","type":"`number`","description":"The number of rules that apply to this price","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"price_rules","type":"[PriceRuleDTO](../../../../../pricing/interfaces/pricing.PriceRuleDTO/page.mdx)[]","description":"The price rules that apply to this price","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"price_list_rules","type":"[PriceListRuleDTO](../../../../../pricing/interfaces/pricing.PriceListRuleDTO/page.mdx)[]","description":"The price list's rules.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The price list rule's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`string`","description":"The attribute of the rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string` \\| `string`[]","description":"The value of the rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_list","type":"[PriceListDTO](../../../../../pricing/interfaces/pricing.PriceListDTO/page.mdx)","description":"The associated price list.","optional":false,"defaultValue":"","expandable":true,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="validatePriceListsStep"/> diff --git a/www/apps/resources/references/core_flows/Price_List/Steps_Price_List/functions/core_flows.Price_List.Steps_Price_List.validateVariantPriceLinksStep/page.mdx b/www/apps/resources/references/core_flows/Price_List/Steps_Price_List/functions/core_flows.Price_List.Steps_Price_List.validateVariantPriceLinksStep/page.mdx new file mode 100644 index 0000000000..517c5510e9 --- /dev/null +++ b/www/apps/resources/references/core_flows/Price_List/Steps_Price_List/functions/core_flows.Price_List.Steps_Price_List.validateVariantPriceLinksStep/page.mdx @@ -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 + + + +## Output + +`","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"/> diff --git a/www/apps/resources/references/core_flows/Price_List/Steps_Price_List/variables/core_flows.Price_List.Steps_Price_List.createPriceListPricesStepId/page.mdx b/www/apps/resources/references/core_flows/Price_List/Steps_Price_List/variables/core_flows.Price_List.Steps_Price_List.createPriceListPricesStepId/page.mdx new file mode 100644 index 0000000000..c1a6cd2299 --- /dev/null +++ b/www/apps/resources/references/core_flows/Price_List/Steps_Price_List/variables/core_flows.Price_List.Steps_Price_List.createPriceListPricesStepId/page.mdx @@ -0,0 +1,5 @@ +import { TypeList, WorkflowDiagram } from "docs-ui" + +# createPriceListPricesStepId + + `Const` **createPriceListPricesStepId**: `"create-price-list-prices"` diff --git a/www/apps/resources/references/core_flows/Price_List/Steps_Price_List/variables/core_flows.Price_List.Steps_Price_List.createPriceListsStepId/page.mdx b/www/apps/resources/references/core_flows/Price_List/Steps_Price_List/variables/core_flows.Price_List.Steps_Price_List.createPriceListsStepId/page.mdx new file mode 100644 index 0000000000..d053897398 --- /dev/null +++ b/www/apps/resources/references/core_flows/Price_List/Steps_Price_List/variables/core_flows.Price_List.Steps_Price_List.createPriceListsStepId/page.mdx @@ -0,0 +1,5 @@ +import { TypeList, WorkflowDiagram } from "docs-ui" + +# createPriceListsStepId + + `Const` **createPriceListsStepId**: `"create-price-lists"` diff --git a/www/apps/resources/references/core_flows/Price_List/Steps_Price_List/variables/core_flows.Price_List.Steps_Price_List.deletePriceListsStepId/page.mdx b/www/apps/resources/references/core_flows/Price_List/Steps_Price_List/variables/core_flows.Price_List.Steps_Price_List.deletePriceListsStepId/page.mdx new file mode 100644 index 0000000000..1e3e27e305 --- /dev/null +++ b/www/apps/resources/references/core_flows/Price_List/Steps_Price_List/variables/core_flows.Price_List.Steps_Price_List.deletePriceListsStepId/page.mdx @@ -0,0 +1,5 @@ +import { TypeList, WorkflowDiagram } from "docs-ui" + +# deletePriceListsStepId + + `Const` **deletePriceListsStepId**: `"delete-price-lists"` diff --git a/www/apps/resources/references/core_flows/Price_List/Steps_Price_List/variables/core_flows.Price_List.Steps_Price_List.getExistingPriceListsPriceIdsStepId/page.mdx b/www/apps/resources/references/core_flows/Price_List/Steps_Price_List/variables/core_flows.Price_List.Steps_Price_List.getExistingPriceListsPriceIdsStepId/page.mdx new file mode 100644 index 0000000000..0f62b69dbb --- /dev/null +++ b/www/apps/resources/references/core_flows/Price_List/Steps_Price_List/variables/core_flows.Price_List.Steps_Price_List.getExistingPriceListsPriceIdsStepId/page.mdx @@ -0,0 +1,5 @@ +import { TypeList, WorkflowDiagram } from "docs-ui" + +# getExistingPriceListsPriceIdsStepId + + `Const` **getExistingPriceListsPriceIdsStepId**: `"get-existing-price-lists-prices"` diff --git a/www/apps/resources/references/core_flows/Price_List/Steps_Price_List/variables/core_flows.Price_List.Steps_Price_List.removePriceListPricesStepId/page.mdx b/www/apps/resources/references/core_flows/Price_List/Steps_Price_List/variables/core_flows.Price_List.Steps_Price_List.removePriceListPricesStepId/page.mdx new file mode 100644 index 0000000000..8a551d33fc --- /dev/null +++ b/www/apps/resources/references/core_flows/Price_List/Steps_Price_List/variables/core_flows.Price_List.Steps_Price_List.removePriceListPricesStepId/page.mdx @@ -0,0 +1,5 @@ +import { TypeList, WorkflowDiagram } from "docs-ui" + +# removePriceListPricesStepId + + `Const` **removePriceListPricesStepId**: `"remove-price-list-prices"` diff --git a/www/apps/resources/references/core_flows/Price_List/Steps_Price_List/variables/core_flows.Price_List.Steps_Price_List.updatePriceListPricesStepId/page.mdx b/www/apps/resources/references/core_flows/Price_List/Steps_Price_List/variables/core_flows.Price_List.Steps_Price_List.updatePriceListPricesStepId/page.mdx new file mode 100644 index 0000000000..a574eb77c8 --- /dev/null +++ b/www/apps/resources/references/core_flows/Price_List/Steps_Price_List/variables/core_flows.Price_List.Steps_Price_List.updatePriceListPricesStepId/page.mdx @@ -0,0 +1,5 @@ +import { TypeList, WorkflowDiagram } from "docs-ui" + +# updatePriceListPricesStepId + + `Const` **updatePriceListPricesStepId**: `"update-price-list-prices"` diff --git a/www/apps/resources/references/core_flows/Price_List/Steps_Price_List/variables/core_flows.Price_List.Steps_Price_List.updatePriceListsStepId/page.mdx b/www/apps/resources/references/core_flows/Price_List/Steps_Price_List/variables/core_flows.Price_List.Steps_Price_List.updatePriceListsStepId/page.mdx new file mode 100644 index 0000000000..a41826d3fa --- /dev/null +++ b/www/apps/resources/references/core_flows/Price_List/Steps_Price_List/variables/core_flows.Price_List.Steps_Price_List.updatePriceListsStepId/page.mdx @@ -0,0 +1,5 @@ +import { TypeList, WorkflowDiagram } from "docs-ui" + +# updatePriceListsStepId + + `Const` **updatePriceListsStepId**: `"update-price-lists"` diff --git a/www/apps/resources/references/core_flows/Price_List/Steps_Price_List/variables/core_flows.Price_List.Steps_Price_List.validatePriceListsStepId/page.mdx b/www/apps/resources/references/core_flows/Price_List/Steps_Price_List/variables/core_flows.Price_List.Steps_Price_List.validatePriceListsStepId/page.mdx new file mode 100644 index 0000000000..815089f314 --- /dev/null +++ b/www/apps/resources/references/core_flows/Price_List/Steps_Price_List/variables/core_flows.Price_List.Steps_Price_List.validatePriceListsStepId/page.mdx @@ -0,0 +1,5 @@ +import { TypeList, WorkflowDiagram } from "docs-ui" + +# validatePriceListsStepId + + `Const` **validatePriceListsStepId**: `"validate-price-lists"` diff --git a/www/apps/resources/references/core_flows/Price_List/Steps_Price_List/variables/core_flows.Price_List.Steps_Price_List.validateVariantPriceLinksStepId/page.mdx b/www/apps/resources/references/core_flows/Price_List/Steps_Price_List/variables/core_flows.Price_List.Steps_Price_List.validateVariantPriceLinksStepId/page.mdx new file mode 100644 index 0000000000..0284b6c412 --- /dev/null +++ b/www/apps/resources/references/core_flows/Price_List/Steps_Price_List/variables/core_flows.Price_List.Steps_Price_List.validateVariantPriceLinksStepId/page.mdx @@ -0,0 +1,5 @@ +import { TypeList, WorkflowDiagram } from "docs-ui" + +# validateVariantPriceLinksStepId + + `Const` **validateVariantPriceLinksStepId**: `"validate-variant-price-links"` diff --git a/www/apps/resources/references/core_flows/Price_List/Workflows_Price_List/functions/core_flows.Price_List.Workflows_Price_List.batchPriceListPricesWorkflow/page.mdx b/www/apps/resources/references/core_flows/Price_List/Workflows_Price_List/functions/core_flows.Price_List.Workflows_Price_List.batchPriceListPricesWorkflow/page.mdx new file mode 100644 index 0000000000..c4a91c9df5 --- /dev/null +++ b/www/apps/resources/references/core_flows/Price_List/Workflows_Price_List/functions/core_flows.Price_List.Workflows_Price_List.batchPriceListPricesWorkflow/page.mdx @@ -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 + + + +## Input + + + +## Output + + diff --git a/www/apps/resources/references/core_flows/Price_List/Workflows_Price_List/functions/core_flows.Price_List.Workflows_Price_List.createPriceListPricesWorkflow/page.mdx b/www/apps/resources/references/core_flows/Price_List/Workflows_Price_List/functions/core_flows.Price_List.Workflows_Price_List.createPriceListPricesWorkflow/page.mdx new file mode 100644 index 0000000000..10b82f32e9 --- /dev/null +++ b/www/apps/resources/references/core_flows/Price_List/Workflows_Price_List/functions/core_flows.Price_List.Workflows_Price_List.createPriceListPricesWorkflow/page.mdx @@ -0,0 +1,24 @@ +--- +slug: /references/medusa-workflows/createPriceListPricesWorkflow +sidebar_label: createPriceListPricesWorkflow +--- + +import { TypeList, WorkflowDiagram } from "docs-ui" + +# createPriceListPricesWorkflow - Medusa Workflows API Reference + +This documentation provides a reference to the `createPriceListPricesWorkflow`. It belongs to the `@medusajs/core-flows` package. + +This workflow creates prices in price lists. + +## Steps + + + +## Input + + + +## Output + + diff --git a/www/apps/resources/references/core_flows/Price_List/Workflows_Price_List/functions/core_flows.Price_List.Workflows_Price_List.createPriceListsWorkflow/page.mdx b/www/apps/resources/references/core_flows/Price_List/Workflows_Price_List/functions/core_flows.Price_List.Workflows_Price_List.createPriceListsWorkflow/page.mdx new file mode 100644 index 0000000000..d723411564 --- /dev/null +++ b/www/apps/resources/references/core_flows/Price_List/Workflows_Price_List/functions/core_flows.Price_List.Workflows_Price_List.createPriceListsWorkflow/page.mdx @@ -0,0 +1,24 @@ +--- +slug: /references/medusa-workflows/createPriceListsWorkflow +sidebar_label: createPriceListsWorkflow +--- + +import { TypeList, WorkflowDiagram } from "docs-ui" + +# createPriceListsWorkflow - Medusa Workflows API Reference + +This documentation provides a reference to the `createPriceListsWorkflow`. It belongs to the `@medusajs/core-flows` package. + +This workflow creates one or more price lists. + +## Steps + + + +## Input + + + +## Output + + diff --git a/www/apps/resources/references/core_flows/Price_List/Workflows_Price_List/functions/core_flows.Price_List.Workflows_Price_List.deletePriceListsWorkflow/page.mdx b/www/apps/resources/references/core_flows/Price_List/Workflows_Price_List/functions/core_flows.Price_List.Workflows_Price_List.deletePriceListsWorkflow/page.mdx new file mode 100644 index 0000000000..e0dc951a71 --- /dev/null +++ b/www/apps/resources/references/core_flows/Price_List/Workflows_Price_List/functions/core_flows.Price_List.Workflows_Price_List.deletePriceListsWorkflow/page.mdx @@ -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 + + + +## Input + + diff --git a/www/apps/resources/references/core_flows/Price_List/Workflows_Price_List/functions/core_flows.Price_List.Workflows_Price_List.removePriceListPricesWorkflow/page.mdx b/www/apps/resources/references/core_flows/Price_List/Workflows_Price_List/functions/core_flows.Price_List.Workflows_Price_List.removePriceListPricesWorkflow/page.mdx new file mode 100644 index 0000000000..951e2c8463 --- /dev/null +++ b/www/apps/resources/references/core_flows/Price_List/Workflows_Price_List/functions/core_flows.Price_List.Workflows_Price_List.removePriceListPricesWorkflow/page.mdx @@ -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 + + + +## Input + + + +## Output + + diff --git a/www/apps/resources/references/core_flows/Price_List/Workflows_Price_List/functions/core_flows.Price_List.Workflows_Price_List.updatePriceListPricesWorkflow/page.mdx b/www/apps/resources/references/core_flows/Price_List/Workflows_Price_List/functions/core_flows.Price_List.Workflows_Price_List.updatePriceListPricesWorkflow/page.mdx new file mode 100644 index 0000000000..1bc9bd984e --- /dev/null +++ b/www/apps/resources/references/core_flows/Price_List/Workflows_Price_List/functions/core_flows.Price_List.Workflows_Price_List.updatePriceListPricesWorkflow/page.mdx @@ -0,0 +1,24 @@ +--- +slug: /references/medusa-workflows/updatePriceListPricesWorkflow +sidebar_label: updatePriceListPricesWorkflow +--- + +import { TypeList, WorkflowDiagram } from "docs-ui" + +# updatePriceListPricesWorkflow - Medusa Workflows API Reference + +This documentation provides a reference to the `updatePriceListPricesWorkflow`. It belongs to the `@medusajs/core-flows` package. + +This workflow update price lists' prices. + +## Steps + + + +## Input + + + +## Output + + diff --git a/www/apps/resources/references/core_flows/Price_List/Workflows_Price_List/functions/core_flows.Price_List.Workflows_Price_List.updatePriceListsWorkflow/page.mdx b/www/apps/resources/references/core_flows/Price_List/Workflows_Price_List/functions/core_flows.Price_List.Workflows_Price_List.updatePriceListsWorkflow/page.mdx new file mode 100644 index 0000000000..d9f069cfc1 --- /dev/null +++ b/www/apps/resources/references/core_flows/Price_List/Workflows_Price_List/functions/core_flows.Price_List.Workflows_Price_List.updatePriceListsWorkflow/page.mdx @@ -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 + + + +## Input + + diff --git a/www/apps/resources/references/core_flows/Price_List/Workflows_Price_List/variables/core_flows.Price_List.Workflows_Price_List.batchPriceListPricesWorkflowId/page.mdx b/www/apps/resources/references/core_flows/Price_List/Workflows_Price_List/variables/core_flows.Price_List.Workflows_Price_List.batchPriceListPricesWorkflowId/page.mdx new file mode 100644 index 0000000000..08b7a7c091 --- /dev/null +++ b/www/apps/resources/references/core_flows/Price_List/Workflows_Price_List/variables/core_flows.Price_List.Workflows_Price_List.batchPriceListPricesWorkflowId/page.mdx @@ -0,0 +1,5 @@ +import { TypeList, WorkflowDiagram } from "docs-ui" + +# batchPriceListPricesWorkflowId + + `Const` **batchPriceListPricesWorkflowId**: `"batch-price-list-prices"` diff --git a/www/apps/resources/references/core_flows/Price_List/Workflows_Price_List/variables/core_flows.Price_List.Workflows_Price_List.createPriceListPricesWorkflowId/page.mdx b/www/apps/resources/references/core_flows/Price_List/Workflows_Price_List/variables/core_flows.Price_List.Workflows_Price_List.createPriceListPricesWorkflowId/page.mdx new file mode 100644 index 0000000000..b795fbb204 --- /dev/null +++ b/www/apps/resources/references/core_flows/Price_List/Workflows_Price_List/variables/core_flows.Price_List.Workflows_Price_List.createPriceListPricesWorkflowId/page.mdx @@ -0,0 +1,5 @@ +import { TypeList, WorkflowDiagram } from "docs-ui" + +# createPriceListPricesWorkflowId + + `Const` **createPriceListPricesWorkflowId**: `"create-price-list-prices"` diff --git a/www/apps/resources/references/core_flows/Price_List/Workflows_Price_List/variables/core_flows.Price_List.Workflows_Price_List.createPriceListsWorkflowId/page.mdx b/www/apps/resources/references/core_flows/Price_List/Workflows_Price_List/variables/core_flows.Price_List.Workflows_Price_List.createPriceListsWorkflowId/page.mdx new file mode 100644 index 0000000000..ca5e20c3a8 --- /dev/null +++ b/www/apps/resources/references/core_flows/Price_List/Workflows_Price_List/variables/core_flows.Price_List.Workflows_Price_List.createPriceListsWorkflowId/page.mdx @@ -0,0 +1,5 @@ +import { TypeList, WorkflowDiagram } from "docs-ui" + +# createPriceListsWorkflowId + + `Const` **createPriceListsWorkflowId**: `"create-price-lists"` diff --git a/www/apps/resources/references/core_flows/Price_List/Workflows_Price_List/variables/core_flows.Price_List.Workflows_Price_List.deletePriceListsWorkflowId/page.mdx b/www/apps/resources/references/core_flows/Price_List/Workflows_Price_List/variables/core_flows.Price_List.Workflows_Price_List.deletePriceListsWorkflowId/page.mdx new file mode 100644 index 0000000000..81bbc65184 --- /dev/null +++ b/www/apps/resources/references/core_flows/Price_List/Workflows_Price_List/variables/core_flows.Price_List.Workflows_Price_List.deletePriceListsWorkflowId/page.mdx @@ -0,0 +1,5 @@ +import { TypeList, WorkflowDiagram } from "docs-ui" + +# deletePriceListsWorkflowId + + `Const` **deletePriceListsWorkflowId**: `"delete-price-lists"` diff --git a/www/apps/resources/references/core_flows/Price_List/Workflows_Price_List/variables/core_flows.Price_List.Workflows_Price_List.removePriceListPricesWorkflowId/page.mdx b/www/apps/resources/references/core_flows/Price_List/Workflows_Price_List/variables/core_flows.Price_List.Workflows_Price_List.removePriceListPricesWorkflowId/page.mdx new file mode 100644 index 0000000000..0ef95b1deb --- /dev/null +++ b/www/apps/resources/references/core_flows/Price_List/Workflows_Price_List/variables/core_flows.Price_List.Workflows_Price_List.removePriceListPricesWorkflowId/page.mdx @@ -0,0 +1,5 @@ +import { TypeList, WorkflowDiagram } from "docs-ui" + +# removePriceListPricesWorkflowId + + `Const` **removePriceListPricesWorkflowId**: `"remove-price-list-prices"` diff --git a/www/apps/resources/references/core_flows/Price_List/Workflows_Price_List/variables/core_flows.Price_List.Workflows_Price_List.updatePriceListPricesWorkflowId/page.mdx b/www/apps/resources/references/core_flows/Price_List/Workflows_Price_List/variables/core_flows.Price_List.Workflows_Price_List.updatePriceListPricesWorkflowId/page.mdx new file mode 100644 index 0000000000..251bbd3d8d --- /dev/null +++ b/www/apps/resources/references/core_flows/Price_List/Workflows_Price_List/variables/core_flows.Price_List.Workflows_Price_List.updatePriceListPricesWorkflowId/page.mdx @@ -0,0 +1,5 @@ +import { TypeList, WorkflowDiagram } from "docs-ui" + +# updatePriceListPricesWorkflowId + + `Const` **updatePriceListPricesWorkflowId**: `"update-price-list-prices"` diff --git a/www/apps/resources/references/core_flows/Price_List/Workflows_Price_List/variables/core_flows.Price_List.Workflows_Price_List.updatePriceListsWorkflowId/page.mdx b/www/apps/resources/references/core_flows/Price_List/Workflows_Price_List/variables/core_flows.Price_List.Workflows_Price_List.updatePriceListsWorkflowId/page.mdx new file mode 100644 index 0000000000..361265a853 --- /dev/null +++ b/www/apps/resources/references/core_flows/Price_List/Workflows_Price_List/variables/core_flows.Price_List.Workflows_Price_List.updatePriceListsWorkflowId/page.mdx @@ -0,0 +1,5 @@ +import { TypeList, WorkflowDiagram } from "docs-ui" + +# updatePriceListsWorkflowId + + `Const` **updatePriceListsWorkflowId**: `"update-price-lists"` diff --git a/www/apps/resources/references/core_flows/Price_List/core_flows.Price_List.Steps_Price_List/page.mdx b/www/apps/resources/references/core_flows/Price_List/core_flows.Price_List.Steps_Price_List/page.mdx new file mode 100644 index 0000000000..831df40c62 --- /dev/null +++ b/www/apps/resources/references/core_flows/Price_List/core_flows.Price_List.Steps_Price_List/page.mdx @@ -0,0 +1,123 @@ +import { TypeList, WorkflowDiagram } from "docs-ui" + +# Steps\_Price List + +## createPriceListPricesStep + +This step creates prices for a price list. + +### Input + + + +### Output + + + +___ + +## createPriceListsStep + +This step creates a price list. + +### Input + + + +### Output + + + +___ + +## deletePriceListsStep + +This step deletes one or more price lists. + +### Input + + + +___ + +## getExistingPriceListsPriceIdsStep + +This step retrieves prices of price lists. + +### Input + + + +### Output + +`","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"/> + +___ + +## removePriceListPricesStep + +This step removes prices from a price list. + +### Input + + + +### Output + + + +___ + +## updatePriceListPricesStep + +This step updates a price list's prices. + +### Input + + + +### Output + + + +___ + +## updatePriceListsStep + +This step updates one or more price lists. + +### Input + + + +### Output + + + +___ + +## validatePriceListsStep + +This step validates that the specified price lists exist. + +### Input + + + +### Output + +`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"PriceListDTO","type":"[PriceListDTO](../../../pricing/interfaces/pricing.PriceListDTO/page.mdx)","optional":false,"defaultValue":"","description":"A price list's details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The price list's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The price list's title.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The price list's description.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`null` \\| `string`","description":"The price list is enabled starting from this date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PriceListStatus](../../../pricing/types/pricing.PriceListStatus/page.mdx)","description":"The price list's status.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[PriceListType](../../../pricing/types/pricing.PriceListType/page.mdx)","description":"The price list's type.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `string`","description":"The price list expires after this date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules_count","type":"`number`","description":"The number of rules associated with this price list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"[PriceDTO](../../../pricing/interfaces/pricing.PriceDTO/page.mdx)[]","description":"The associated price list money amounts.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of a price.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"When the price was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"When the price was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"When the price was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the price.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency code of this price.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberValue](../../../pricing/types/pricing.BigNumberValue/page.mdx)","description":"The price of this price.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"min_quantity","type":"[BigNumberValue](../../../pricing/types/pricing.BigNumberValue/page.mdx)","description":"The minimum quantity required to be purchased for this price to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"max_quantity","type":"[BigNumberValue](../../../pricing/types/pricing.BigNumberValue/page.mdx)","description":"The maximum quantity required to be purchased for this price to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"price_set","type":"[PriceSetDTO](../../../pricing/interfaces/pricing.PriceSetDTO/page.mdx)","description":"The price set associated with the price.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"price_list","type":"[PriceListDTO](../../../pricing/interfaces/pricing.PriceListDTO/page.mdx)","description":"The price list associated with the price.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"price_set_id","type":"`string`","description":"The ID of the associated price set.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"price_rules","type":"[PriceRuleDTO](../../../pricing/interfaces/pricing.PriceRuleDTO/page.mdx)[]","description":"The price rules associated with the price.","optional":true,"defaultValue":"","expandable":true,"children":[]}]},{"name":"money_amounts","type":"[MoneyAmountDTO](../../../pricing/interfaces/pricing.MoneyAmountDTO/page.mdx)[]","description":"The associated money amounts.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the money amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"When the money\\_amount was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"When the money\\_amount was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"When the money\\_amount was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency code of this money amount.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberValue](../../../pricing/types/pricing.BigNumberValue/page.mdx)","description":"The price of this money amount.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"min_quantity","type":"[BigNumberValue](../../../pricing/types/pricing.BigNumberValue/page.mdx)","description":"The minimum quantity required to be purchased for this price to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"max_quantity","type":"[BigNumberValue](../../../pricing/types/pricing.BigNumberValue/page.mdx)","description":"The maximum quantity required to be purchased for this price to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules_count","type":"`number`","description":"The number of rules that apply to this price","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"price_rules","type":"[PriceRuleDTO](../../../pricing/interfaces/pricing.PriceRuleDTO/page.mdx)[]","description":"The price rules that apply to this price","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"price_list_rules","type":"[PriceListRuleDTO](../../../pricing/interfaces/pricing.PriceListRuleDTO/page.mdx)[]","description":"The price list's rules.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The price list rule's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`string`","description":"The attribute of the rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string` \\| `string`[]","description":"The value of the rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_list","type":"[PriceListDTO](../../../pricing/interfaces/pricing.PriceListDTO/page.mdx)","description":"The associated price list.","optional":false,"defaultValue":"","expandable":true,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="validatePriceListsStep"/> + +___ + +## validateVariantPriceLinksStep + +This step validates that the specified variants have prices. + +### Input + + + +### Output + +`","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"/> diff --git a/www/apps/resources/references/core_flows/Price_List/core_flows.Price_List.Workflows_Price_List/page.mdx b/www/apps/resources/references/core_flows/Price_List/core_flows.Price_List.Workflows_Price_List/page.mdx new file mode 100644 index 0000000000..f85b31b3b8 --- /dev/null +++ b/www/apps/resources/references/core_flows/Price_List/core_flows.Price_List.Workflows_Price_List/page.mdx @@ -0,0 +1,119 @@ +import { TypeList, WorkflowDiagram } from "docs-ui" + +# Workflows\_Price List + +## batchPriceListPricesWorkflow + +This workflow manages price lists' prices by creating, updating, or removing them. + +### Steps + + + +### Input + + + +### Output + + + +___ + +## createPriceListPricesWorkflow + +This workflow creates prices in price lists. + +### Steps + + + +### Input + + + +### Output + + + +___ + +## createPriceListsWorkflow + +This workflow creates one or more price lists. + +### Steps + + + +### Input + + + +### Output + + + +___ + +## deletePriceListsWorkflow + +This workflow deletes one or more price lists. + +### Steps + + + +### Input + + + +___ + +## removePriceListPricesWorkflow + +This workflow removes price lists' prices. + +### Steps + + + +### Input + + + +### Output + + + +___ + +## updatePriceListPricesWorkflow + +This workflow update price lists' prices. + +### Steps + + + +### Input + + + +### Output + + + +___ + +## updatePriceListsWorkflow + +This workflow updates one or more price lists. + +### Steps + + + +### Input + + diff --git a/www/apps/resources/references/core_flows/Pricing/Steps_Pricing/functions/core_flows.Pricing.Steps_Pricing.createPricePreferencesStep/page.mdx b/www/apps/resources/references/core_flows/Pricing/Steps_Pricing/functions/core_flows.Pricing.Steps_Pricing.createPricePreferencesStep/page.mdx new file mode 100644 index 0000000000..fbe4d342cc --- /dev/null +++ b/www/apps/resources/references/core_flows/Pricing/Steps_Pricing/functions/core_flows.Pricing.Steps_Pricing.createPricePreferencesStep/page.mdx @@ -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 + + + +## Output + + diff --git a/www/apps/resources/references/core_flows/Pricing/Steps_Pricing/functions/core_flows.Pricing.Steps_Pricing.createPriceSetsStep/page.mdx b/www/apps/resources/references/core_flows/Pricing/Steps_Pricing/functions/core_flows.Pricing.Steps_Pricing.createPriceSetsStep/page.mdx new file mode 100644 index 0000000000..f236760952 --- /dev/null +++ b/www/apps/resources/references/core_flows/Pricing/Steps_Pricing/functions/core_flows.Pricing.Steps_Pricing.createPriceSetsStep/page.mdx @@ -0,0 +1,20 @@ +--- +slug: /references/medusa-workflows/steps/createPriceSetsStep +sidebar_label: createPriceSetsStep +--- + +import { TypeList, WorkflowDiagram } from "docs-ui" + +# createPriceSetsStep - Medusa Workflows API Reference + +This documentation provides a reference to the `createPriceSetsStep`. It belongs to the `@medusajs/core-flows` package. + +This step creates one or more price sets. + +## Input + + + +## Output + + diff --git a/www/apps/resources/references/core_flows/Pricing/Steps_Pricing/functions/core_flows.Pricing.Steps_Pricing.deletePricePreferencesStep/page.mdx b/www/apps/resources/references/core_flows/Pricing/Steps_Pricing/functions/core_flows.Pricing.Steps_Pricing.deletePricePreferencesStep/page.mdx new file mode 100644 index 0000000000..aa46fdd074 --- /dev/null +++ b/www/apps/resources/references/core_flows/Pricing/Steps_Pricing/functions/core_flows.Pricing.Steps_Pricing.deletePricePreferencesStep/page.mdx @@ -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 + + diff --git a/www/apps/resources/references/core_flows/Pricing/Steps_Pricing/functions/core_flows.Pricing.Steps_Pricing.updatePricePreferencesAsArrayStep/page.mdx b/www/apps/resources/references/core_flows/Pricing/Steps_Pricing/functions/core_flows.Pricing.Steps_Pricing.updatePricePreferencesAsArrayStep/page.mdx new file mode 100644 index 0000000000..4528d8adf4 --- /dev/null +++ b/www/apps/resources/references/core_flows/Pricing/Steps_Pricing/functions/core_flows.Pricing.Steps_Pricing.updatePricePreferencesAsArrayStep/page.mdx @@ -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 + + + +## Output + + diff --git a/www/apps/resources/references/core_flows/Pricing/Steps_Pricing/functions/core_flows.Pricing.Steps_Pricing.updatePricePreferencesStep/page.mdx b/www/apps/resources/references/core_flows/Pricing/Steps_Pricing/functions/core_flows.Pricing.Steps_Pricing.updatePricePreferencesStep/page.mdx new file mode 100644 index 0000000000..fc9e831c80 --- /dev/null +++ b/www/apps/resources/references/core_flows/Pricing/Steps_Pricing/functions/core_flows.Pricing.Steps_Pricing.updatePricePreferencesStep/page.mdx @@ -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 + + + +## Output + + diff --git a/www/apps/resources/references/core_flows/Pricing/Steps_Pricing/functions/core_flows.Pricing.Steps_Pricing.updatePriceSetsStep/page.mdx b/www/apps/resources/references/core_flows/Pricing/Steps_Pricing/functions/core_flows.Pricing.Steps_Pricing.updatePriceSetsStep/page.mdx new file mode 100644 index 0000000000..5877ba627a --- /dev/null +++ b/www/apps/resources/references/core_flows/Pricing/Steps_Pricing/functions/core_flows.Pricing.Steps_Pricing.updatePriceSetsStep/page.mdx @@ -0,0 +1,20 @@ +--- +slug: /references/medusa-workflows/steps/updatePriceSetsStep +sidebar_label: updatePriceSetsStep +--- + +import { TypeList, WorkflowDiagram } from "docs-ui" + +# updatePriceSetsStep - Medusa Workflows API Reference + +This documentation provides a reference to the `updatePriceSetsStep`. It belongs to the `@medusajs/core-flows` package. + +This step updates price sets. + +## Input + +`","description":"an object whose keys are the name of the context attribute. Its value can be a string or a BigNumberInput. For example, you can pass the `currency_code` property with its value being the currency code to calculate the price in.\nAnother example is passing the `quantity` property to calculate the price for that specified quantity, which finds a price set whose `min_quantity` and `max_quantity` conditions match the specified quantity.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`[]","description":"IDs to filter price sets by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"[FilterableMoneyAmountProps](../../../../../pricing/interfaces/pricing.FilterableMoneyAmountProps/page.mdx)","description":"Filters to apply on a price set's associated money amounts.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../../../pricing/interfaces/pricing.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../../../pricing/interfaces/pricing.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterablePriceSetProps](../../../../../pricing/interfaces/pricing.FilterablePriceSetProps/page.mdx) \\| [BaseFilterable](../../../../../pricing/interfaces/pricing.BaseFilterable/page.mdx)<[FilterablePriceSetProps](../../../../../pricing/interfaces/pricing.FilterablePriceSetProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterablePriceSetProps](../../../../../pricing/interfaces/pricing.FilterablePriceSetProps/page.mdx) \\| [BaseFilterable](../../../../../pricing/interfaces/pricing.BaseFilterable/page.mdx)<[FilterablePriceSetProps](../../../../../pricing/interfaces/pricing.FilterablePriceSetProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterablePriceSetProps](../../../../../pricing/interfaces/pricing.FilterablePriceSetProps/page.mdx) \\| [BaseFilterable](../../../../../pricing/interfaces/pricing.BaseFilterable/page.mdx)<[FilterablePriceSetProps](../../../../../pricing/interfaces/pricing.FilterablePriceSetProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"`Record`","description":"an object whose keys are the name of the context attribute. Its value can be a string or a BigNumberInput. For example, you can pass the `currency_code` property with its value being the currency code to calculate the price in.\nAnother example is passing the `quantity` property to calculate the price for that specified quantity, which finds a price set whose `min_quantity` and `max_quantity` conditions match the specified quantity.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`[]","description":"IDs to filter price sets by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"[FilterableMoneyAmountProps](../../../../../pricing/interfaces/pricing.FilterableMoneyAmountProps/page.mdx)","description":"Filters to apply on a price set's associated money amounts.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../../../pricing/interfaces/pricing.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../../../pricing/interfaces/pricing.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"context","type":"`Record`","description":"an object whose keys are the name of the context attribute. Its value can be a string or a BigNumberInput. For example, you can pass the `currency_code` property with its value being the currency code to calculate the price in.\nAnother example is passing the `quantity` property to calculate the price for that specified quantity, which finds a price set whose `min_quantity` and `max_quantity` conditions match the specified quantity.","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](../../../../../pricing/types/pricing.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"id","type":"`string`[]","description":"IDs to filter price sets by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"[FilterableMoneyAmountProps](../../../../../pricing/interfaces/pricing.FilterableMoneyAmountProps/page.mdx)","description":"Filters to apply on a price set's associated money amounts.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableMoneyAmountProps](../../../../../pricing/interfaces/pricing.FilterableMoneyAmountProps/page.mdx) \\| [BaseFilterable](../../../../../pricing/interfaces/pricing.BaseFilterable/page.mdx)<[FilterableMoneyAmountProps](../../../../../pricing/interfaces/pricing.FilterableMoneyAmountProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableMoneyAmountProps](../../../../../pricing/interfaces/pricing.FilterableMoneyAmountProps/page.mdx) \\| [BaseFilterable](../../../../../pricing/interfaces/pricing.BaseFilterable/page.mdx)<[FilterableMoneyAmountProps](../../../../../pricing/interfaces/pricing.FilterableMoneyAmountProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`[]","description":"IDs to filter money amounts by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string` \\| `string`[]","description":"Currency codes to filter money amounts by.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"update","type":"[UpdatePriceSetDTO](../../../../../pricing/interfaces/pricing.UpdatePriceSetDTO/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"prices","type":"[CreatePricesDTO](../../../../../pricing/interfaces/pricing.CreatePricesDTO/page.mdx)[]","description":"The prices to create and add to this price set.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"currency_code","type":"`string`","description":"The currency code of this money amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberInput](../../../../../pricing/types/pricing.BigNumberInput/page.mdx)","description":"The amount of this money amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The ID of the money amount.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"min_quantity","type":"`null` \\| [BigNumberInput](../../../../../pricing/types/pricing.BigNumberInput/page.mdx)","description":"The minimum quantity required to be purchased for this money amount to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"max_quantity","type":"`null` \\| [BigNumberInput](../../../../../pricing/types/pricing.BigNumberInput/page.mdx)","description":"The maximum quantity required to be purchased for this money amount to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[CreatePriceSetPriceRules](../../../../../pricing/interfaces/pricing.CreatePriceSetPriceRules/page.mdx)","description":"The rules to add to the price. The object's keys are the attribute, and values are the value of that rule associated with this price.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updatePriceSetsStep"/> + +## Output + + diff --git a/www/apps/resources/references/core_flows/Pricing/Steps_Pricing/variables/core_flows.Pricing.Steps_Pricing.createPricePreferencesStepId/page.mdx b/www/apps/resources/references/core_flows/Pricing/Steps_Pricing/variables/core_flows.Pricing.Steps_Pricing.createPricePreferencesStepId/page.mdx new file mode 100644 index 0000000000..d130eb1527 --- /dev/null +++ b/www/apps/resources/references/core_flows/Pricing/Steps_Pricing/variables/core_flows.Pricing.Steps_Pricing.createPricePreferencesStepId/page.mdx @@ -0,0 +1,5 @@ +import { TypeList, WorkflowDiagram } from "docs-ui" + +# createPricePreferencesStepId + + `Const` **createPricePreferencesStepId**: `"create-price-preferences"` diff --git a/www/apps/resources/references/core_flows/Pricing/Steps_Pricing/variables/core_flows.Pricing.Steps_Pricing.createPriceSetsStepId/page.mdx b/www/apps/resources/references/core_flows/Pricing/Steps_Pricing/variables/core_flows.Pricing.Steps_Pricing.createPriceSetsStepId/page.mdx new file mode 100644 index 0000000000..1cf066abf7 --- /dev/null +++ b/www/apps/resources/references/core_flows/Pricing/Steps_Pricing/variables/core_flows.Pricing.Steps_Pricing.createPriceSetsStepId/page.mdx @@ -0,0 +1,5 @@ +import { TypeList, WorkflowDiagram } from "docs-ui" + +# createPriceSetsStepId + + `Const` **createPriceSetsStepId**: `"create-price-sets"` diff --git a/www/apps/resources/references/core_flows/Pricing/Steps_Pricing/variables/core_flows.Pricing.Steps_Pricing.deletePricePreferencesStepId/page.mdx b/www/apps/resources/references/core_flows/Pricing/Steps_Pricing/variables/core_flows.Pricing.Steps_Pricing.deletePricePreferencesStepId/page.mdx new file mode 100644 index 0000000000..1c158b5aa3 --- /dev/null +++ b/www/apps/resources/references/core_flows/Pricing/Steps_Pricing/variables/core_flows.Pricing.Steps_Pricing.deletePricePreferencesStepId/page.mdx @@ -0,0 +1,5 @@ +import { TypeList, WorkflowDiagram } from "docs-ui" + +# deletePricePreferencesStepId + + `Const` **deletePricePreferencesStepId**: `"delete-price-preferences"` diff --git a/www/apps/resources/references/core_flows/Pricing/Steps_Pricing/variables/core_flows.Pricing.Steps_Pricing.updatePricePreferencesAsArrayStepId/page.mdx b/www/apps/resources/references/core_flows/Pricing/Steps_Pricing/variables/core_flows.Pricing.Steps_Pricing.updatePricePreferencesAsArrayStepId/page.mdx new file mode 100644 index 0000000000..c5b8790974 --- /dev/null +++ b/www/apps/resources/references/core_flows/Pricing/Steps_Pricing/variables/core_flows.Pricing.Steps_Pricing.updatePricePreferencesAsArrayStepId/page.mdx @@ -0,0 +1,5 @@ +import { TypeList, WorkflowDiagram } from "docs-ui" + +# updatePricePreferencesAsArrayStepId + + `Const` **updatePricePreferencesAsArrayStepId**: `"update-price-preferences-as-array"` diff --git a/www/apps/resources/references/core_flows/Pricing/Steps_Pricing/variables/core_flows.Pricing.Steps_Pricing.updatePricePreferencesStepId/page.mdx b/www/apps/resources/references/core_flows/Pricing/Steps_Pricing/variables/core_flows.Pricing.Steps_Pricing.updatePricePreferencesStepId/page.mdx new file mode 100644 index 0000000000..c80e990813 --- /dev/null +++ b/www/apps/resources/references/core_flows/Pricing/Steps_Pricing/variables/core_flows.Pricing.Steps_Pricing.updatePricePreferencesStepId/page.mdx @@ -0,0 +1,5 @@ +import { TypeList, WorkflowDiagram } from "docs-ui" + +# updatePricePreferencesStepId + + `Const` **updatePricePreferencesStepId**: `"update-price-preferences"` diff --git a/www/apps/resources/references/core_flows/Pricing/Steps_Pricing/variables/core_flows.Pricing.Steps_Pricing.updatePriceSetsStepId/page.mdx b/www/apps/resources/references/core_flows/Pricing/Steps_Pricing/variables/core_flows.Pricing.Steps_Pricing.updatePriceSetsStepId/page.mdx new file mode 100644 index 0000000000..cb5681b56f --- /dev/null +++ b/www/apps/resources/references/core_flows/Pricing/Steps_Pricing/variables/core_flows.Pricing.Steps_Pricing.updatePriceSetsStepId/page.mdx @@ -0,0 +1,5 @@ +import { TypeList, WorkflowDiagram } from "docs-ui" + +# updatePriceSetsStepId + + `Const` **updatePriceSetsStepId**: `"update-price-sets"` diff --git a/www/apps/resources/references/core_flows/Pricing/Workflows_Pricing/functions/core_flows.Pricing.Workflows_Pricing.createPricePreferencesWorkflow/page.mdx b/www/apps/resources/references/core_flows/Pricing/Workflows_Pricing/functions/core_flows.Pricing.Workflows_Pricing.createPricePreferencesWorkflow/page.mdx new file mode 100644 index 0000000000..1c4295832f --- /dev/null +++ b/www/apps/resources/references/core_flows/Pricing/Workflows_Pricing/functions/core_flows.Pricing.Workflows_Pricing.createPricePreferencesWorkflow/page.mdx @@ -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 + + + +## Input + + + +## Output + + diff --git a/www/apps/resources/references/core_flows/Pricing/Workflows_Pricing/functions/core_flows.Pricing.Workflows_Pricing.deletePricePreferencesWorkflow/page.mdx b/www/apps/resources/references/core_flows/Pricing/Workflows_Pricing/functions/core_flows.Pricing.Workflows_Pricing.deletePricePreferencesWorkflow/page.mdx new file mode 100644 index 0000000000..2554b754d3 --- /dev/null +++ b/www/apps/resources/references/core_flows/Pricing/Workflows_Pricing/functions/core_flows.Pricing.Workflows_Pricing.deletePricePreferencesWorkflow/page.mdx @@ -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 + + + +## Input + + diff --git a/www/apps/resources/references/core_flows/Pricing/Workflows_Pricing/functions/core_flows.Pricing.Workflows_Pricing.updatePricePreferencesWorkflow/page.mdx b/www/apps/resources/references/core_flows/Pricing/Workflows_Pricing/functions/core_flows.Pricing.Workflows_Pricing.updatePricePreferencesWorkflow/page.mdx new file mode 100644 index 0000000000..a038ad494b --- /dev/null +++ b/www/apps/resources/references/core_flows/Pricing/Workflows_Pricing/functions/core_flows.Pricing.Workflows_Pricing.updatePricePreferencesWorkflow/page.mdx @@ -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 + + + +## Input + + + +## Output + + diff --git a/www/apps/resources/references/core_flows/Pricing/Workflows_Pricing/variables/core_flows.Pricing.Workflows_Pricing.createPricePreferencesWorkflowId/page.mdx b/www/apps/resources/references/core_flows/Pricing/Workflows_Pricing/variables/core_flows.Pricing.Workflows_Pricing.createPricePreferencesWorkflowId/page.mdx new file mode 100644 index 0000000000..07deebc24f --- /dev/null +++ b/www/apps/resources/references/core_flows/Pricing/Workflows_Pricing/variables/core_flows.Pricing.Workflows_Pricing.createPricePreferencesWorkflowId/page.mdx @@ -0,0 +1,5 @@ +import { TypeList, WorkflowDiagram } from "docs-ui" + +# createPricePreferencesWorkflowId + + `Const` **createPricePreferencesWorkflowId**: `"create-price-preferences"` diff --git a/www/apps/resources/references/core_flows/Pricing/Workflows_Pricing/variables/core_flows.Pricing.Workflows_Pricing.deletePricePreferencesWorkflowId/page.mdx b/www/apps/resources/references/core_flows/Pricing/Workflows_Pricing/variables/core_flows.Pricing.Workflows_Pricing.deletePricePreferencesWorkflowId/page.mdx new file mode 100644 index 0000000000..6d6f8f34ed --- /dev/null +++ b/www/apps/resources/references/core_flows/Pricing/Workflows_Pricing/variables/core_flows.Pricing.Workflows_Pricing.deletePricePreferencesWorkflowId/page.mdx @@ -0,0 +1,5 @@ +import { TypeList, WorkflowDiagram } from "docs-ui" + +# deletePricePreferencesWorkflowId + + `Const` **deletePricePreferencesWorkflowId**: `"delete-price-preferences"` diff --git a/www/apps/resources/references/core_flows/Pricing/Workflows_Pricing/variables/core_flows.Pricing.Workflows_Pricing.updatePricePreferencesWorkflowId/page.mdx b/www/apps/resources/references/core_flows/Pricing/Workflows_Pricing/variables/core_flows.Pricing.Workflows_Pricing.updatePricePreferencesWorkflowId/page.mdx new file mode 100644 index 0000000000..73472a6d31 --- /dev/null +++ b/www/apps/resources/references/core_flows/Pricing/Workflows_Pricing/variables/core_flows.Pricing.Workflows_Pricing.updatePricePreferencesWorkflowId/page.mdx @@ -0,0 +1,5 @@ +import { TypeList, WorkflowDiagram } from "docs-ui" + +# updatePricePreferencesWorkflowId + + `Const` **updatePricePreferencesWorkflowId**: `"update-price-preferences"` diff --git a/www/apps/resources/references/core_flows/Pricing/core_flows.Pricing.Steps_Pricing/page.mdx b/www/apps/resources/references/core_flows/Pricing/core_flows.Pricing.Steps_Pricing/page.mdx new file mode 100644 index 0000000000..975e9b9bbb --- /dev/null +++ b/www/apps/resources/references/core_flows/Pricing/core_flows.Pricing.Steps_Pricing/page.mdx @@ -0,0 +1,81 @@ +import { TypeList, WorkflowDiagram } from "docs-ui" + +# Steps\_Pricing + +## createPricePreferencesStep + +This step creates one or more price preferences. + +### Input + + + +### Output + + + +___ + +## createPriceSetsStep + +This step creates one or more price sets. + +### Input + + + +### Output + + + +___ + +## deletePricePreferencesStep + +This step deletes one or more price preferences. + +### Input + + + +___ + +## updatePricePreferencesAsArrayStep + +This step updates price preferences. + +### Input + + + +### Output + + + +___ + +## updatePricePreferencesStep + +This step updates price preferences matching the specified filters. + +### Input + + + +### Output + + + +___ + +## updatePriceSetsStep + +This step updates price sets. + +### Input + +`","description":"an object whose keys are the name of the context attribute. Its value can be a string or a BigNumberInput. For example, you can pass the `currency_code` property with its value being the currency code to calculate the price in.\nAnother example is passing the `quantity` property to calculate the price for that specified quantity, which finds a price set whose `min_quantity` and `max_quantity` conditions match the specified quantity.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`[]","description":"IDs to filter price sets by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"[FilterableMoneyAmountProps](../../../pricing/interfaces/pricing.FilterableMoneyAmountProps/page.mdx)","description":"Filters to apply on a price set's associated money amounts.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../pricing/interfaces/pricing.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../pricing/interfaces/pricing.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterablePriceSetProps](../../../pricing/interfaces/pricing.FilterablePriceSetProps/page.mdx) \\| [BaseFilterable](../../../pricing/interfaces/pricing.BaseFilterable/page.mdx)<[FilterablePriceSetProps](../../../pricing/interfaces/pricing.FilterablePriceSetProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterablePriceSetProps](../../../pricing/interfaces/pricing.FilterablePriceSetProps/page.mdx) \\| [BaseFilterable](../../../pricing/interfaces/pricing.BaseFilterable/page.mdx)<[FilterablePriceSetProps](../../../pricing/interfaces/pricing.FilterablePriceSetProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterablePriceSetProps](../../../pricing/interfaces/pricing.FilterablePriceSetProps/page.mdx) \\| [BaseFilterable](../../../pricing/interfaces/pricing.BaseFilterable/page.mdx)<[FilterablePriceSetProps](../../../pricing/interfaces/pricing.FilterablePriceSetProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"`Record`","description":"an object whose keys are the name of the context attribute. Its value can be a string or a BigNumberInput. For example, you can pass the `currency_code` property with its value being the currency code to calculate the price in.\nAnother example is passing the `quantity` property to calculate the price for that specified quantity, which finds a price set whose `min_quantity` and `max_quantity` conditions match the specified quantity.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`[]","description":"IDs to filter price sets by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"[FilterableMoneyAmountProps](../../../pricing/interfaces/pricing.FilterableMoneyAmountProps/page.mdx)","description":"Filters to apply on a price set's associated money amounts.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../pricing/interfaces/pricing.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../pricing/interfaces/pricing.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"context","type":"`Record`","description":"an object whose keys are the name of the context attribute. Its value can be a string or a BigNumberInput. For example, you can pass the `currency_code` property with its value being the currency code to calculate the price in.\nAnother example is passing the `quantity` property to calculate the price for that specified quantity, which finds a price set whose `min_quantity` and `max_quantity` conditions match the specified quantity.","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](../../../pricing/types/pricing.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"id","type":"`string`[]","description":"IDs to filter price sets by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"[FilterableMoneyAmountProps](../../../pricing/interfaces/pricing.FilterableMoneyAmountProps/page.mdx)","description":"Filters to apply on a price set's associated money amounts.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableMoneyAmountProps](../../../pricing/interfaces/pricing.FilterableMoneyAmountProps/page.mdx) \\| [BaseFilterable](../../../pricing/interfaces/pricing.BaseFilterable/page.mdx)<[FilterableMoneyAmountProps](../../../pricing/interfaces/pricing.FilterableMoneyAmountProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableMoneyAmountProps](../../../pricing/interfaces/pricing.FilterableMoneyAmountProps/page.mdx) \\| [BaseFilterable](../../../pricing/interfaces/pricing.BaseFilterable/page.mdx)<[FilterableMoneyAmountProps](../../../pricing/interfaces/pricing.FilterableMoneyAmountProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`[]","description":"IDs to filter money amounts by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string` \\| `string`[]","description":"Currency codes to filter money amounts by.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"update","type":"[UpdatePriceSetDTO](../../../pricing/interfaces/pricing.UpdatePriceSetDTO/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"prices","type":"[CreatePricesDTO](../../../pricing/interfaces/pricing.CreatePricesDTO/page.mdx)[]","description":"The prices to create and add to this price set.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"currency_code","type":"`string`","description":"The currency code of this money amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberInput](../../../pricing/types/pricing.BigNumberInput/page.mdx)","description":"The amount of this money amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The ID of the money amount.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"min_quantity","type":"`null` \\| [BigNumberInput](../../../pricing/types/pricing.BigNumberInput/page.mdx)","description":"The minimum quantity required to be purchased for this money amount to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"max_quantity","type":"`null` \\| [BigNumberInput](../../../pricing/types/pricing.BigNumberInput/page.mdx)","description":"The maximum quantity required to be purchased for this money amount to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[CreatePriceSetPriceRules](../../../pricing/interfaces/pricing.CreatePriceSetPriceRules/page.mdx)","description":"The rules to add to the price. The object's keys are the attribute, and values are the value of that rule associated with this price.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updatePriceSetsStep"/> + +### Output + + diff --git a/www/apps/resources/references/core_flows/Pricing/core_flows.Pricing.Workflows_Pricing/page.mdx b/www/apps/resources/references/core_flows/Pricing/core_flows.Pricing.Workflows_Pricing/page.mdx new file mode 100644 index 0000000000..25c30bda59 --- /dev/null +++ b/www/apps/resources/references/core_flows/Pricing/core_flows.Pricing.Workflows_Pricing/page.mdx @@ -0,0 +1,51 @@ +import { TypeList, WorkflowDiagram } from "docs-ui" + +# Workflows\_Pricing + +## createPricePreferencesWorkflow + +This workflow creates one or more price preferences. + +### Steps + + + +### Input + + + +### Output + + + +___ + +## deletePricePreferencesWorkflow + +This workflow deletes one or more price preferences. + +### Steps + + + +### Input + + + +___ + +## updatePricePreferencesWorkflow + +This workflow updates one or more price preferences. + +### Steps + + + +### Input + + + +### Output + + diff --git a/www/apps/resources/references/core_flows/Return_Reason/Steps_Return_Reason/functions/core_flows.Return_Reason.Steps_Return_Reason.createReturnReasonsStep/page.mdx b/www/apps/resources/references/core_flows/Return_Reason/Steps_Return_Reason/functions/core_flows.Return_Reason.Steps_Return_Reason.createReturnReasonsStep/page.mdx new file mode 100644 index 0000000000..26c33c8651 --- /dev/null +++ b/www/apps/resources/references/core_flows/Return_Reason/Steps_Return_Reason/functions/core_flows.Return_Reason.Steps_Return_Reason.createReturnReasonsStep/page.mdx @@ -0,0 +1,20 @@ +--- +slug: /references/medusa-workflows/steps/createReturnReasonsStep +sidebar_label: createReturnReasonsStep +--- + +import { TypeList, WorkflowDiagram } from "docs-ui" + +# createReturnReasonsStep - Medusa Workflows API Reference + +This documentation provides a reference to the `createReturnReasonsStep`. It belongs to the `@medusajs/core-flows` package. + +This step creates one or more return reasons. + +## Input + +`","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="createReturnReasonsStep"/> + +## Output + +`","description":"The metadata of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the return reason was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the return reason was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the return reason","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`string`","description":"The parent return reason ID","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason","type":"[OrderReturnReasonDTO](../../../../../order/interfaces/order.OrderReturnReasonDTO/page.mdx)","description":"The associated order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The unique value of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"The label of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"The metadata of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the return reason was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the return reason was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the return reason","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`string`","description":"The parent return reason ID","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason","type":"[OrderReturnReasonDTO](../../../../../order/interfaces/order.OrderReturnReasonDTO/page.mdx)","description":"The associated order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_reason_children","type":"[OrderReturnReasonDTO](../../../../../order/interfaces/order.OrderReturnReasonDTO/page.mdx)[]","description":"The return reason children of the order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"return_reason_children","type":"[OrderReturnReasonDTO](../../../../../order/interfaces/order.OrderReturnReasonDTO/page.mdx)[]","description":"The return reason children of the order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The unique value of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"The label of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"The metadata of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the return reason was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the return reason was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the return reason","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`string`","description":"The parent return reason ID","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason","type":"[OrderReturnReasonDTO](../../../../../order/interfaces/order.OrderReturnReasonDTO/page.mdx)","description":"The associated order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_reason_children","type":"[OrderReturnReasonDTO](../../../../../order/interfaces/order.OrderReturnReasonDTO/page.mdx)[]","description":"The return reason children of the order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createReturnReasonsStep"/> diff --git a/www/apps/resources/references/core_flows/Return_Reason/Steps_Return_Reason/functions/core_flows.Return_Reason.Steps_Return_Reason.deleteReturnReasonStep/page.mdx b/www/apps/resources/references/core_flows/Return_Reason/Steps_Return_Reason/functions/core_flows.Return_Reason.Steps_Return_Reason.deleteReturnReasonStep/page.mdx new file mode 100644 index 0000000000..9ad621460f --- /dev/null +++ b/www/apps/resources/references/core_flows/Return_Reason/Steps_Return_Reason/functions/core_flows.Return_Reason.Steps_Return_Reason.deleteReturnReasonStep/page.mdx @@ -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 + + diff --git a/www/apps/resources/references/core_flows/Return_Reason/Steps_Return_Reason/functions/core_flows.Return_Reason.Steps_Return_Reason.updateReturnReasonsStep/page.mdx b/www/apps/resources/references/core_flows/Return_Reason/Steps_Return_Reason/functions/core_flows.Return_Reason.Steps_Return_Reason.updateReturnReasonsStep/page.mdx new file mode 100644 index 0000000000..330b948102 --- /dev/null +++ b/www/apps/resources/references/core_flows/Return_Reason/Steps_Return_Reason/functions/core_flows.Return_Reason.Steps_Return_Reason.updateReturnReasonsStep/page.mdx @@ -0,0 +1,20 @@ +--- +slug: /references/medusa-workflows/steps/updateReturnReasonsStep +sidebar_label: updateReturnReasonsStep +--- + +import { TypeList, WorkflowDiagram } from "docs-ui" + +# updateReturnReasonsStep - Medusa Workflows API Reference + +This documentation provides a reference to the `updateReturnReasonsStep`. It belongs to the `@medusajs/core-flows` package. + +This step updates return reasons matching the specified filters. + +## Input + + + +## Output + +`","description":"The metadata of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the return reason was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the return reason was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the return reason","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`string`","description":"The parent return reason ID","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason","type":"[OrderReturnReasonDTO](../../../../../order/interfaces/order.OrderReturnReasonDTO/page.mdx)","description":"The associated order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The unique value of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"The label of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"The metadata of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the return reason was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the return reason was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the return reason","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`string`","description":"The parent return reason ID","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason","type":"[OrderReturnReasonDTO](../../../../../order/interfaces/order.OrderReturnReasonDTO/page.mdx)","description":"The associated order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_reason_children","type":"[OrderReturnReasonDTO](../../../../../order/interfaces/order.OrderReturnReasonDTO/page.mdx)[]","description":"The return reason children of the order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"return_reason_children","type":"[OrderReturnReasonDTO](../../../../../order/interfaces/order.OrderReturnReasonDTO/page.mdx)[]","description":"The return reason children of the order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The unique value of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"The label of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"The metadata of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the return reason was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the return reason was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the return reason","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`string`","description":"The parent return reason ID","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason","type":"[OrderReturnReasonDTO](../../../../../order/interfaces/order.OrderReturnReasonDTO/page.mdx)","description":"The associated order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_reason_children","type":"[OrderReturnReasonDTO](../../../../../order/interfaces/order.OrderReturnReasonDTO/page.mdx)[]","description":"The return reason children of the order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateReturnReasonsStep"/> diff --git a/www/apps/resources/references/core_flows/Return_Reason/Steps_Return_Reason/variables/core_flows.Return_Reason.Steps_Return_Reason.createReturnReasonsStepId/page.mdx b/www/apps/resources/references/core_flows/Return_Reason/Steps_Return_Reason/variables/core_flows.Return_Reason.Steps_Return_Reason.createReturnReasonsStepId/page.mdx new file mode 100644 index 0000000000..23acfbe864 --- /dev/null +++ b/www/apps/resources/references/core_flows/Return_Reason/Steps_Return_Reason/variables/core_flows.Return_Reason.Steps_Return_Reason.createReturnReasonsStepId/page.mdx @@ -0,0 +1,5 @@ +import { TypeList, WorkflowDiagram } from "docs-ui" + +# createReturnReasonsStepId + + `Const` **createReturnReasonsStepId**: `"create-return-reasons"` diff --git a/www/apps/resources/references/core_flows/Return_Reason/Steps_Return_Reason/variables/core_flows.Return_Reason.Steps_Return_Reason.deleteReturnReasonStepId/page.mdx b/www/apps/resources/references/core_flows/Return_Reason/Steps_Return_Reason/variables/core_flows.Return_Reason.Steps_Return_Reason.deleteReturnReasonStepId/page.mdx new file mode 100644 index 0000000000..5480cd1f26 --- /dev/null +++ b/www/apps/resources/references/core_flows/Return_Reason/Steps_Return_Reason/variables/core_flows.Return_Reason.Steps_Return_Reason.deleteReturnReasonStepId/page.mdx @@ -0,0 +1,5 @@ +import { TypeList, WorkflowDiagram } from "docs-ui" + +# deleteReturnReasonStepId + + `Const` **deleteReturnReasonStepId**: `"delete-return-reasons"` diff --git a/www/apps/resources/references/core_flows/Return_Reason/Steps_Return_Reason/variables/core_flows.Return_Reason.Steps_Return_Reason.updateReturnReasonStepId/page.mdx b/www/apps/resources/references/core_flows/Return_Reason/Steps_Return_Reason/variables/core_flows.Return_Reason.Steps_Return_Reason.updateReturnReasonStepId/page.mdx new file mode 100644 index 0000000000..9a869f98b8 --- /dev/null +++ b/www/apps/resources/references/core_flows/Return_Reason/Steps_Return_Reason/variables/core_flows.Return_Reason.Steps_Return_Reason.updateReturnReasonStepId/page.mdx @@ -0,0 +1,5 @@ +import { TypeList, WorkflowDiagram } from "docs-ui" + +# updateReturnReasonStepId + + `Const` **updateReturnReasonStepId**: `"update-return-reasons"` diff --git a/www/apps/resources/references/core_flows/Return_Reason/Workflows_Return_Reason/functions/core_flows.Return_Reason.Workflows_Return_Reason.createReturnReasonsWorkflow/page.mdx b/www/apps/resources/references/core_flows/Return_Reason/Workflows_Return_Reason/functions/core_flows.Return_Reason.Workflows_Return_Reason.createReturnReasonsWorkflow/page.mdx new file mode 100644 index 0000000000..bfd27c77a9 --- /dev/null +++ b/www/apps/resources/references/core_flows/Return_Reason/Workflows_Return_Reason/functions/core_flows.Return_Reason.Workflows_Return_Reason.createReturnReasonsWorkflow/page.mdx @@ -0,0 +1,24 @@ +--- +slug: /references/medusa-workflows/createReturnReasonsWorkflow +sidebar_label: createReturnReasonsWorkflow +--- + +import { TypeList, WorkflowDiagram } from "docs-ui" + +# createReturnReasonsWorkflow - Medusa Workflows API Reference + +This documentation provides a reference to the `createReturnReasonsWorkflow`. It belongs to the `@medusajs/core-flows` package. + +This workflow creates one or more return reasons. + +## Steps + + + +## Input + +`","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="createReturnReasonsWorkflow"/> + +## Output + +`","description":"The metadata of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the return reason was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the return reason was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the return reason","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`string`","description":"The parent return reason ID","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason","type":"[OrderReturnReasonDTO](../../../../../order/interfaces/order.OrderReturnReasonDTO/page.mdx)","description":"The associated order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The unique value of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"The label of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"The metadata of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the return reason was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the return reason was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the return reason","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`string`","description":"The parent return reason ID","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason","type":"[OrderReturnReasonDTO](../../../../../order/interfaces/order.OrderReturnReasonDTO/page.mdx)","description":"The associated order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_reason_children","type":"[OrderReturnReasonDTO](../../../../../order/interfaces/order.OrderReturnReasonDTO/page.mdx)[]","description":"The return reason children of the order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"return_reason_children","type":"[OrderReturnReasonDTO](../../../../../order/interfaces/order.OrderReturnReasonDTO/page.mdx)[]","description":"The return reason children of the order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The unique value of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"The label of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"The metadata of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the return reason was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the return reason was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the return reason","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`string`","description":"The parent return reason ID","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason","type":"[OrderReturnReasonDTO](../../../../../order/interfaces/order.OrderReturnReasonDTO/page.mdx)","description":"The associated order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_reason_children","type":"[OrderReturnReasonDTO](../../../../../order/interfaces/order.OrderReturnReasonDTO/page.mdx)[]","description":"The return reason children of the order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createReturnReasonsWorkflow"/> diff --git a/www/apps/resources/references/core_flows/Return_Reason/Workflows_Return_Reason/functions/core_flows.Return_Reason.Workflows_Return_Reason.deleteReturnReasonsWorkflow/page.mdx b/www/apps/resources/references/core_flows/Return_Reason/Workflows_Return_Reason/functions/core_flows.Return_Reason.Workflows_Return_Reason.deleteReturnReasonsWorkflow/page.mdx new file mode 100644 index 0000000000..5185d0276b --- /dev/null +++ b/www/apps/resources/references/core_flows/Return_Reason/Workflows_Return_Reason/functions/core_flows.Return_Reason.Workflows_Return_Reason.deleteReturnReasonsWorkflow/page.mdx @@ -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 + + + +## Input + + diff --git a/www/apps/resources/references/core_flows/Return_Reason/Workflows_Return_Reason/functions/core_flows.Return_Reason.Workflows_Return_Reason.updateReturnReasonsWorkflow/page.mdx b/www/apps/resources/references/core_flows/Return_Reason/Workflows_Return_Reason/functions/core_flows.Return_Reason.Workflows_Return_Reason.updateReturnReasonsWorkflow/page.mdx new file mode 100644 index 0000000000..deadfc8c6c --- /dev/null +++ b/www/apps/resources/references/core_flows/Return_Reason/Workflows_Return_Reason/functions/core_flows.Return_Reason.Workflows_Return_Reason.updateReturnReasonsWorkflow/page.mdx @@ -0,0 +1,24 @@ +--- +slug: /references/medusa-workflows/updateReturnReasonsWorkflow +sidebar_label: updateReturnReasonsWorkflow +--- + +import { TypeList, WorkflowDiagram } from "docs-ui" + +# updateReturnReasonsWorkflow - Medusa Workflows API Reference + +This documentation provides a reference to the `updateReturnReasonsWorkflow`. It belongs to the `@medusajs/core-flows` package. + +This workflow updates return reasons matching the specified filters. + +## Steps + + + +## Input + + + +## Output + +`","description":"The metadata of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the return reason was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the return reason was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the return reason","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`string`","description":"The parent return reason ID","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason","type":"[OrderReturnReasonDTO](../../../../../order/interfaces/order.OrderReturnReasonDTO/page.mdx)","description":"The associated order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The unique value of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"The label of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"The metadata of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the return reason was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the return reason was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the return reason","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`string`","description":"The parent return reason ID","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason","type":"[OrderReturnReasonDTO](../../../../../order/interfaces/order.OrderReturnReasonDTO/page.mdx)","description":"The associated order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_reason_children","type":"[OrderReturnReasonDTO](../../../../../order/interfaces/order.OrderReturnReasonDTO/page.mdx)[]","description":"The return reason children of the order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"return_reason_children","type":"[OrderReturnReasonDTO](../../../../../order/interfaces/order.OrderReturnReasonDTO/page.mdx)[]","description":"The return reason children of the order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The unique value of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"The label of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"The metadata of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the return reason was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the return reason was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the return reason","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`string`","description":"The parent return reason ID","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason","type":"[OrderReturnReasonDTO](../../../../../order/interfaces/order.OrderReturnReasonDTO/page.mdx)","description":"The associated order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_reason_children","type":"[OrderReturnReasonDTO](../../../../../order/interfaces/order.OrderReturnReasonDTO/page.mdx)[]","description":"The return reason children of the order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateReturnReasonsWorkflow"/> diff --git a/www/apps/resources/references/core_flows/Return_Reason/Workflows_Return_Reason/variables/core_flows.Return_Reason.Workflows_Return_Reason.createReturnReasonsWorkflowId/page.mdx b/www/apps/resources/references/core_flows/Return_Reason/Workflows_Return_Reason/variables/core_flows.Return_Reason.Workflows_Return_Reason.createReturnReasonsWorkflowId/page.mdx new file mode 100644 index 0000000000..20b076071a --- /dev/null +++ b/www/apps/resources/references/core_flows/Return_Reason/Workflows_Return_Reason/variables/core_flows.Return_Reason.Workflows_Return_Reason.createReturnReasonsWorkflowId/page.mdx @@ -0,0 +1,5 @@ +import { TypeList, WorkflowDiagram } from "docs-ui" + +# createReturnReasonsWorkflowId + + `Const` **createReturnReasonsWorkflowId**: `"create-return-reasons"` diff --git a/www/apps/resources/references/core_flows/Return_Reason/Workflows_Return_Reason/variables/core_flows.Return_Reason.Workflows_Return_Reason.deleteReturnReasonsWorkflowId/page.mdx b/www/apps/resources/references/core_flows/Return_Reason/Workflows_Return_Reason/variables/core_flows.Return_Reason.Workflows_Return_Reason.deleteReturnReasonsWorkflowId/page.mdx new file mode 100644 index 0000000000..cb9dd2753d --- /dev/null +++ b/www/apps/resources/references/core_flows/Return_Reason/Workflows_Return_Reason/variables/core_flows.Return_Reason.Workflows_Return_Reason.deleteReturnReasonsWorkflowId/page.mdx @@ -0,0 +1,5 @@ +import { TypeList, WorkflowDiagram } from "docs-ui" + +# deleteReturnReasonsWorkflowId + + `Const` **deleteReturnReasonsWorkflowId**: `"delete-return-reasons"` diff --git a/www/apps/resources/references/core_flows/Return_Reason/Workflows_Return_Reason/variables/core_flows.Return_Reason.Workflows_Return_Reason.updateReturnReasonsWorkflowId/page.mdx b/www/apps/resources/references/core_flows/Return_Reason/Workflows_Return_Reason/variables/core_flows.Return_Reason.Workflows_Return_Reason.updateReturnReasonsWorkflowId/page.mdx new file mode 100644 index 0000000000..4556779095 --- /dev/null +++ b/www/apps/resources/references/core_flows/Return_Reason/Workflows_Return_Reason/variables/core_flows.Return_Reason.Workflows_Return_Reason.updateReturnReasonsWorkflowId/page.mdx @@ -0,0 +1,5 @@ +import { TypeList, WorkflowDiagram } from "docs-ui" + +# updateReturnReasonsWorkflowId + + `Const` **updateReturnReasonsWorkflowId**: `"update-return-reasons"` diff --git a/www/apps/resources/references/core_flows/Return_Reason/core_flows.Return_Reason.Steps_Return_Reason/page.mdx b/www/apps/resources/references/core_flows/Return_Reason/core_flows.Return_Reason.Steps_Return_Reason/page.mdx new file mode 100644 index 0000000000..13db39bf51 --- /dev/null +++ b/www/apps/resources/references/core_flows/Return_Reason/core_flows.Return_Reason.Steps_Return_Reason/page.mdx @@ -0,0 +1,39 @@ +import { TypeList, WorkflowDiagram } from "docs-ui" + +# Steps\_Return Reason + +## createReturnReasonsStep + +This step creates one or more return reasons. + +### Input + +`","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="createReturnReasonsStep"/> + +### Output + +`","description":"The metadata of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the return reason was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the return reason was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the return reason","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`string`","description":"The parent return reason ID","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason","type":"[OrderReturnReasonDTO](../../../order/interfaces/order.OrderReturnReasonDTO/page.mdx)","description":"The associated order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The unique value of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"The label of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"The metadata of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the return reason was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the return reason was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the return reason","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`string`","description":"The parent return reason ID","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason","type":"[OrderReturnReasonDTO](../../../order/interfaces/order.OrderReturnReasonDTO/page.mdx)","description":"The associated order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_reason_children","type":"[OrderReturnReasonDTO](../../../order/interfaces/order.OrderReturnReasonDTO/page.mdx)[]","description":"The return reason children of the order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"return_reason_children","type":"[OrderReturnReasonDTO](../../../order/interfaces/order.OrderReturnReasonDTO/page.mdx)[]","description":"The return reason children of the order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The unique value of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"The label of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"The metadata of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the return reason was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the return reason was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the return reason","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`string`","description":"The parent return reason ID","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason","type":"[OrderReturnReasonDTO](../../../order/interfaces/order.OrderReturnReasonDTO/page.mdx)","description":"The associated order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_reason_children","type":"[OrderReturnReasonDTO](../../../order/interfaces/order.OrderReturnReasonDTO/page.mdx)[]","description":"The return reason children of the order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createReturnReasonsStep"/> + +___ + +## deleteReturnReasonStep + +This step deletes one or more return reasons. + +### Input + + + +___ + +## updateReturnReasonsStep + +This step updates return reasons matching the specified filters. + +### Input + + + +### Output + +`","description":"The metadata of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the return reason was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the return reason was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the return reason","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`string`","description":"The parent return reason ID","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason","type":"[OrderReturnReasonDTO](../../../order/interfaces/order.OrderReturnReasonDTO/page.mdx)","description":"The associated order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The unique value of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"The label of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"The metadata of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the return reason was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the return reason was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the return reason","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`string`","description":"The parent return reason ID","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason","type":"[OrderReturnReasonDTO](../../../order/interfaces/order.OrderReturnReasonDTO/page.mdx)","description":"The associated order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_reason_children","type":"[OrderReturnReasonDTO](../../../order/interfaces/order.OrderReturnReasonDTO/page.mdx)[]","description":"The return reason children of the order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"return_reason_children","type":"[OrderReturnReasonDTO](../../../order/interfaces/order.OrderReturnReasonDTO/page.mdx)[]","description":"The return reason children of the order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The unique value of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"The label of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"The metadata of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the return reason was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the return reason was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the return reason","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`string`","description":"The parent return reason ID","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason","type":"[OrderReturnReasonDTO](../../../order/interfaces/order.OrderReturnReasonDTO/page.mdx)","description":"The associated order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_reason_children","type":"[OrderReturnReasonDTO](../../../order/interfaces/order.OrderReturnReasonDTO/page.mdx)[]","description":"The return reason children of the order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateReturnReasonsStep"/> diff --git a/www/apps/resources/references/core_flows/Return_Reason/core_flows.Return_Reason.Workflows_Return_Reason/page.mdx b/www/apps/resources/references/core_flows/Return_Reason/core_flows.Return_Reason.Workflows_Return_Reason/page.mdx new file mode 100644 index 0000000000..d7198bff64 --- /dev/null +++ b/www/apps/resources/references/core_flows/Return_Reason/core_flows.Return_Reason.Workflows_Return_Reason/page.mdx @@ -0,0 +1,51 @@ +import { TypeList, WorkflowDiagram } from "docs-ui" + +# Workflows\_Return Reason + +## createReturnReasonsWorkflow + +This workflow creates one or more return reasons. + +### Steps + + + +### Input + +`","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="createReturnReasonsWorkflow"/> + +### Output + +`","description":"The metadata of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the return reason was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the return reason was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the return reason","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`string`","description":"The parent return reason ID","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason","type":"[OrderReturnReasonDTO](../../../order/interfaces/order.OrderReturnReasonDTO/page.mdx)","description":"The associated order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The unique value of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"The label of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"The metadata of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the return reason was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the return reason was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the return reason","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`string`","description":"The parent return reason ID","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason","type":"[OrderReturnReasonDTO](../../../order/interfaces/order.OrderReturnReasonDTO/page.mdx)","description":"The associated order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_reason_children","type":"[OrderReturnReasonDTO](../../../order/interfaces/order.OrderReturnReasonDTO/page.mdx)[]","description":"The return reason children of the order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"return_reason_children","type":"[OrderReturnReasonDTO](../../../order/interfaces/order.OrderReturnReasonDTO/page.mdx)[]","description":"The return reason children of the order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The unique value of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"The label of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"The metadata of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the return reason was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the return reason was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the return reason","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`string`","description":"The parent return reason ID","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason","type":"[OrderReturnReasonDTO](../../../order/interfaces/order.OrderReturnReasonDTO/page.mdx)","description":"The associated order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_reason_children","type":"[OrderReturnReasonDTO](../../../order/interfaces/order.OrderReturnReasonDTO/page.mdx)[]","description":"The return reason children of the order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createReturnReasonsWorkflow"/> + +___ + +## deleteReturnReasonsWorkflow + +This workflow deletes one or more return reasons. + +### Steps + + + +### Input + + + +___ + +## updateReturnReasonsWorkflow + +This workflow updates return reasons matching the specified filters. + +### Steps + + + +### Input + + + +### Output + +`","description":"The metadata of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the return reason was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the return reason was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the return reason","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`string`","description":"The parent return reason ID","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason","type":"[OrderReturnReasonDTO](../../../order/interfaces/order.OrderReturnReasonDTO/page.mdx)","description":"The associated order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The unique value of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"The label of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"The metadata of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the return reason was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the return reason was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the return reason","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`string`","description":"The parent return reason ID","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason","type":"[OrderReturnReasonDTO](../../../order/interfaces/order.OrderReturnReasonDTO/page.mdx)","description":"The associated order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_reason_children","type":"[OrderReturnReasonDTO](../../../order/interfaces/order.OrderReturnReasonDTO/page.mdx)[]","description":"The return reason children of the order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"return_reason_children","type":"[OrderReturnReasonDTO](../../../order/interfaces/order.OrderReturnReasonDTO/page.mdx)[]","description":"The return reason children of the order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The unique value of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"The label of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"The metadata of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the return reason was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the return reason was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the return reason","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`string`","description":"The parent return reason ID","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason","type":"[OrderReturnReasonDTO](../../../order/interfaces/order.OrderReturnReasonDTO/page.mdx)","description":"The associated order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_reason_children","type":"[OrderReturnReasonDTO](../../../order/interfaces/order.OrderReturnReasonDTO/page.mdx)[]","description":"The return reason children of the order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateReturnReasonsWorkflow"/> diff --git a/www/apps/resources/references/core_flows/core_flows.Price_List/page.mdx b/www/apps/resources/references/core_flows/core_flows.Price_List/page.mdx new file mode 100644 index 0000000000..55e350c141 --- /dev/null +++ b/www/apps/resources/references/core_flows/core_flows.Price_List/page.mdx @@ -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) diff --git a/www/apps/resources/references/core_flows/core_flows.Pricing/page.mdx b/www/apps/resources/references/core_flows/core_flows.Pricing/page.mdx new file mode 100644 index 0000000000..9f05cea393 --- /dev/null +++ b/www/apps/resources/references/core_flows/core_flows.Pricing/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) diff --git a/www/apps/resources/references/core_flows/core_flows.Return_Reason/page.mdx b/www/apps/resources/references/core_flows/core_flows.Return_Reason/page.mdx new file mode 100644 index 0000000000..85fe8fdf49 --- /dev/null +++ b/www/apps/resources/references/core_flows/core_flows.Return_Reason/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)