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

getOrderDetailWorkflow - Medusa Core Workflows Reference

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

This workflow retrieves an order's details. It's used by many API routes, including Get an Order Admin API Route, and Get an Order Store API Route.

You can use this workflow within your customizations or your own custom workflows, allowing you to retrieve an order's details in your custom flows.

Source Code

Examples#

Steps#

useRemoteQueryStep

Workflow Hook

Step conditioned by when

Input#

GetOrderDetailWorkflowInputGetOrderDetailWorkflowInput
The data to retrieve an order's details.
fieldsstring[]
The fields and relations to retrieve in the order. These fields are passed to Query, so you can pass names of custom models linked to the order.
order_idstring
The ID of the order to retrieve.
filtersobjectOptional
Additional filters to apply on the retrieved order.
versionnumberOptional
The version of the order to retrieve. If not provided, the latest version of the order will be retrieved.

Output#

OrderDetailDTOOrderDetailDTO
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
⇧↵