chore(docs): Generated References (#8583)

Generated the following references:
- `core_flows`
- `modules`
- `order`
- `types`

Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
github-actions[bot]andShahed Nasser authored and GitHub committed 2024-08-13 13:58:28 +00:00
1 parent 01c8e4d3c1
commit c820741df9
557 files changed
+407760 -382787

No files matched your search

@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/steps/createApiKeysStep
sidebar_label: createApiKeysStep
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# createApiKeysStep
# createApiKeysStep - Medusa Workflows API Reference
This documentation provides a reference to the `createApiKeysStep`. It belongs to the `@medusajs/core-flows` package.
This step creates one or more API keys.
@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/createApiKeysWorkflow
sidebar_label: createApiKeysWorkflow
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# createApiKeysWorkflow
# createApiKeysWorkflow - Medusa Workflows API Reference
This documentation provides a reference to the `createApiKeysWorkflow`. It belongs to the `@medusajs/core-flows` package.
This workflow creates one or more API keys.
@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/steps/deleteApiKeysStep
sidebar_label: deleteApiKeysStep
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# deleteApiKeysStep
# deleteApiKeysStep - Medusa Workflows API Reference
This documentation provides a reference to the `deleteApiKeysStep`. It belongs to the `@medusajs/core-flows` package.
This step deletes one or more API keys.
@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/deleteApiKeysWorkflow
sidebar_label: deleteApiKeysWorkflow
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# deleteApiKeysWorkflow
# deleteApiKeysWorkflow - Medusa Workflows API Reference
This documentation provides a reference to the `deleteApiKeysWorkflow`. It belongs to the `@medusajs/core-flows` package.
This workflow deletes one or more API keys.
@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/steps/linkSalesChannelsToApiKeyStep
sidebar_label: linkSalesChannelsToApiKeyStep
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# linkSalesChannelsToApiKeyStep
# linkSalesChannelsToApiKeyStep - Medusa Workflows API Reference
This documentation provides a reference to the `linkSalesChannelsToApiKeyStep`. It belongs to the `@medusajs/core-flows` package.
This step links sales channels to API keys.
@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/linkSalesChannelsToApiKeyWorkflow
sidebar_label: linkSalesChannelsToApiKeyWorkflow
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# linkSalesChannelsToApiKeyWorkflow
# linkSalesChannelsToApiKeyWorkflow - Medusa Workflows API Reference
This documentation provides a reference to the `linkSalesChannelsToApiKeyWorkflow`. It belongs to the `@medusajs/core-flows` package.
This workflow links sales channels to API keys.
@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/steps/revokeApiKeysStep
sidebar_label: revokeApiKeysStep
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# revokeApiKeysStep
# revokeApiKeysStep - Medusa Workflows API Reference
This documentation provides a reference to the `revokeApiKeysStep`. It belongs to the `@medusajs/core-flows` package.
This step revokes one or more API keys.
@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/revokeApiKeysWorkflow
sidebar_label: revokeApiKeysWorkflow
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# revokeApiKeysWorkflow
# revokeApiKeysWorkflow - Medusa Workflows API Reference
This documentation provides a reference to the `revokeApiKeysWorkflow`. It belongs to the `@medusajs/core-flows` package.
This workflow revokes one or more API keys.
@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/steps/updateApiKeysStep
sidebar_label: updateApiKeysStep
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# updateApiKeysStep
# updateApiKeysStep - Medusa Workflows API Reference
This documentation provides a reference to the `updateApiKeysStep`. It belongs to the `@medusajs/core-flows` package.
This step updates one or more API keys.
@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/updateApiKeysWorkflow
sidebar_label: updateApiKeysWorkflow
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# updateApiKeysWorkflow
# updateApiKeysWorkflow - Medusa Workflows API Reference
This documentation provides a reference to the `updateApiKeysWorkflow`. It belongs to the `@medusajs/core-flows` package.
This workflow creates one or more API keys.
@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/steps/validateSalesChannelsExistStep
sidebar_label: validateSalesChannelsExistStep
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# validateSalesChannelsExistStep
# validateSalesChannelsExistStep - Medusa Workflows API Reference
This documentation provides a reference to the `validateSalesChannelsExistStep`. It belongs to the `@medusajs/core-flows` package.
This step validates that a sales channel exists before linking it to an API key.
@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/steps/setAuthAppMetadataStep
sidebar_label: setAuthAppMetadataStep
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# setAuthAppMetadataStep
# setAuthAppMetadataStep - Medusa Workflows API Reference
This documentation provides a reference to the `setAuthAppMetadataStep`. It belongs to the `@medusajs/core-flows` package.
This step sets the `app_metadata` property of an auth identity.
@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/batchLinksWorkflow
sidebar_label: batchLinksWorkflow
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# batchLinksWorkflow
# batchLinksWorkflow - Medusa Workflows API Reference
This documentation provides a reference to the `batchLinksWorkflow`. It belongs to the `@medusajs/core-flows` package.
This workflow manages one or more links to create, update, or dismiss them.
@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/createLinksWorkflow
sidebar_label: createLinksWorkflow
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# createLinksWorkflow
# createLinksWorkflow - Medusa Workflows API Reference
This documentation provides a reference to the `createLinksWorkflow`. It belongs to the `@medusajs/core-flows` package.
This workflow creates one or more links between records.
@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/steps/createRemoteLinkStep
sidebar_label: createRemoteLinkStep
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# createRemoteLinkStep
# createRemoteLinkStep - Medusa Workflows API Reference
This documentation provides a reference to the `createRemoteLinkStep`. It belongs to the `@medusajs/core-flows` package.
This step creates remote links between two records of linked data models.
@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/dismissLinksWorkflow
sidebar_label: dismissLinksWorkflow
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# dismissLinksWorkflow
# dismissLinksWorkflow - Medusa Workflows API Reference
This documentation provides a reference to the `dismissLinksWorkflow`. It belongs to the `@medusajs/core-flows` package.
This workflow dismisses one or more links between records.
@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/steps/dismissRemoteLinkStep
sidebar_label: dismissRemoteLinkStep
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# dismissRemoteLinkStep
# dismissRemoteLinkStep - Medusa Workflows API Reference
This documentation provides a reference to the `dismissRemoteLinkStep`. It belongs to the `@medusajs/core-flows` package.
This step removes remote links between two records of linked data models.
@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/steps/emitEventStep
sidebar_label: emitEventStep
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# emitEventStep
# emitEventStep - Medusa Workflows API Reference
This documentation provides a reference to the `emitEventStep`. It belongs to the `@medusajs/core-flows` package.
Emit an event.
@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/steps/removeRemoteLinkStep
sidebar_label: removeRemoteLinkStep
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# removeRemoteLinkStep
# removeRemoteLinkStep - Medusa Workflows API Reference
This documentation provides a reference to the `removeRemoteLinkStep`. It belongs to the `@medusajs/core-flows` package.
This step deletes linked records of a record.
@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/updateLinksWorkflow
sidebar_label: updateLinksWorkflow
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# updateLinksWorkflow
# updateLinksWorkflow - Medusa Workflows API Reference
This documentation provides a reference to the `updateLinksWorkflow`. It belongs to the `@medusajs/core-flows` package.
This workflow updates one or more links between records.
@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/steps/updateRemoteLinksStep
sidebar_label: updateRemoteLinksStep
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# updateRemoteLinksStep
# updateRemoteLinksStep - Medusa Workflows API Reference
This documentation provides a reference to the `updateRemoteLinksStep`. It belongs to the `@medusajs/core-flows` package.
## Input
@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/steps/useRemoteQueryStep
sidebar_label: useRemoteQueryStep
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# useRemoteQueryStep
# useRemoteQueryStep - Medusa Workflows API Reference
This documentation provides a reference to the `useRemoteQueryStep`. It belongs to the `@medusajs/core-flows` package.
This step fetches data across modules using the remote query.
@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/createCustomerAccountWorkflow
sidebar_label: createCustomerAccountWorkflow
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# createCustomerAccountWorkflow
# createCustomerAccountWorkflow - Medusa Workflows API Reference
This documentation provides a reference to the `createCustomerAccountWorkflow`. It belongs to the `@medusajs/core-flows` package.
This workflow creates an authentication account for a customer.
@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/steps/createCustomerAddressesStep
sidebar_label: createCustomerAddressesStep
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# createCustomerAddressesStep
# createCustomerAddressesStep - Medusa Workflows API Reference
This documentation provides a reference to the `createCustomerAddressesStep`. It belongs to the `@medusajs/core-flows` package.
This step creates one or more customer addresses.
@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/createCustomerAddressesWorkflow
sidebar_label: createCustomerAddressesWorkflow
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# createCustomerAddressesWorkflow
# createCustomerAddressesWorkflow - Medusa Workflows API Reference
This documentation provides a reference to the `createCustomerAddressesWorkflow`. It belongs to the `@medusajs/core-flows` package.
This workflow creates one or more customer address.
@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/steps/createCustomersStep
sidebar_label: createCustomersStep
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# createCustomersStep
# createCustomersStep - Medusa Workflows API Reference
This documentation provides a reference to the `createCustomersStep`. It belongs to the `@medusajs/core-flows` package.
This step creates one or more customers.
@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/createCustomersWorkflow
sidebar_label: createCustomersWorkflow
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# createCustomersWorkflow
# createCustomersWorkflow - Medusa Workflows API Reference
This documentation provides a reference to the `createCustomersWorkflow`. It belongs to the `@medusajs/core-flows` package.
This workflow creates one or more customers.
@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/steps/deleteCustomerAddressesStep
sidebar_label: deleteCustomerAddressesStep
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# deleteCustomerAddressesStep
# deleteCustomerAddressesStep - Medusa Workflows API Reference
This documentation provides a reference to the `deleteCustomerAddressesStep`. It belongs to the `@medusajs/core-flows` package.
This step deletes one or more customer addresses.
@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/deleteCustomerAddressesWorkflow
sidebar_label: deleteCustomerAddressesWorkflow
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# deleteCustomerAddressesWorkflow
# deleteCustomerAddressesWorkflow - Medusa Workflows API Reference
This documentation provides a reference to the `deleteCustomerAddressesWorkflow`. It belongs to the `@medusajs/core-flows` package.
This workflow deletes one or more customer addresses.
@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/steps/deleteCustomersStep
sidebar_label: deleteCustomersStep
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# deleteCustomersStep
# deleteCustomersStep - Medusa Workflows API Reference
This documentation provides a reference to the `deleteCustomersStep`. It belongs to the `@medusajs/core-flows` package.
This step deletes one or more customers.
@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/deleteCustomersWorkflow
sidebar_label: deleteCustomersWorkflow
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# deleteCustomersWorkflow
# deleteCustomersWorkflow - Medusa Workflows API Reference
This documentation provides a reference to the `deleteCustomersWorkflow`. It belongs to the `@medusajs/core-flows` package.
This workflow deletes one or more customers.
@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/steps/maybeUnsetDefaultBillingAddressesStep
sidebar_label: maybeUnsetDefaultBillingAddressesStep
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# maybeUnsetDefaultBillingAddressesStep
# maybeUnsetDefaultBillingAddressesStep - Medusa Workflows API Reference
This documentation provides a reference to the `maybeUnsetDefaultBillingAddressesStep`. It belongs to the `@medusajs/core-flows` package.
This step unsets the `is_default_billing` property of one or more addresses.
@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/steps/maybeUnsetDefaultShippingAddressesStep
sidebar_label: maybeUnsetDefaultShippingAddressesStep
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# maybeUnsetDefaultShippingAddressesStep
# maybeUnsetDefaultShippingAddressesStep - Medusa Workflows API Reference
This documentation provides a reference to the `maybeUnsetDefaultShippingAddressesStep`. It belongs to the `@medusajs/core-flows` package.
This step unsets the `is_default_shipping` property of one or more addresses.
@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/steps/updateCustomerAddressesStep
sidebar_label: updateCustomerAddressesStep
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# updateCustomerAddressesStep
# updateCustomerAddressesStep - Medusa Workflows API Reference
This documentation provides a reference to the `updateCustomerAddressesStep`. It belongs to the `@medusajs/core-flows` package.
This step updates one or more customer addresses.
@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/updateCustomerAddressesWorkflow
sidebar_label: updateCustomerAddressesWorkflow
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# updateCustomerAddressesWorkflow
# updateCustomerAddressesWorkflow - Medusa Workflows API Reference
This documentation provides a reference to the `updateCustomerAddressesWorkflow`. It belongs to the `@medusajs/core-flows` package.
This workflow updates one or more customer addresses.
@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/steps/updateCustomersStep
sidebar_label: updateCustomersStep
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# updateCustomersStep
# updateCustomersStep - Medusa Workflows API Reference
This documentation provides a reference to the `updateCustomersStep`. It belongs to the `@medusajs/core-flows` package.
This step updates one or more customers.
@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/updateCustomersWorkflow
sidebar_label: updateCustomersWorkflow
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# updateCustomersWorkflow
# updateCustomersWorkflow - Medusa Workflows API Reference
This documentation provides a reference to the `updateCustomersWorkflow`. It belongs to the `@medusajs/core-flows` package.
This workflow updates one or more customers.
@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/steps/createCustomerGroupsStep
sidebar_label: createCustomerGroupsStep
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# createCustomerGroupsStep
# createCustomerGroupsStep - Medusa Workflows API Reference
This documentation provides a reference to the `createCustomerGroupsStep`. It belongs to the `@medusajs/core-flows` package.
This step creates one or more customer groups.
@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/createCustomerGroupsWorkflow
sidebar_label: createCustomerGroupsWorkflow
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# createCustomerGroupsWorkflow
# createCustomerGroupsWorkflow - Medusa Workflows API Reference
This documentation provides a reference to the `createCustomerGroupsWorkflow`. It belongs to the `@medusajs/core-flows` package.
This workflow creates one or more customer groups.
@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/steps/deleteCustomerGroupStep
sidebar_label: deleteCustomerGroupStep
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# deleteCustomerGroupStep
# deleteCustomerGroupStep - Medusa Workflows API Reference
This documentation provides a reference to the `deleteCustomerGroupStep`. It belongs to the `@medusajs/core-flows` package.
This step deletes one or more customer groups.
@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/deleteCustomerGroupsWorkflow
sidebar_label: deleteCustomerGroupsWorkflow
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# deleteCustomerGroupsWorkflow
# deleteCustomerGroupsWorkflow - Medusa Workflows API Reference
This documentation provides a reference to the `deleteCustomerGroupsWorkflow`. It belongs to the `@medusajs/core-flows` package.
This workflow deletes one or more customer groups.
@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/steps/linkCustomersToCustomerGroupStep
sidebar_label: linkCustomersToCustomerGroupStep
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# linkCustomersToCustomerGroupStep
# linkCustomersToCustomerGroupStep - Medusa Workflows API Reference
This documentation provides a reference to the `linkCustomersToCustomerGroupStep`. It belongs to the `@medusajs/core-flows` package.
This step creates one or more links between customer and customer group records.
@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/linkCustomersToCustomerGroupWorkflow
sidebar_label: linkCustomersToCustomerGroupWorkflow
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# linkCustomersToCustomerGroupWorkflow
# linkCustomersToCustomerGroupWorkflow - Medusa Workflows API Reference
This documentation provides a reference to the `linkCustomersToCustomerGroupWorkflow`. It belongs to the `@medusajs/core-flows` package.
This workflow creates one or more links between customer and customer group records.
@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/steps/updateCustomerGroupsStep
sidebar_label: updateCustomerGroupsStep
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# updateCustomerGroupsStep
# updateCustomerGroupsStep - Medusa Workflows API Reference
This documentation provides a reference to the `updateCustomerGroupsStep`. It belongs to the `@medusajs/core-flows` package.
This step updates one or more customer groups.
@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/updateCustomerGroupsWorkflow
sidebar_label: updateCustomerGroupsWorkflow
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# updateCustomerGroupsWorkflow
# updateCustomerGroupsWorkflow - Medusa Workflows API Reference
This documentation provides a reference to the `updateCustomerGroupsWorkflow`. It belongs to the `@medusajs/core-flows` package.
This workflow updates one or more customer groups.
@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/steps/createDefaultStoreStep
sidebar_label: createDefaultStoreStep
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# createDefaultStoreStep
# createDefaultStoreStep - Medusa Workflows API Reference
This documentation provides a reference to the `createDefaultStoreStep`. It belongs to the `@medusajs/core-flows` package.
This step creates a default store.
@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/createDefaultsWorkflow
sidebar_label: createDefaultsWorkflow
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# createDefaultsWorkflow
# createDefaultsWorkflow - Medusa Workflows API Reference
This documentation provides a reference to the `createDefaultsWorkflow`. It belongs to the `@medusajs/core-flows` package.
This workflow creates default data for a Medusa application.
@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/steps/addShippingMethodToCartStep
sidebar_label: addShippingMethodToCartStep
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# addShippingMethodToCartStep
# addShippingMethodToCartStep - Medusa Workflows API Reference
This documentation provides a reference to the `addShippingMethodToCartStep`. It belongs to the `@medusajs/core-flows` package.
This step adds shipping methods to a cart.
@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/addShippingMethodToWorkflow
sidebar_label: addShippingMethodToWorkflow
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# addShippingMethodToWorkflow
# addShippingMethodToWorkflow - Medusa Workflows API Reference
This documentation provides a reference to the `addShippingMethodToWorkflow`. It belongs to the `@medusajs/core-flows` package.
This workflow adds shipping methods to a cart.
@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/addToCartWorkflow
sidebar_label: addToCartWorkflow
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# addToCartWorkflow
# addToCartWorkflow - Medusa Workflows API Reference
This documentation provides a reference to the `addToCartWorkflow`. It belongs to the `@medusajs/core-flows` package.
This workflow adds items to a cart.
@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/completeCartWorkflow
sidebar_label: completeCartWorkflow
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# completeCartWorkflow
# completeCartWorkflow - Medusa Workflows API Reference
This documentation provides a reference to the `completeCartWorkflow`. It belongs to the `@medusajs/core-flows` package.
This workflow completes a cart.
@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/steps/confirmInventoryStep
sidebar_label: confirmInventoryStep
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# confirmInventoryStep
# 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.
@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/confirmVariantInventoryWorkflow
sidebar_label: confirmVariantInventoryWorkflow
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# confirmVariantInventoryWorkflow
# confirmVariantInventoryWorkflow - Medusa Workflows API Reference
This documentation provides a reference to the `confirmVariantInventoryWorkflow`. It belongs to the `@medusajs/core-flows` package.
This workflow confirms for one or more variants that their inventory has a required quantity.
@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/createCartWorkflow
sidebar_label: createCartWorkflow
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# createCartWorkflow
# createCartWorkflow - Medusa Workflows API Reference
This documentation provides a reference to the `createCartWorkflow`. It belongs to the `@medusajs/core-flows` package.
This workflow creates a cart.
@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/steps/createCartsStep
sidebar_label: createCartsStep
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# createCartsStep
# createCartsStep - Medusa Workflows API Reference
This documentation provides a reference to the `createCartsStep`. It belongs to the `@medusajs/core-flows` package.
This step creates a cart.
@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/steps/createLineItemAdjustmentsStep
sidebar_label: createLineItemAdjustmentsStep
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# createLineItemAdjustmentsStep
# 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.
@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/steps/createLineItemsStep
sidebar_label: createLineItemsStep
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# createLineItemsStep
# createLineItemsStep - Medusa Workflows API Reference
This documentation provides a reference to the `createLineItemsStep`. It belongs to the `@medusajs/core-flows` package.
This step creates line item in a cart.
@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/createPaymentCollectionForCartWorkflow
sidebar_label: createPaymentCollectionForCartWorkflow
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# createPaymentCollectionForCartWorkflow
# createPaymentCollectionForCartWorkflow - Medusa Workflows API Reference
This documentation provides a reference to the `createPaymentCollectionForCartWorkflow`. It belongs to the `@medusajs/core-flows` package.
This workflow creates a payment collection for a cart.
@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/steps/createPaymentCollectionsStep
sidebar_label: createPaymentCollectionsStep
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# createPaymentCollectionsStep
# createPaymentCollectionsStep - Medusa Workflows API Reference
This documentation provides a reference to the `createPaymentCollectionsStep`. It belongs to the `@medusajs/core-flows` package.
This step creates payment collections in a cart.
@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/steps/createShippingMethodAdjustmentsStep
sidebar_label: createShippingMethodAdjustmentsStep
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# createShippingMethodAdjustmentsStep
# 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.
@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/steps/deleteLineItemsStep
sidebar_label: deleteLineItemsStep
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# deleteLineItemsStep
# deleteLineItemsStep - Medusa Workflows API Reference
This documentation provides a reference to the `deleteLineItemsStep`. It belongs to the `@medusajs/core-flows` package.
This step deletes line items.
@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/deleteLineItemsWorkflow
sidebar_label: deleteLineItemsWorkflow
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# deleteLineItemsWorkflow
# deleteLineItemsWorkflow - Medusa Workflows API Reference
This documentation provides a reference to the `deleteLineItemsWorkflow`. It belongs to the `@medusajs/core-flows` package.
This workflow deletes line items from a cart.
@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/steps/findOneOrAnyRegionStep
sidebar_label: findOneOrAnyRegionStep
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# findOneOrAnyRegionStep
# 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.
@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/steps/findOrCreateCustomerStep
sidebar_label: findOrCreateCustomerStep
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# findOrCreateCustomerStep
# findOrCreateCustomerStep - Medusa Workflows API Reference
This documentation provides a reference to the `findOrCreateCustomerStep`. It belongs to the `@medusajs/core-flows` package.
This step either finds a customer matching the specified ID, or finds / create a customer
matching the specified email. If both ID and email are provided, ID takes precedence.
@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/steps/findSalesChannelStep
sidebar_label: findSalesChannelStep
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# findSalesChannelStep
# 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.
@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/steps/getActionsToComputeFromPromotionsStep
sidebar_label: getActionsToComputeFromPromotionsStep
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# getActionsToComputeFromPromotionsStep
# getActionsToComputeFromPromotionsStep - Medusa Workflows API Reference
This documentation provides a reference to the `getActionsToComputeFromPromotionsStep`. It belongs to the `@medusajs/core-flows` package.
This step retrieves the actions to compute based on the promotions
applied on a cart.
@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/steps/getItemTaxLinesStep
sidebar_label: getItemTaxLinesStep
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# getItemTaxLinesStep
# getItemTaxLinesStep - Medusa Workflows API Reference
This documentation provides a reference to the `getItemTaxLinesStep`. It belongs to the `@medusajs/core-flows` package.
This step retrieves the tax lines of the specified line items in a cart.
@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/steps/getLineItemActionsStep
sidebar_label: getLineItemActionsStep
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# getLineItemActionsStep
# getLineItemActionsStep - Medusa Workflows API Reference
This documentation provides a reference to the `getLineItemActionsStep`. It belongs to the `@medusajs/core-flows` package.
This step returns lists of cart line items to create or update based on the
provided input.
@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/steps/getVariantPriceSetsStep
sidebar_label: getVariantPriceSetsStep
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# getVariantPriceSetsStep
# 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.
@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/steps/getVariantsStep
sidebar_label: getVariantsStep
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# getVariantsStep
# getVariantsStep - Medusa Workflows API Reference
This documentation provides a reference to the `getVariantsStep`. It belongs to the `@medusajs/core-flows` package.
This step retrieves variants matching the specified filters.
@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/steps/listLineItemsStep
sidebar_label: listLineItemsStep
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# listLineItemsStep
# listLineItemsStep - Medusa Workflows API Reference
This documentation provides a reference to the `listLineItemsStep`. It belongs to the `@medusajs/core-flows` package.
This step retrieves a list of a cart's line items
matching the specified filters.
@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/listShippingOptionsForCartWorkflow
sidebar_label: listShippingOptionsForCartWorkflow
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# listShippingOptionsForCartWorkflow
# listShippingOptionsForCartWorkflow - Medusa Workflows API Reference
This documentation provides a reference to the `listShippingOptionsForCartWorkflow`. It belongs to the `@medusajs/core-flows` package.
This workflow lists the shipping options of a cart.
@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/steps/prepareAdjustmentsFromPromotionActionsStep
sidebar_label: prepareAdjustmentsFromPromotionActionsStep
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# prepareAdjustmentsFromPromotionActionsStep
# 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.
@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/steps/refreshCartShippingMethodsStep
sidebar_label: refreshCartShippingMethodsStep
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# refreshCartShippingMethodsStep
# refreshCartShippingMethodsStep - Medusa Workflows API Reference
This documentation provides a reference to the `refreshCartShippingMethodsStep`. It belongs to the `@medusajs/core-flows` package.
This step refreshes the shipping methods of a cart.
@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/refreshPaymentCollectionForCartWorkflow
sidebar_label: refreshPaymentCollectionForCartWorkflow
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# refreshPaymentCollectionForCartWorkflow
# refreshPaymentCollectionForCartWorkflow - Medusa Workflows API Reference
This documentation provides a reference to the `refreshPaymentCollectionForCartWorkflow`. It belongs to the `@medusajs/core-flows` package.
This workflow refreshes the payment collections of a cart.
@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/steps/removeLineItemAdjustmentsStep
sidebar_label: removeLineItemAdjustmentsStep
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# removeLineItemAdjustmentsStep
# 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.
@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/steps/removeShippingMethodAdjustmentsStep
sidebar_label: removeShippingMethodAdjustmentsStep
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# removeShippingMethodAdjustmentsStep
# 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.
@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/steps/removeShippingMethodFromCartStep
sidebar_label: removeShippingMethodFromCartStep
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# removeShippingMethodFromCartStep
# 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.
@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/steps/reserveInventoryStep
sidebar_label: reserveInventoryStep
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# reserveInventoryStep
# 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.
@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/steps/retrieveCartStep
sidebar_label: retrieveCartStep
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# retrieveCartStep
# retrieveCartStep - Medusa Workflows API Reference
This documentation provides a reference to the `retrieveCartStep`. It belongs to the `@medusajs/core-flows` package.
This step retrieves a cart's details.
@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/steps/retrieveCartWithLinksStep
sidebar_label: retrieveCartWithLinksStep
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# retrieveCartWithLinksStep
# 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.
@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/steps/setTaxLinesForItemsStep
sidebar_label: setTaxLinesForItemsStep
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# setTaxLinesForItemsStep
# 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.
@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/steps/updateCartPromotionsStep
sidebar_label: updateCartPromotionsStep
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# updateCartPromotionsStep
# 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.
@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/updateCartPromotionsWorkflow
sidebar_label: updateCartPromotionsWorkflow
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# updateCartPromotionsWorkflow
# updateCartPromotionsWorkflow - Medusa Workflows API Reference
This documentation provides a reference to the `updateCartPromotionsWorkflow`. It belongs to the `@medusajs/core-flows` package.
This workflow updates a cart's promotions.
@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/updateCartWorkflow
sidebar_label: updateCartWorkflow
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# updateCartWorkflow
# updateCartWorkflow - Medusa Workflows API Reference
This documentation provides a reference to the `updateCartWorkflow`. It belongs to the `@medusajs/core-flows` package.
This workflow updates a cart.
@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/steps/updateCartsStep
sidebar_label: updateCartsStep
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# updateCartsStep
# updateCartsStep - Medusa Workflows API Reference
This documentation provides a reference to the `updateCartsStep`. It belongs to the `@medusajs/core-flows` package.
This step updates a cart.
@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/updateLineItemInCartWorkflow
sidebar_label: updateLineItemInCartWorkflow
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# updateLineItemInCartWorkflow
# updateLineItemInCartWorkflow - Medusa Workflows API Reference
This documentation provides a reference to the `updateLineItemInCartWorkflow`. It belongs to the `@medusajs/core-flows` package.
This workflow updates a cart's line item.
@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/steps/updateLineItemsStep
sidebar_label: updateLineItemsStep
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# updateLineItemsStep
# updateLineItemsStep - Medusa Workflows API Reference
This documentation provides a reference to the `updateLineItemsStep`. It belongs to the `@medusajs/core-flows` package.
This step updates a cart's line items.
@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/updateTaxLinesWorkflow
sidebar_label: updateTaxLinesWorkflow
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# updateTaxLinesWorkflow
# updateTaxLinesWorkflow - Medusa Workflows API Reference
This documentation provides a reference to the `updateTaxLinesWorkflow`. It belongs to the `@medusajs/core-flows` package.
This workflow updates a cart's tax lines.
@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/steps/validateCartPaymentsStep
sidebar_label: validateCartPaymentsStep
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# validateCartPaymentsStep
# validateCartPaymentsStep - Medusa Workflows API Reference
This documentation provides a reference to the `validateCartPaymentsStep`. It belongs to the `@medusajs/core-flows` package.
This step validates a cart's payment sessions. Their status must
be `pending` or `requires_more`.
@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/steps/validateCartShippingOptionsStep
sidebar_label: validateCartShippingOptionsStep
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# validateCartShippingOptionsStep
# validateCartShippingOptionsStep - Medusa Workflows API Reference
This documentation provides a reference to the `validateCartShippingOptionsStep`. It belongs to the `@medusajs/core-flows` package.
This step validates shipping options to ensure they can be applied on a cart.
@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/steps/validateExistingPaymentCollectionStep
sidebar_label: validateExistingPaymentCollectionStep
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# validateExistingPaymentCollectionStep
# validateExistingPaymentCollectionStep - Medusa Workflows API Reference
This documentation provides a reference to the `validateExistingPaymentCollectionStep`. It belongs to the `@medusajs/core-flows` package.
This step validates that a cart doesn't have a payment collection.
@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/steps/validateVariantPricesStep
sidebar_label: validateVariantPricesStep
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# validateVariantPricesStep
# 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.
@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/steps/deleteFilesStep
sidebar_label: deleteFilesStep
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# deleteFilesStep
# deleteFilesStep - Medusa Workflows API Reference
This documentation provides a reference to the `deleteFilesStep`. It belongs to the `@medusajs/core-flows` package.
This step deletes one or more files.
@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/deleteFilesWorkflow
sidebar_label: deleteFilesWorkflow
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# deleteFilesWorkflow
# deleteFilesWorkflow - Medusa Workflows API Reference
This documentation provides a reference to the `deleteFilesWorkflow`. It belongs to the `@medusajs/core-flows` package.
This workflow deletes one or more files.
@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/steps/uploadFilesStep
sidebar_label: uploadFilesStep
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# uploadFilesStep
# uploadFilesStep - Medusa Workflows API Reference
This documentation provides a reference to the `uploadFilesStep`. It belongs to the `@medusajs/core-flows` package.
This step uploads one or more files.
@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/uploadFilesWorkflow
sidebar_label: uploadFilesWorkflow
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# uploadFilesWorkflow
# uploadFilesWorkflow - Medusa Workflows API Reference
This documentation provides a reference to the `uploadFilesWorkflow`. It belongs to the `@medusajs/core-flows` package.
This workflow uploads one or more files.
@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/batchShippingOptionRulesWorkflow
sidebar_label: batchShippingOptionRulesWorkflow
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# batchShippingOptionRulesWorkflow
# batchShippingOptionRulesWorkflow - Medusa Workflows API Reference
This documentation provides a reference to the `batchShippingOptionRulesWorkflow`. It belongs to the `@medusajs/core-flows` package.
This workflow manages shipping option rules by creating, updating, or deleting them.
@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/steps/cancelFulfillmentStep
sidebar_label: cancelFulfillmentStep
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# cancelFulfillmentStep
# cancelFulfillmentStep - Medusa Workflows API Reference
This documentation provides a reference to the `cancelFulfillmentStep`. It belongs to the `@medusajs/core-flows` package.
This step cancels a fulfillment.
@@ -1,6 +1,13 @@
---
slug: /references/medusa-workflows/cancelFulfillmentWorkflow
sidebar_label: cancelFulfillmentWorkflow
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# cancelFulfillmentWorkflow
# cancelFulfillmentWorkflow - Medusa Workflows API Reference
This documentation provides a reference to the `cancelFulfillmentWorkflow`. It belongs to the `@medusajs/core-flows` package.
This workflow cancels a fulfillment.
Loaded 100 of 557 files, more files were not shown because too many files have changed in this diff. Show more