asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

docs: fix incorrect note usage in some workflow references (#12317)

Browse Source
This commit is contained in:
Shahed Nasser
2025-04-29 10:49:28 +03:00
committed by GitHub
parent c1e6b81972
commit f4fba0986c
7 changed files with 17 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
www/apps/resources/references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.createShippingOptionsPriceSetsStep/page.mdx
View File

@@ -19,7 +19,7 @@ This step creates price sets for one or more shipping options.
Learn more about adding rules to the shipping option's prices in the Pricing Module's
[Price Rules](https://docs.medusajs.com/resources/commerce-modules/pricing/price-rules) documentation.
:::note
:::
```ts title="src/workflows/my-workflow.ts"
import { createWorkflow } from "@medusajs/framework/workflows-sdk"
@@ -29,10 +29,10 @@ const myWorkflow = createWorkflow(
"my-workflow",
() => {
const data = createShippingOptionsPriceSetsStep({
"id": "id_6Y3b5AJbKpi",
"id": "id_e63ob1V2XAJeBaK6APqK",
"prices": [{
"currency_code": "sle",
"amount": 3
"currency_code": "stn",
"amount": 18
}]
})
}

6
www/apps/resources/references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.createShippingOptionsWorkflow/page.mdx
View File

@@ -21,7 +21,7 @@ This workflow creates one or more shipping options. It's used by the
You can use this workflow within your own customizations or custom workflows, allowing you to
create shipping options within your custom flows.
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/876a14eb98aed54360312b9b215599aa46faccd8/packages/core/core-flows/src/fulfillment/workflows/create-shipping-options.ts#L99" />
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/c1e6b81972cacebe040fd28dc5c6da82e60b3eac/packages/core/core-flows/src/fulfillment/workflows/create-shipping-options.ts#L99" />
## Examples
@@ -32,7 +32,7 @@ To calculate a shipping option with flat rate prices:
Learn more about adding rules to the shipping option's prices in the Pricing Module's
[Price Rules](https://docs.medusajs.com/resources/commerce-modules/pricing/price-rules) documentation.
:::note
:::
<CodeTabs group="workflow-exection">
<CodeTab label="API Route" value="api-route">
@@ -338,7 +338,7 @@ const myWorkflow = createWorkflow(
## Steps
<WorkflowDiagram workflow={{"name":"createShippingOptionsWorkflow","steps":[{"type":"step","name":"validateShippingOptionPricesStep","description":"This step validates that shipping options can be created based on provided price configuration.\n\nFor flat rate prices, it validates that regions exist for the shipping option prices.\nFor calculated prices, it validates with the fulfillment provider if the price can be calculated.\n\nIf not valid, the step throws an error.","link":"../../../Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.validateShippingOptionPricesStep/page.mdx","depth":1},{"type":"step","name":"upsertShippingOptionsStep","description":"This step creates or updates shipping options.","link":"../../../Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.upsertShippingOptionsStep/page.mdx","depth":2},{"type":"step","name":"createShippingOptionsPriceSetsStep","description":"This step creates price sets for one or more shipping options.\n\n:::note\n\nLearn more about adding rules to the shipping option's prices in the Pricing Module's \n[Price Rules](https://docs.medusajs.com/resources/commerce-modules/pricing/price-rules) documentation.\n\n:::note","link":"../../../Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.createShippingOptionsPriceSetsStep/page.mdx","depth":3}]}} />
<WorkflowDiagram workflow={{"name":"createShippingOptionsWorkflow","steps":[{"type":"step","name":"validateShippingOptionPricesStep","description":"This step validates that shipping options can be created based on provided price configuration.\n\nFor flat rate prices, it validates that regions exist for the shipping option prices.\nFor calculated prices, it validates with the fulfillment provider if the price can be calculated.\n\nIf not valid, the step throws an error.","link":"../../../Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.validateShippingOptionPricesStep/page.mdx","depth":1},{"type":"step","name":"upsertShippingOptionsStep","description":"This step creates or updates shipping options.","link":"../../../Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.upsertShippingOptionsStep/page.mdx","depth":2},{"type":"step","name":"createShippingOptionsPriceSetsStep","description":"This step creates price sets for one or more shipping options.\n\n:::note\n\nLearn more about adding rules to the shipping option's prices in the Pricing Module's \n[Price Rules](https://docs.medusajs.com/resources/commerce-modules/pricing/price-rules) documentation.\n\n:::","link":"../../../Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.createShippingOptionsPriceSetsStep/page.mdx","depth":3}]}} />
## Input

4
www/apps/resources/references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.updateShippingOptionsWorkflow/page.mdx
View File

@@ -27,9 +27,9 @@ update shipping options within your custom flows.
Learn more about adding rules to the shipping option's prices in the Pricing Module's
[Price Rules](https://docs.medusajs.com/resources/commerce-modules/pricing/price-rules) documentation.
:::note
:::
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/876a14eb98aed54360312b9b215599aa46faccd8/packages/core/core-flows/src/fulfillment/workflows/update-shipping-options.ts#L53" />
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/c1e6b81972cacebe040fd28dc5c6da82e60b3eac/packages/core/core-flows/src/fulfillment/workflows/update-shipping-options.ts#L53" />
## Examples

4
www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.createProductVariantsWorkflow/page.mdx
View File

@@ -30,9 +30,9 @@ You can also use this workflow within your customizations or your own custom wor
Learn more about adding rules to the product variant's prices in the Pricing Module's
[Price Rules](https://docs.medusajs.com/resources/commerce-modules/pricing/price-rules) documentation.
:::note
:::
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/876a14eb98aed54360312b9b215599aa46faccd8/packages/core/core-flows/src/product/workflows/create-product-variants.ts#L249" />
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/c1e6b81972cacebe040fd28dc5c6da82e60b3eac/packages/core/core-flows/src/product/workflows/create-product-variants.ts#L249" />
## Examples

4
www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.createProductsWorkflow/page.mdx
View File

@@ -30,9 +30,9 @@ You can also use this workflow within your customizations or your own custom wor
Learn more about adding rules to the product variant's prices in the Pricing Module's
[Price Rules](https://docs.medusajs.com/resources/commerce-modules/pricing/price-rules) documentation.
:::note
:::
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/876a14eb98aed54360312b9b215599aa46faccd8/packages/core/core-flows/src/product/workflows/create-products.ts#L163" />
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/c1e6b81972cacebe040fd28dc5c6da82e60b3eac/packages/core/core-flows/src/product/workflows/create-products.ts#L163" />
## Examples

4
www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.updateProductVariantsWorkflow/page.mdx
View File

@@ -27,9 +27,9 @@ You can also use this workflow within your customizations or your own custom wor
Learn more about adding rules to the product variant's prices in the Pricing Module's
[Price Rules](https://docs.medusajs.com/resources/commerce-modules/pricing/price-rules) documentation.
:::note
:::
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/876a14eb98aed54360312b9b215599aa46faccd8/packages/core/core-flows/src/product/workflows/update-product-variants.ts#L127" />
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/c1e6b81972cacebe040fd28dc5c6da82e60b3eac/packages/core/core-flows/src/product/workflows/update-product-variants.ts#L127" />
## Examples

4
www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.updateProductsWorkflow/page.mdx
View File

@@ -29,9 +29,9 @@ You can also use this workflow within your customizations or your own custom wor
Learn more about adding rules to the product variant's prices in the Pricing Module's
[Price Rules](https://docs.medusajs.com/resources/commerce-modules/pricing/price-rules) documentation.
:::note
:::
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/876a14eb98aed54360312b9b215599aa46faccd8/packages/core/core-flows/src/product/workflows/update-products.ts#L410" />
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/c1e6b81972cacebe040fd28dc5c6da82e60b3eac/packages/core/core-flows/src/product/workflows/update-products.ts#L410" />
## Examples