Help

Order Module's Admin Widget Injection Zones

This reference shows all the injection zones in the Medusa Admin related to the Order Module.

Deprecated Suffixes: Before Medusa v2.17.2, injection zone names ended with .before or .after to place the widget at the top or the bottom of the zone. These suffixes are deprecated, and you should use the zone name without the suffix instead.A widget is now added at the end of the zone it's injected into. Admin users can then change its placement, including moving it to the top of the page or in between the page's core components, using Layout Configurations.Widgets that still use the .before or .after suffixes keep rendering, but the suffix no longer changes their placement.

Draft Order Pages#

Note: These widget zones are available starting from Medusa v2.16.0.

Injection Zone Name	Description	Additional Props
`draft_order.details`	Added at the end of a draft order's details page.	Type `DetailWidgetProps<AdminDraftOrder>` imported from `@medusajs/framework/types` `{ data, // AdminDraftOrder object }`
`draft_order.details.side`	Added at the end of the side section in a draft order's details page.	Type `DetailWidgetProps<AdminDraftOrder>` imported from `@medusajs/framework/types` `{ data, // AdminDraftOrder object }`
`draft_order.list`	Added at the end of the draft orders list page.	-

Injection Zone Name

Description

Additional Props

draft_order.details

Added at the end of a draft order's details page.

Type DetailWidgetProps<AdminDraftOrder> imported from @medusajs/framework/types

{
  data, // AdminDraftOrder object
}

draft_order.details.side

Added at the end of the side section in a draft order's details page.

Type DetailWidgetProps<AdminDraftOrder> imported from @medusajs/framework/types

{
  data, // AdminDraftOrder object
}

draft_order.list

Added at the end of the draft orders list page.

Order Pages#

Injection Zone Name	Description	Additional Props
`order.list`	Added at the end of the order list page.	-
`order.details`	Added at the end of the order details page.	Type `DetailWidgetProps<AdminOrder>` imported from `@medusajs/framework/types` `{ data, // AdminOrder object }`
`order.details.side`	Added at the end of the second column in the order details page.	Type `DetailWidgetProps<AdminOrder>` imported from `@medusajs/framework/types` `{ data, // AdminOrder object }`

Injection Zone Name

Description

Additional Props

order.list

Added at the end of the order list page.

order.details

Added at the end of the order details page.

Type DetailWidgetProps<AdminOrder> imported from @medusajs/framework/types

{
  data, // AdminOrder object
}

order.details.side

Added at the end of the second column in the order details page.

Type DetailWidgetProps<AdminOrder> imported from @medusajs/framework/types

{
  data, // AdminOrder object
}

Return Reason Pages#

Injection Zone Name	Description	Additional Props
`return_reason.list`	Added at the end of the return reasons list page.	-

Was this page helpful?