Metadata not included with Order query

[x8BitRain]

Bug report

Describe the bug

If I query an existing order or list the current customer's orders with metadata attached to it, it does not get included in the query response via HTTP or medusaJS client. All related model data does though, region, payment, variants, customer etc, include metadata except the Order object.

I have a custom API endpoint that creates orders from carts with orderService.createFromCart():

export async function POST(
  req: MedusaRequest,
  res: MedusaResponse,
): Promise<void> {
  // This is here to bypass the entire Medusa order process and create an order directly from a cart for PoC purposes.

  const orderService = req.scope.resolve('orderService') as OrderService;
  const { cart_id } = req.body as ApiNewOrderRequest;

  try {
    const newOrder = await orderService.createFromCart(cart_id);

    res.status(200).json(newOrder);
  } catch (error) {
    res.status(500).json({ message: error.message });
  }
}

I then can update the metadata with:

const newOrder = await orderService.update(order_id, {
    metadata: {
        status: status,
    },
});

The orders do show metadata in the admin panel but when querying with the medusa-js client:

medusa.customers.listOrders();

or

medusa.orders.retrieve('order_01HYFPV5T711ZRHFJSK348P6BB')

the metadata is not included in the response.

System information

Medusa version (including plugins):

    "@medusajs/admin": "^7.1.14",
    "@medusajs/cache-inmemory": "latest",
    "@medusajs/cache-redis": "^1.9.1",
    "@medusajs/event-bus-local": "latest",
    "@medusajs/event-bus-redis": "^1.8.13",
    "@medusajs/file-local": "latest",
    "@medusajs/medusa": "^1.20.6",
    "@medusajs/product": "^0.3.12",

Node.js version: v20.12.0
Database: Postgres 16
Operating system: macos
Browser (if relevant): latest chrome

Steps to reproduce the behavior

medusa-no-metadata-on-orders.mp4

Expected behavior

metadata should be included with Order queries made via medusa-js client

Additional context

If I make my own endpoint with orderService.retrieve() then it returns the data with metadata attached:

export async function POST(
  req: MedusaRequest,
  res: MedusaResponse,
): Promise<void> {
  // This is here to update the order status manually for PoC purposes.\
  const orderService = req.scope.resolve('orderService') as OrderService;
  const { order_id } = req.body as ApiNewOrderUpdateRequest;

  try {
    const newOrder = await orderService.retrieve(order_id);

    res.status(200).json(newOrder);
  } catch (error) {
    res.status(500).json({ message: error.message });
  }
}

[github-actions]

This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 3 days.

[github-actions]

This issue was closed because it has been stalled for 3 days with no activity.

[oz-verum]

Hi guys, it still exists, no metadata in medusa.customers.listOrders(); but as mentioned in your doc it's required, please add the missed property, thanks.