dismissRemoteLinkStep - Helper Steps API Reference

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

This step removes remote links between two records of linked data models.

Learn more in the Remote Link documentation..

Example#

Code
1import {2  createWorkflow3} from "@medusajs/framework/workflows-sdk"4import {5  dismissRemoteLinkStep6} from "@medusajs/medusa/core-flows"7import {8  Modules9} from "@medusajs/framework/utils"10
11const helloWorldWorkflow = createWorkflow(12  "hello-world",13  () => {14    dismissRemoteLinkStep([{15      [Modules.PRODUCT]: {16        product_id: "prod_123",17      },18      "helloModuleService": {19        my_custom_id: "mc_123",20      },21    }])22  }23)

Input#

DismissRemoteLinksStepInputDismissRemoteLinksStepInput
DismissRemoteLinksStepInputLinkDefinition | LinkDefinition[]

Output#

LinkDefinition[]LinkDefinition[]
LinkDefinitionobject & object
A link for two records of linked data models. The keys are the names of each module, and their value is an object that holds the ID of the linked data model's record.
Was this page helpful?