useQueryGraphStep - Helper Steps API Reference

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

This step fetches data across modules using the Query.

Learn more in the Query documentation.

Example#

To retrieve a list of records of a data model:

Code
1import {2  createWorkflow3} from "@medusajs/framework/workflows-sdk"4import {5  useQueryGraphStep6} from "@medusajs/medusa/core-flows"7
8const helloWorldWorkflow = createWorkflow(9  "hello-world",10  () => {11    const { data: products } = useQueryGraphStep({12      entity: "product",13      fields: [14        "*",15        "variants.*"16      ]17    })18  }19)

To retrieve a single item instead of a an array:

Code
1const { data: products } = useQueryGraphStep({2  entity: "product",3  fields: [4    "*",5    "variants.*"6  ],7  filters: {8    id: "123"9  }10})

To throw an error if a record isn't found matching the specified ID:

Code
1const { data: products } = useQueryGraphStep({2  entity: "product",3  fields: [4    "*",5    "variants.*"6  ],7  filters: {8    id: "123"9  },10  options: {11    throwIfKeyNotFound: true12  }13})

To set pagination configurations:

Code
1const { data: products } = useQueryGraphStep({2  entity: "product",3  fields: [4    "*",5    "variants.*"6  ],7  filters: {8    id: "123"9  },10  pagination: {11    take: 10,12    skip: 10,13    order: {14      created_at: "DESC"15    }16  }17})

Input#

Output#