docs: [22/n] generate core-flows reference (#8805)
This commit is contained in:
Shahed Nasser
GitHub
+20
File diff suppressed because one or more lines are too long
+16
@@ -0,0 +1,16 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/steps/confirmInventoryStep
|
||||
sidebar_label: confirmInventoryStep
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# confirmInventoryStep - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `confirmInventoryStep`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This step confirms for one or more variants that their inventory has a required quantity.
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"ConfirmVariantInventoryStepInput","type":"[ConfirmVariantInventoryStepInput](../../../../interfaces/core_flows.ConfirmVariantInventoryStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"items","type":"`object`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"inventory_item_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"required_quantity","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"allow_backorder","type":"`boolean`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"location_ids","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="confirmInventoryStep"/>
|
||||
+20
File diff suppressed because one or more lines are too long
+16
@@ -0,0 +1,16 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/steps/createLineItemAdjustmentsStep
|
||||
sidebar_label: createLineItemAdjustmentsStep
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# createLineItemAdjustmentsStep - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `createLineItemAdjustmentsStep`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This step creates line item adjustments in a cart.
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"CreateLineItemAdjustmentsCartStepInput","type":"[CreateLineItemAdjustmentsCartStepInput](../../../../interfaces/core_flows.CreateLineItemAdjustmentsCartStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"lineItemAdjustmentsToCreate","type":"[CreateLineItemAdjustmentDTO](../../../../../cart/interfaces/cart.CreateLineItemAdjustmentDTO/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"code","type":"`string`","description":"The code of the promotion that lead to\nthis adjustment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberInput](../../../../../cart/types/cart.BigNumberInput/page.mdx)","description":"The amount to adjust the original amount with.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../../../cart/types/cart.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"item_id","type":"`string`","description":"The associated item's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the adjustment.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"promotion_id","type":"`string`","description":"The associated promotion's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"The associated provider's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createLineItemAdjustmentsStep"/>
|
||||
+20
File diff suppressed because one or more lines are too long
+20
File diff suppressed because one or more lines are too long
+16
@@ -0,0 +1,16 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/steps/createShippingMethodAdjustmentsStep
|
||||
sidebar_label: createShippingMethodAdjustmentsStep
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# createShippingMethodAdjustmentsStep - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `createShippingMethodAdjustmentsStep`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This step creates shipping method adjustments for a cart.
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"CreateShippingMethodAdjustmentsStepInput","type":"[CreateShippingMethodAdjustmentsStepInput](../../../../interfaces/core_flows.CreateShippingMethodAdjustmentsStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"shippingMethodAdjustmentsToCreate","type":"[CreateShippingMethodAdjustmentDTO](../../../../../cart/interfaces/cart.CreateShippingMethodAdjustmentDTO/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"shipping_method_id","type":"`string`","description":"The associated shipping method's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"The code of the promotion that lead to\nthis adjustment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberInput](../../../../../cart/types/cart.BigNumberInput/page.mdx)","description":"The amount to adjust the original amount with.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../../../cart/types/cart.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"description","type":"`string`","description":"The description of the shipping method adjustment.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"promotion_id","type":"`string`","description":"The associated promotion's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"The associated provider's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createShippingMethodAdjustmentsStep"/>
|
||||
+20
@@ -0,0 +1,20 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/steps/findOneOrAnyRegionStep
|
||||
sidebar_label: findOneOrAnyRegionStep
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# findOneOrAnyRegionStep - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `findOneOrAnyRegionStep`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This step retrieves a region either by the provided ID or the first region in the first store.
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"regionId","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="findOneOrAnyRegionStep"/>
|
||||
|
||||
## Output
|
||||
|
||||
<TypeList types={[{"name":"RegionDTO","type":"[RegionDTO](../../../../../region/interfaces/region.RegionDTO/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency code of the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"automatic_taxes","type":"`boolean`","description":"Setting to indicate whether taxes need to be applied automatically","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"countries","type":"[RegionCountryDTO](../../../../../region/interfaces/region.RegionCountryDTO/page.mdx)[]","description":"The countries of the region.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the country.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"iso_2","type":"`string`","description":"The ISO 2 code of the country.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"iso_3","type":"`string`","description":"The ISO 3 code of the country.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"num_code","type":"`string`","description":"The country's code number.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the country.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_name","type":"`string`","description":"The display name of the country.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"payment_providers","type":"[PaymentProviderDTO](../../../../../region/interfaces/region.PaymentProviderDTO/page.mdx)[]","description":"Payment providers available in the region","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the payment provider.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_enabled","type":"`string`","description":"Whether the payment provider is enabled.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"created_at","type":"`string`","description":"The date the region was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"The date the region was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, any>`","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="findOneOrAnyRegionStep"/>
|
||||
+21
File diff suppressed because one or more lines are too long
+21
@@ -0,0 +1,21 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/steps/findSalesChannelStep
|
||||
sidebar_label: findSalesChannelStep
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# findSalesChannelStep - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `findSalesChannelStep`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This step either retrieves a sales channel either using the ID provided as an input, or, if no ID
|
||||
is provided, the default sales channel of the first store.
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"FindSalesChannelStepInput","type":"[FindSalesChannelStepInput](../../../../interfaces/core_flows.FindSalesChannelStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"salesChannelId","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="findSalesChannelStep"/>
|
||||
|
||||
## Output
|
||||
|
||||
<TypeList types={[{"name":"SalesChannelDTO","type":"[SalesChannelDTO](../../../../../sales_channel/interfaces/sales_channel.SalesChannelDTO/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the sales channel.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the sales channel.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The description of the sales channel.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_disabled","type":"`boolean`","description":"Whether the sales channel is disabled.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"locations","type":"[SalesChannelLocationDTO](../../../../../sales_channel/interfaces/sales_channel.SalesChannelLocationDTO/page.mdx)[]","description":"The locations of the sales channel.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"sales_channel_id","type":"`string`","description":"The associated sales channel's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string`","description":"The associated location's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel","type":"[SalesChannelDTO](../../../../../sales_channel/interfaces/sales_channel.SalesChannelDTO/page.mdx)","description":"The associated sales channel.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the sales channel.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the sales channel.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The description of the sales channel.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_disabled","type":"`boolean`","description":"Whether the sales channel is disabled.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"locations","type":"[SalesChannelLocationDTO](../../../../../sales_channel/interfaces/sales_channel.SalesChannelLocationDTO/page.mdx)[]","description":"The locations of the sales channel.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="findSalesChannelStep"/>
|
||||
+21
File diff suppressed because one or more lines are too long
+20
File diff suppressed because one or more lines are too long
+21
File diff suppressed because one or more lines are too long
+20
@@ -0,0 +1,20 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/steps/getPromotionCodesToApply
|
||||
sidebar_label: getPromotionCodesToApply
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# getPromotionCodesToApply - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `getPromotionCodesToApply`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This step retrieves the promotion codes to apply on a cart.
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"GetPromotionCodesToApplyStepInput","type":"[GetPromotionCodesToApplyStepInput](../../../../interfaces/core_flows.GetPromotionCodesToApplyStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"cart","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"items","type":"`object`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"adjustments","type":"`object`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"shipping_methods","type":"`object`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"adjustments","type":"`object`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"promo_codes","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"action","type":"[ADD](../../../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionActions/page.mdx#add) \\| [REMOVE](../../../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionActions/page.mdx#remove) \\| [REPLACE](../../../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionActions/page.mdx#replace)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="getPromotionCodesToApply"/>
|
||||
|
||||
## Output
|
||||
|
||||
<TypeList types={[{"name":"string[]","type":"`string`[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="getPromotionCodesToApply"/>
|
||||
+16
@@ -0,0 +1,16 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/steps/getVariantPriceSetsStep
|
||||
sidebar_label: getVariantPriceSetsStep
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# getVariantPriceSetsStep - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `getVariantPriceSetsStep`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This step retrieves the calculated price sets of the specified variants.
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"GetVariantPriceSetsStepInput","type":"[GetVariantPriceSetsStepInput](../../../../interfaces/core_flows.GetVariantPriceSetsStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"variantIds","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="getVariantPriceSetsStep"/>
|
||||
+20
File diff suppressed because one or more lines are too long
+21
@@ -0,0 +1,21 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/steps/prepareAdjustmentsFromPromotionActionsStep
|
||||
sidebar_label: prepareAdjustmentsFromPromotionActionsStep
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# prepareAdjustmentsFromPromotionActionsStep - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `prepareAdjustmentsFromPromotionActionsStep`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This step prepares the line item or shipping method adjustments using
|
||||
actions computed by the Promotion Module.
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"PrepareAdjustmentsFromPromotionActionsStepInput","type":"[PrepareAdjustmentsFromPromotionActionsStepInput](../../../../interfaces/core_flows.PrepareAdjustmentsFromPromotionActionsStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"actions","type":"[ComputeActions](../../../../../promotion/types/promotion.ComputeActions/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"action","type":"`\"addItemAdjustment\"`","description":"The type of action.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"The associated item's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberInput](../../../../../promotion/types/promotion.BigNumberInput/page.mdx)","description":"The amount to remove off the item's total.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../../../promotion/types/promotion.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"code","type":"`string`","description":"The promotion's code.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"action","type":"`\"removeItemAdjustment\"`","description":"The type of action.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"adjustment_id","type":"`string`","description":"The associated adjustment's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"The promotion's code.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"action","type":"`\"addShippingMethodAdjustment\"`","description":"The type of action.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_method_id","type":"`string`","description":"The associated shipping method's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberInput](../../../../../promotion/types/promotion.BigNumberInput/page.mdx)","description":"The amount to remove off the shipping method's total.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../../../promotion/types/promotion.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"code","type":"`string`","description":"The promotion's code.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"action","type":"`\"removeShippingMethodAdjustment\"`","description":"The type of action","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"adjustment_id","type":"`string`","description":"The associated adjustment's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"The promotion's code.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"action","type":"`\"campaignBudgetExceeded\"`","description":"The type of action.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"The promotion's code.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The promotion's description.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The promotion's description.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The promotion's description.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="prepareAdjustmentsFromPromotionActionsStep"/>
|
||||
|
||||
## Output
|
||||
|
||||
<TypeList types={[{"name":"WorkflowDataProperties","type":"[WorkflowDataProperties](../../../../../workflows/types/workflows.WorkflowDataProperties/page.mdx)<object>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"lineItemAdjustmentsToCreate","type":"`object`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"code","type":"`string`","description":"","optional":false,"defaultValue":"action.code","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberInput](../../../../../types/types/types.BigNumberInput/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"promotion_id","type":"`undefined` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"lineItemAdjustmentIdsToRemove","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shippingMethodAdjustmentsToCreate","type":"`object`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"code","type":"`string`","description":"","optional":false,"defaultValue":"action.code","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberInput](../../../../../types/types/types.BigNumberInput/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_method_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"promotion_id","type":"`undefined` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"shippingMethodAdjustmentIdsToRemove","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"computedPromotionCodes","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="prepareAdjustmentsFromPromotionActionsStep"/>
|
||||
+16
File diff suppressed because one or more lines are too long
+16
@@ -0,0 +1,16 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/steps/removeLineItemAdjustmentsStep
|
||||
sidebar_label: removeLineItemAdjustmentsStep
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# removeLineItemAdjustmentsStep - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `removeLineItemAdjustmentsStep`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This step removes line item adjustments from a cart.
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"RemoveLineItemAdjustmentsStepInput","type":"[RemoveLineItemAdjustmentsStepInput](../../../../interfaces/core_flows.RemoveLineItemAdjustmentsStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"lineItemAdjustmentIdsToRemove","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="removeLineItemAdjustmentsStep"/>
|
||||
+16
@@ -0,0 +1,16 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/steps/removeShippingMethodAdjustmentsStep
|
||||
sidebar_label: removeShippingMethodAdjustmentsStep
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# removeShippingMethodAdjustmentsStep - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `removeShippingMethodAdjustmentsStep`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This step removes shipping method adjustments from a cart.
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"RemoveShippingMethodAdjustmentsStepInput","type":"[RemoveShippingMethodAdjustmentsStepInput](../../../../interfaces/core_flows.RemoveShippingMethodAdjustmentsStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"shippingMethodAdjustmentIdsToRemove","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="removeShippingMethodAdjustmentsStep"/>
|
||||
+16
@@ -0,0 +1,16 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/steps/removeShippingMethodFromCartStep
|
||||
sidebar_label: removeShippingMethodFromCartStep
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# removeShippingMethodFromCartStep - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `removeShippingMethodFromCartStep`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This step removes shipping methods from a cart.
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"RemoveShippingMethodFromCartStepInput","type":"[RemoveShippingMethodFromCartStepInput](../../../../interfaces/core_flows.RemoveShippingMethodFromCartStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"shipping_method_ids","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="removeShippingMethodFromCartStep"/>
|
||||
+21
@@ -0,0 +1,21 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/steps/reserveInventoryStep
|
||||
sidebar_label: reserveInventoryStep
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# reserveInventoryStep - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `reserveInventoryStep`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This step reserves the quantity of line items from the associated
|
||||
variant's inventory.
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"ReserveVariantInventoryStepInput","type":"[ReserveVariantInventoryStepInput](../../../../interfaces/core_flows.ReserveVariantInventoryStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"items","type":"`object`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"inventory_item_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"required_quantity","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"allow_backorder","type":"`boolean`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"location_ids","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="reserveInventoryStep"/>
|
||||
|
||||
## Output
|
||||
|
||||
<TypeList types={[{"name":"ReservationItemDTO[]","type":"[ReservationItemDTO](../../../../../types/InventoryTypes/interfaces/types.InventoryTypes.ReservationItemDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"ReservationItemDTO","type":"[ReservationItemDTO](../../../../../types/InventoryTypes/interfaces/types.InventoryTypes.ReservationItemDTO/page.mdx)","optional":false,"defaultValue":"","description":"The reservation item details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the reservation item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string`","description":"The associated location's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"inventory_item_id","type":"`string`","description":"The associated inventory item's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"[BigNumberInput](../../../../../types/types/types.BigNumberInput/page.mdx)","description":"The quantity of the reservation item.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the reservation item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the reservation item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string` \\| `Date`","description":"The deletion date of the reservation item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"line_item_id","type":"`null` \\| `string`","description":"The associated line item's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The description of the reservation item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"allow_backorder","type":"`boolean`","description":"Allow backorder of the item. If true, it won't check inventory levels before reserving it.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"The created by of the reservation item.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="reserveInventoryStep"/>
|
||||
+20
File diff suppressed because one or more lines are too long
+16
@@ -0,0 +1,16 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/steps/retrieveCartWithLinksStep
|
||||
sidebar_label: retrieveCartWithLinksStep
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# retrieveCartWithLinksStep - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `retrieveCartWithLinksStep`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This step retrieves a cart's details with its linked records.
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"RetrieveCartWithLinksStepInput","type":"[RetrieveCartWithLinksStepInput](../../../../interfaces/core_flows.RetrieveCartWithLinksStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"cart_or_cart_id","type":"`string` \\| `CartWorkflowDTO`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fields","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="retrieveCartWithLinksStep"/>
|
||||
+16
@@ -0,0 +1,16 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/steps/setTaxLinesForItemsStep
|
||||
sidebar_label: setTaxLinesForItemsStep
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# setTaxLinesForItemsStep - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `setTaxLinesForItemsStep`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This step sets the tax lines of shipping methods and line items in a cart.
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"SetTaxLinesForItemsStepInput","type":"[SetTaxLinesForItemsStepInput](../../../../interfaces/core_flows.SetTaxLinesForItemsStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"cart","type":"`CartWorkflowDTO`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_lines","type":"[ItemTaxLineDTO](../../../../../tax/interfaces/tax.ItemTaxLineDTO/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"rate","type":"`number`","description":"The rate of the tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`null` \\| `string`","description":"The code of the tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"The ID of the tax provider used to calculate and retrieve the tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"line_item_id","type":"`string`","description":"The associated line item's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate_id","type":"`string`","description":"The associated rate's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"shipping_tax_lines","type":"[ShippingTaxLineDTO](../../../../../tax/interfaces/tax.ShippingTaxLineDTO/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"rate","type":"`number`","description":"The rate of the tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`null` \\| `string`","description":"The code of the tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"The ID of the tax provider used to calculate and retrieve the tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_line_id","type":"`string`","description":"The associated shipping line's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate_id","type":"`string`","description":"The associated rate's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="setTaxLinesForItemsStep"/>
|
||||
+16
@@ -0,0 +1,16 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/steps/updateCartPromotionsStep
|
||||
sidebar_label: updateCartPromotionsStep
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# updateCartPromotionsStep - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `updateCartPromotionsStep`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This step updates the promotions applied on a cart.
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"UpdateCartPromotionStepInput","type":"[UpdateCartPromotionStepInput](../../../../interfaces/core_flows.UpdateCartPromotionStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"promo_codes","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"action","type":"[ADD](../../../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionActions/page.mdx#add) \\| [REMOVE](../../../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionActions/page.mdx#remove) \\| [REPLACE](../../../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionActions/page.mdx#replace)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateCartPromotionsStep"/>
|
||||
+20
File diff suppressed because one or more lines are too long
+20
File diff suppressed because one or more lines are too long
+21
File diff suppressed because one or more lines are too long
+16
File diff suppressed because one or more lines are too long
+16
@@ -0,0 +1,16 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/steps/validateVariantPricesStep
|
||||
sidebar_label: validateVariantPricesStep
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# validateVariantPricesStep - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `validateVariantPricesStep`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This step validates the specified variant objects to ensure they have prices.
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"ValidateVariantPricesStepInput","type":"[ValidateVariantPricesStepInput](../../../../interfaces/core_flows.ValidateVariantPricesStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"variants","type":"`object`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"calculated_price","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"calculated_amount","type":"`null` \\| [BigNumberInput](../../../../../types/types/types.BigNumberInput/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="validateVariantPricesStep"/>
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# addShippingMethodToCartStepId
|
||||
|
||||
`Const` **addShippingMethodToCartStepId**: `"add-shipping-method-to-cart-step"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# confirmInventoryStepId
|
||||
|
||||
`Const` **confirmInventoryStepId**: `"confirm-inventory-step"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# createCartsStepId
|
||||
|
||||
`Const` **createCartsStepId**: `"create-carts"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# createLineItemAdjustmentsStepId
|
||||
|
||||
`Const` **createLineItemAdjustmentsStepId**: `"create-line-item-adjustments"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# createLineItemsStepId
|
||||
|
||||
`Const` **createLineItemsStepId**: `"create-line-items-step"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# createPaymentCollectionsStepId
|
||||
|
||||
`Const` **createPaymentCollectionsStepId**: `"create-payment-collections"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# createShippingMethodAdjustmentsStepId
|
||||
|
||||
`Const` **createShippingMethodAdjustmentsStepId**: `"create-shipping-method-adjustments"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# findOneOrAnyRegionStepId
|
||||
|
||||
`Const` **findOneOrAnyRegionStepId**: `"find-one-or-any-region"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# findOrCreateCustomerStepId
|
||||
|
||||
`Const` **findOrCreateCustomerStepId**: `"find-or-create-customer"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# findSalesChannelStepId
|
||||
|
||||
`Const` **findSalesChannelStepId**: `"find-sales-channel"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# getActionsToComputeFromPromotionsStepId
|
||||
|
||||
`Const` **getActionsToComputeFromPromotionsStepId**: `"get-actions-to-compute-from-promotions"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# getItemTaxLinesStepId
|
||||
|
||||
`Const` **getItemTaxLinesStepId**: `"get-item-tax-lines"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# getLineItemActionsStepId
|
||||
|
||||
`Const` **getLineItemActionsStepId**: `"get-line-item-actions-step"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# getPromotionCodesToApplyId
|
||||
|
||||
`Const` **getPromotionCodesToApplyId**: `"get-promotion-codes-to-apply"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# getVariantPriceSetsStepId
|
||||
|
||||
`Const` **getVariantPriceSetsStepId**: `"get-variant-price-sets"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# getVariantsStepId
|
||||
|
||||
`Const` **getVariantsStepId**: `"get-variants"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# prepareAdjustmentsFromPromotionActionsStepId
|
||||
|
||||
`Const` **prepareAdjustmentsFromPromotionActionsStepId**: `"prepare-adjustments-from-promotion-actions"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# refreshCartShippingMethodsStepId
|
||||
|
||||
`Const` **refreshCartShippingMethodsStepId**: `"refresh-cart-shipping-methods"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# removeLineItemAdjustmentsStepId
|
||||
|
||||
`Const` **removeLineItemAdjustmentsStepId**: `"remove-line-item-adjustments"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# removeShippingMethodAdjustmentsStepId
|
||||
|
||||
`Const` **removeShippingMethodAdjustmentsStepId**: `"remove-shipping-method-adjustments"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# removeShippingMethodFromCartStepId
|
||||
|
||||
`Const` **removeShippingMethodFromCartStepId**: `"remove-shipping-method-to-cart-step"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# reserveInventoryStepId
|
||||
|
||||
`Const` **reserveInventoryStepId**: `"reserve-inventory-step"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# retrieveCartStepId
|
||||
|
||||
`Const` **retrieveCartStepId**: `"retrieve-cart"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# retrieveCartWithLinksStepId
|
||||
|
||||
`Const` **retrieveCartWithLinksStepId**: `"retrieve-cart-with-links"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# setTaxLinesForItemsStepId
|
||||
|
||||
`Const` **setTaxLinesForItemsStepId**: `"set-tax-lines-for-items"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# updateCartPromotionsStepId
|
||||
|
||||
`Const` **updateCartPromotionsStepId**: `"update-cart-promotions"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# updateCartsStepId
|
||||
|
||||
`Const` **updateCartsStepId**: `"update-carts"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# updateLineItemsStepId
|
||||
|
||||
`Const` **updateLineItemsStepId**: `"update-line-items-step"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# validateCartPaymentsStepId
|
||||
|
||||
`Const` **validateCartPaymentsStepId**: `"validate-cart-payments"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# validateCartShippingOptionsStepId
|
||||
|
||||
`Const` **validateCartShippingOptionsStepId**: `"validate-cart-shipping-options"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# validateVariantPricesStepId
|
||||
|
||||
`Const` **validateVariantPricesStepId**: `"validate-variant-prices"`
|
||||
File diff suppressed because one or more lines are too long
@@ -0,0 +1,8 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# Cart
|
||||
|
||||
## Namespaces
|
||||
|
||||
- [Steps\_Cart](../core_flows.Steps_Cart/page.mdx)
|
||||
- [Workflows\_Cart](../core_flows.Workflows_Cart/page.mdx)
|
||||
Reference in New Issue
Block a user