Menu
  • Get Started
  • Product
  • Resources
  • Tools & SDKs
  • Framework
  • Reference

linkSalesChannelsToApiKeyWorkflow - Medusa Core Workflows Reference

This documentation provides a reference to the linkSalesChannelsToApiKeyWorkflow. It belongs to the @medusajs/medusa/core-flows package.

This workflow manages the sales channels of a publishable API key. It's used by the Manage Sales Channels API Route.

You can use this workflow within your customizations or your own custom workflows, allowing you to manage the sales channels of a publishable API key within your custom flows.

Source Code

Examples#

Steps#

validateSalesChannelsExistStep

linkSalesChannelsToApiKeyStep

Workflow Hook

Step conditioned by when

Input#

LinkWorkflowInputLinkWorkflowInput
idstring
The ID of the data model to create links to or remove links from.
addstring[]Optional
The IDs of the other data models to create links to the record specified in id.
removestring[]Optional
The IDs of the other data models to remove links from the record specified in id.
Was this page helpful?
Ask Anything
FAQ
What is Medusa?
How can I create a module?
How can I create a data model?
How do I create a workflow?
How can I extend a data model in the Product Module?
Recipes
How do I build a marketplace with Medusa?
How do I build digital products with Medusa?
How do I build subscription-based purchases with Medusa?
What other recipes are available in the Medusa documentation?
Chat is cleared on refresh
Line break
⇧↵