removeRemoteLinkStep - Helper Steps API Reference

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

This step deletes linked records of a record.

Learn more in the Remote Link documentation

Example#

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

Input#

RemoveRemoteLinksStepInputRemoveRemoteLinksStepInput

Output#

DeleteEntityInputDeleteEntityInput
DeleteEntityInputobject
The details of a data model's record whose linked records should be deleted. Usually used after the data model's record is deleted. The key is the data model's name. Its value is an object that has the ID of the data model's record.
Was this page helpful?