getOrdersListWorkflow - Medusa Core Workflows Reference

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

This workflow retrieves a list of orders. It's used by the List Orders Admin API Route, and the List Orders Store API Route.

You can use this workflow within your customizations or your own custom workflows, allowing you to retrieve a list of orders in your custom flows. For example, you can retrieve the list of orders to export them to a third-party system.

Examples#

To retrieve the list of orders:

To retrieve the list of orders with pagination:

Steps#

Input#

Output#