chore(order): custom display id (#14024)

* chore(order): Accept a custom display generator option

* chore(order): Accept a custom display generator option

* wip

* wip

* finalize

* Create tricky-olives-battle.md

* fields

* changeset

* update integration tests

* update migrations

* fix changeset

.changeset/tricky-olives-battle.md

@@ -0,0 +1,9 @@
+---
+"@medusajs/medusa": patch
+"@medusajs/order": patch
+"@medusajs/dashboard": patch
+"@medusajs/core-flows": patch
+"@medusajs/types": patch
+---
+
+Chore/order custom display

integration-tests/modules/__tests__/order/order.spec.ts

@@ -281,6 +281,7 @@ medusaIntegrationTestRunner({
           status: "pending",
           version: 1,
           display_id: 2,
+          custom_display_id: null,
           payment_collections: [],
           payment_status: "not_paid",
           region_id: "test_region_id",

packages/admin/dashboard/src/routes/orders/order-detail/constants.ts

@@ -5,6 +5,7 @@ const DEFAULT_PROPERTIES = [
   "canceled_at",
   "email",
   "display_id",
+  "custom_display_id",
   "currency_code",
   "metadata",
   // --- TOTALS ---

packages/admin/dashboard/src/routes/orders/order-list/const.ts

@@ -4,6 +4,7 @@ export const DEFAULT_PROPERTIES = [
   "created_at",
   "email",
   "display_id",
+  "custom_display_id",
   "payment_status",
   "fulfillment_status",
   "total",

packages/core/core-flows/src/order/workflows/create-fulfillment.ts

@@ -400,6 +400,7 @@ export const createOrderFulfillmentWorkflow = createWorkflow(
       fields: [
         "id",
         "display_id",
+        "custom_display_id",
         "status",
         "customer_id",
         "customer.*",

packages/core/types/src/http/order/common.ts

@@ -740,6 +740,10 @@ export interface BaseOrder {
    * The order's display ID.
    */
   display_id?: number
+  /**
+   * The order's custom display ID.
+   */
+  custom_display_id?: string
   /**
    * The order's status.
    */

packages/core/types/src/order/common.ts

@@ -1036,6 +1036,11 @@ export interface OrderDTO {
    */
   display_id: number
 
+  /**
+   * The order's custom display ID.
+   */
+  custom_display_id?: string
+
   /**
    * The active order change, if any.
    *

packages/medusa/src/api/admin/draft-orders/query-config.ts

@@ -1,6 +1,7 @@
 export const defaultAdminListOrderFields = [
   "id",
   "display_id",
+  "custom_display_id",
   "status",
   "version",
   "email",
@@ -16,6 +17,7 @@ export const defaultAdminListOrderFields = [
 export const defaultAdminOrderFields = [
   "id",
   "display_id",
+  "custom_display_id",
   "status",
   "version",
   "email",

packages/medusa/src/api/admin/orders/query-config.ts

@@ -1,6 +1,7 @@
 export const defaultAdminOrderFields = [
   "id",
   "display_id",
+  "custom_display_id",
   "status",
   "version",
   "summary",

packages/medusa/src/api/admin/views/[entity]/columns/helpers.ts

@@ -22,14 +22,19 @@ export const getColumnCategory = (
   semanticType?: string
 ): HttpTypes.AdminColumn["category"] => {
   // Check semantic type first
-  if (semanticType === "timestamp") return "timestamp"
-  if (semanticType === "status") return "status"
+  if (semanticType === "timestamp") {
+    return "timestamp"
+  }
+  if (semanticType === "status") {
+    return "status"
+  }
 
   // Check field name patterns
   if (
     fieldName.includes("_id") ||
     fieldName === "id" ||
     fieldName.includes("display_id") ||
+    fieldName.includes("custom_display_id") ||
     fieldName === "code"
   ) {
     return "identifier"
@@ -191,7 +196,7 @@ export const getTypeInfoFromGraphQLType = (
       semantic_type: "object",
       context: "metadata",
     }
-  } else if (fieldName === "display_id") {
+  } else if (fieldName === "display_id" || fieldName === "custom_display_id") {
     return {
       data_type: "string",
       semantic_type: "identifier",
@@ -264,6 +269,7 @@ const ADDITIONAL_ENTITY_TYPES: Partial<Record<Entities, string[]>> = {
 export const DEFAULT_COLUMN_ORDERS: Record<Entities, Record<string, number>> = {
   orders: {
     display_id: 100,
+    custom_display_id: 101,
     created_at: 200,
     customer_display: 300,
     "sales_channel.name": 400,
@@ -370,6 +376,10 @@ export const generateEntityColumns = (
     directFields.unshift("display_id")
   }
 
+  if (entity === "orders" && !directFields.includes("custom_display_id")) {
+    directFields.unshift("custom_display_id")
+  }
+
   const additionalTypes = ADDITIONAL_ENTITY_TYPES[entity as Entities] ?? []
 
   additionalTypes.forEach((typeName) => {
@@ -380,11 +390,7 @@ export const generateEntityColumns = (
       return
     }
 
-    const additionalFields = graphqlSchemaToFields(
-      schemaTypeMap,
-      typeName,
-      []
-    )
+    const additionalFields = graphqlSchemaToFields(schemaTypeMap, typeName, [])
 
     additionalFields.forEach((fieldName) => {
       if (directFields.includes(fieldName)) {
@@ -460,7 +466,8 @@ export const generateEntityColumns = (
   const directColumns = directFields.map((fieldName) => {
     const displayName = formatFieldName(fieldName)
 
-    const fieldDef = entityFields[fieldName] || additionalFieldDefinitions.get(fieldName)
+    const fieldDef =
+      entityFields[fieldName] || additionalFieldDefinitions.get(fieldName)
     const typeInfo = fieldDef
       ? getTypeInfoFromGraphQLType(fieldDef.type, fieldName)
       : getTypeInfoFromGraphQLType(null, fieldName)

packages/medusa/src/api/store/orders/query-config.ts

@@ -5,6 +5,7 @@ export const defaultStoreOrderFields = [
   "status",
   "summary",
   "display_id",
+  "custom_display_id",
   "total",
   "currency_code",
   "metadata",
@@ -18,6 +19,7 @@ export const defaultStoreRetrieveOrderFields = [
   "summary",
   "currency_code",
   "display_id",
+  "custom_display_id",
   "region_id",
   "email",
   "total",

packages/modules/api-key/src/migrations/Migration20251015123842.ts

@@ -1,15 +1,17 @@
-import { Migration } from '@mikro-orm/migrations';
+import { Migration } from "@medusajs/framework/mikro-orm/migrations"
 
 export class Migration20251015123842 extends Migration {
-
   override async up(): Promise<void> {
-    this.addSql(`CREATE INDEX IF NOT EXISTS "IDX_api_key_revoked_at" ON "api_key" (revoked_at) WHERE deleted_at IS NULL;`);
-    this.addSql(`CREATE INDEX IF NOT EXISTS "IDX_api_key_redacted" ON "api_key" (redacted) WHERE deleted_at IS NULL;`);
+    this.addSql(
+      `CREATE INDEX IF NOT EXISTS "IDX_api_key_revoked_at" ON "api_key" (revoked_at) WHERE deleted_at IS NULL;`
+    )
+    this.addSql(
+      `CREATE INDEX IF NOT EXISTS "IDX_api_key_redacted" ON "api_key" (redacted) WHERE deleted_at IS NULL;`
+    )
   }
 
   override async down(): Promise<void> {
-    this.addSql(`drop index if exists "IDX_api_key_revoked_at";`);
-    this.addSql(`drop index if exists "IDX_api_key_redacted";`);
+    this.addSql(`drop index if exists "IDX_api_key_revoked_at";`)
+    this.addSql(`drop index if exists "IDX_api_key_redacted";`)
   }
-
 }

packages/modules/cart/src/migrations/Migration20251017153909.ts

@@ -1,33 +1,43 @@
-import { Migration } from '@mikro-orm/migrations';
+import { Migration } from "@medusajs/framework/mikro-orm/migrations"
 
 export class Migration20251017153909 extends Migration {
-
   override async up(): Promise<void> {
-    this.addSql(`drop index if exists "IDX_line_item_cart_id";`);
+    this.addSql(`drop index if exists "IDX_line_item_cart_id";`)
 
-    this.addSql(`drop index if exists "IDX_adjustment_item_id";`);
+    this.addSql(`drop index if exists "IDX_adjustment_item_id";`)
 
-    this.addSql(`drop index if exists "IDX_tax_line_item_id";`);
+    this.addSql(`drop index if exists "IDX_tax_line_item_id";`)
 
-    this.addSql(`drop index if exists "IDX_shipping_method_cart_id";`);
+    this.addSql(`drop index if exists "IDX_shipping_method_cart_id";`)
 
-    this.addSql(`drop index if exists "IDX_adjustment_shipping_method_id";`);
+    this.addSql(`drop index if exists "IDX_adjustment_shipping_method_id";`)
 
-    this.addSql(`drop index if exists "IDX_tax_line_shipping_method_id";`);
+    this.addSql(`drop index if exists "IDX_tax_line_shipping_method_id";`)
   }
 
   override async down(): Promise<void> {
-    this.addSql(`CREATE INDEX IF NOT EXISTS "IDX_line_item_cart_id" ON "cart_line_item" (cart_id) WHERE deleted_at IS NULL;`);
+    this.addSql(
+      `CREATE INDEX IF NOT EXISTS "IDX_line_item_cart_id" ON "cart_line_item" (cart_id) WHERE deleted_at IS NULL;`
+    )
 
-    this.addSql(`CREATE INDEX IF NOT EXISTS "IDX_adjustment_item_id" ON "cart_line_item_adjustment" (item_id) WHERE deleted_at IS NULL;`);
+    this.addSql(
+      `CREATE INDEX IF NOT EXISTS "IDX_adjustment_item_id" ON "cart_line_item_adjustment" (item_id) WHERE deleted_at IS NULL;`
+    )
 
-    this.addSql(`CREATE INDEX IF NOT EXISTS "IDX_tax_line_item_id" ON "cart_line_item_tax_line" (item_id) WHERE deleted_at IS NULL;`);
+    this.addSql(
+      `CREATE INDEX IF NOT EXISTS "IDX_tax_line_item_id" ON "cart_line_item_tax_line" (item_id) WHERE deleted_at IS NULL;`
+    )
 
-    this.addSql(`CREATE INDEX IF NOT EXISTS "IDX_shipping_method_cart_id" ON "cart_shipping_method" (cart_id) WHERE deleted_at IS NULL;`);
+    this.addSql(
+      `CREATE INDEX IF NOT EXISTS "IDX_shipping_method_cart_id" ON "cart_shipping_method" (cart_id) WHERE deleted_at IS NULL;`
+    )
 
-    this.addSql(`CREATE INDEX IF NOT EXISTS "IDX_adjustment_shipping_method_id" ON "cart_shipping_method_adjustment" (shipping_method_id) WHERE deleted_at IS NULL;`);
+    this.addSql(
+      `CREATE INDEX IF NOT EXISTS "IDX_adjustment_shipping_method_id" ON "cart_shipping_method_adjustment" (shipping_method_id) WHERE deleted_at IS NULL;`
+    )
 
-    this.addSql(`CREATE INDEX IF NOT EXISTS "IDX_tax_line_shipping_method_id" ON "cart_shipping_method_tax_line" (shipping_method_id) WHERE deleted_at IS NULL;`);
+    this.addSql(
+      `CREATE INDEX IF NOT EXISTS "IDX_tax_line_shipping_method_id" ON "cart_shipping_method_tax_line" (shipping_method_id) WHERE deleted_at IS NULL;`
+    )
   }
-
 }

packages/modules/customer/src/migrations/Migration20251010130829.ts

@@ -1,17 +1,13 @@
-import { Migration } from '@mikro-orm/migrations';
+import { Migration } from "@medusajs/framework/mikro-orm/migrations"
 
 export class Migration20251010130829 extends Migration {
-
   override async up(): Promise<void> {
-    this.addSql(
-      'DROP INDEX IF EXISTS "IDX_customer_group_name";'
-    );
+    this.addSql('DROP INDEX IF EXISTS "IDX_customer_group_name";')
   }
 
   override async down(): Promise<void> {
     this.addSql(
       'CREATE UNIQUE INDEX IF NOT EXISTS "IDX_customer_group_name" ON "customer_group" ("name") WHERE "deleted_at" IS NULL;'
-    );
+    )
   }
-
 }

packages/modules/inventory/src/migrations/Migration20251010131115.ts

@@ -1,17 +1,13 @@
-import { Migration } from '@mikro-orm/migrations';
+import { Migration } from "@medusajs/framework/mikro-orm/migrations"
 
 export class Migration20251010131115 extends Migration {
-
   override async up(): Promise<void> {
-    this.addSql(
-      'DROP INDEX IF EXISTS "IDX_inventory_level_item_location";'
-    );
+    this.addSql('DROP INDEX IF EXISTS "IDX_inventory_level_item_location";')
   }
 
   override async down(): Promise<void> {
     this.addSql(
       'CREATE UNIQUE INDEX IF NOT EXISTS "IDX_inventory_level_item_location" ON "inventory_level" (inventory_item_id, location_id) WHERE deleted_at IS NULL;'
-    );
+    )
   }
-
 }

packages/modules/notification/src/migrations/Migration20251028172715.ts

@@ -1,15 +1,21 @@
-import { Migration } from '@mikro-orm/migrations';
+import { Migration } from "@medusajs/framework/mikro-orm/migrations"
 
 export class Migration20251028172715 extends Migration {
-
   override async up(): Promise<void> {
-    this.addSql(`alter table if exists "notification" alter column "template" type text using ("template"::text);`);
-    this.addSql(`alter table if exists "notification" alter column "template" drop not null;`);
+    this.addSql(
+      `alter table if exists "notification" alter column "template" type text using ("template"::text);`
+    )
+    this.addSql(
+      `alter table if exists "notification" alter column "template" drop not null;`
+    )
   }
 
   override async down(): Promise<void> {
-    this.addSql(`alter table if exists "notification" alter column "template" type text using ("template"::text);`);
-    this.addSql(`alter table if exists "notification" alter column "template" set not null;`);
+    this.addSql(
+      `alter table if exists "notification" alter column "template" type text using ("template"::text);`
+    )
+    this.addSql(
+      `alter table if exists "notification" alter column "template" set not null;`
+    )
   }
-
 }

packages/modules/order/integration-tests/__tests__/create-order.spec.ts

@@ -6,6 +6,11 @@ jest.setTimeout(100000)
 
 moduleIntegrationTestRunner<IOrderModuleService>({
   moduleName: Modules.ORDER,
+  moduleOptions: {
+    generateCustomDisplayId: async (order: CreateOrderDTO): Promise<string> => {
+      return order.currency_code + "_1234567890"
+    },
+  },
   testSuite: ({ service, MikroOrmWrapper }) => {
     describe("Order Module Service", () => {
       const input = {
@@ -124,6 +129,7 @@ moduleIntegrationTestRunner<IOrderModuleService>({
         id: expect.stringContaining("order_"),
         version: 1,
         display_id: 1,
+        custom_display_id: "usd_1234567890",
         summary: expect.objectContaining({
           // TODO: add all summary fields
         }),
@@ -413,6 +419,7 @@ moduleIntegrationTestRunner<IOrderModuleService>({
             "id",
             "display_id",
             "version",
+            "custom_display_id",
             "items.id",
             "summary",
             "items.quantity",

packages/modules/order/src/migrations/Migration20251016182939.ts

@@ -1,4 +1,4 @@
-import { Migration } from "@mikro-orm/migrations"
+import { Migration } from "@medusajs/framework/mikro-orm/migrations"
 
 export class Migration20251016182939 extends Migration {
   override async up(): Promise<void> {

packages/modules/order/src/migrations/Migration20251017155709.ts

@@ -1,25 +1,31 @@
-import { Migration } from '@mikro-orm/migrations';
+import { Migration } from "@medusajs/framework/mikro-orm/migrations"
 
 export class Migration20251017155709 extends Migration {
-
   override async up(): Promise<void> {
-    this.addSql(`drop index if exists "IDX_order_item_version";`);
+    this.addSql(`drop index if exists "IDX_order_item_version";`)
 
-    this.addSql(`CREATE INDEX IF NOT EXISTS "IDX_order_item_order_id_version" ON "order_item" (order_id, version) WHERE deleted_at IS NULL;`);
+    this.addSql(
+      `CREATE INDEX IF NOT EXISTS "IDX_order_item_order_id_version" ON "order_item" (order_id, version) WHERE deleted_at IS NULL;`
+    )
 
-    this.addSql(`drop index if exists "IDX_order_shipping_version";`);
+    this.addSql(`drop index if exists "IDX_order_shipping_version";`)
 
-    this.addSql(`CREATE INDEX IF NOT EXISTS "IDX_order_shipping_order_id_version" ON "order_shipping" (order_id, version) WHERE deleted_at IS NULL;`);
+    this.addSql(
+      `CREATE INDEX IF NOT EXISTS "IDX_order_shipping_order_id_version" ON "order_shipping" (order_id, version) WHERE deleted_at IS NULL;`
+    )
   }
 
   override async down(): Promise<void> {
-    this.addSql(`drop index if exists "IDX_order_item_order_id_version";`);
+    this.addSql(`drop index if exists "IDX_order_item_order_id_version";`)
 
-    this.addSql(`CREATE INDEX IF NOT EXISTS "IDX_order_item_version" ON "order_item" (order_id, version) WHERE deleted_at IS NULL;`);
+    this.addSql(
+      `CREATE INDEX IF NOT EXISTS "IDX_order_item_version" ON "order_item" (order_id, version) WHERE deleted_at IS NULL;`
+    )
 
-    this.addSql(`drop index if exists "IDX_order_shipping_order_id_version";`);
+    this.addSql(`drop index if exists "IDX_order_shipping_order_id_version";`)
 
-    this.addSql(`CREATE INDEX IF NOT EXISTS "IDX_order_shipping_version" ON "order_shipping" (order_id, version) WHERE deleted_at IS NULL;`);
+    this.addSql(
+      `CREATE INDEX IF NOT EXISTS "IDX_order_shipping_version" ON "order_shipping" (order_id, version) WHERE deleted_at IS NULL;`
+    )
   }
-
 }

packages/modules/order/src/migrations/Migration20251114100559.ts

@@ -0,0 +1,131 @@
+import { Migration } from "@medusajs/framework/mikro-orm/migrations"
+
+export class Migration20251114100559 extends Migration {
+  override async up(): Promise<void> {
+    this.addSql(
+      `alter table if exists "order" add column if not exists "custom_display_id" text null;`
+    )
+    this.addSql(
+      `CREATE UNIQUE INDEX IF NOT EXISTS "IDX_order_custom_display_id" ON "order" ("custom_display_id") WHERE deleted_at IS NULL;`
+    )
+
+    this.addSql(
+      `alter table if exists "order_item" alter column "raw_fulfilled_quantity" type jsonb using ("raw_fulfilled_quantity"::jsonb);`
+    )
+    this.addSql(
+      `alter table if exists "order_item" alter column "raw_fulfilled_quantity" set default '{"value":"0","precision":20}';`
+    )
+    this.addSql(
+      `alter table if exists "order_item" alter column "raw_delivered_quantity" type jsonb using ("raw_delivered_quantity"::jsonb);`
+    )
+    this.addSql(
+      `alter table if exists "order_item" alter column "raw_delivered_quantity" set default '{"value":"0","precision":20}';`
+    )
+    this.addSql(
+      `alter table if exists "order_item" alter column "raw_shipped_quantity" type jsonb using ("raw_shipped_quantity"::jsonb);`
+    )
+    this.addSql(
+      `alter table if exists "order_item" alter column "raw_shipped_quantity" set default '{"value":"0","precision":20}';`
+    )
+    this.addSql(
+      `alter table if exists "order_item" alter column "raw_return_requested_quantity" type jsonb using ("raw_return_requested_quantity"::jsonb);`
+    )
+    this.addSql(
+      `alter table if exists "order_item" alter column "raw_return_requested_quantity" set default '{"value":"0","precision":20}';`
+    )
+    this.addSql(
+      `alter table if exists "order_item" alter column "raw_return_received_quantity" type jsonb using ("raw_return_received_quantity"::jsonb);`
+    )
+    this.addSql(
+      `alter table if exists "order_item" alter column "raw_return_received_quantity" set default '{"value":"0","precision":20}';`
+    )
+    this.addSql(
+      `alter table if exists "order_item" alter column "raw_return_dismissed_quantity" type jsonb using ("raw_return_dismissed_quantity"::jsonb);`
+    )
+    this.addSql(
+      `alter table if exists "order_item" alter column "raw_return_dismissed_quantity" set default '{"value":"0","precision":20}';`
+    )
+    this.addSql(
+      `alter table if exists "order_item" alter column "raw_written_off_quantity" type jsonb using ("raw_written_off_quantity"::jsonb);`
+    )
+    this.addSql(
+      `alter table if exists "order_item" alter column "raw_written_off_quantity" set default '{"value":"0","precision":20}';`
+    )
+
+    this.addSql(
+      `alter table if exists "return_item" alter column "raw_received_quantity" type jsonb using ("raw_received_quantity"::jsonb);`
+    )
+    this.addSql(
+      `alter table if exists "return_item" alter column "raw_received_quantity" set default '{"value":"0","precision":20}';`
+    )
+    this.addSql(
+      `alter table if exists "return_item" alter column "raw_damaged_quantity" type jsonb using ("raw_damaged_quantity"::jsonb);`
+    )
+    this.addSql(
+      `alter table if exists "return_item" alter column "raw_damaged_quantity" set default '{"value":"0","precision":20}';`
+    )
+  }
+
+  override async down(): Promise<void> {
+    this.addSql(`drop index if exists "IDX_order_custom_display_id";`)
+    this.addSql(
+      `alter table if exists "order" drop column if exists "custom_display_id";`
+    )
+
+    this.addSql(
+      `alter table if exists "order_item" alter column "raw_fulfilled_quantity" drop default;`
+    )
+    this.addSql(
+      `alter table if exists "order_item" alter column "raw_fulfilled_quantity" type jsonb using ("raw_fulfilled_quantity"::jsonb);`
+    )
+    this.addSql(
+      `alter table if exists "order_item" alter column "raw_delivered_quantity" drop default;`
+    )
+    this.addSql(
+      `alter table if exists "order_item" alter column "raw_delivered_quantity" type jsonb using ("raw_delivered_quantity"::jsonb);`
+    )
+    this.addSql(
+      `alter table if exists "order_item" alter column "raw_shipped_quantity" drop default;`
+    )
+    this.addSql(
+      `alter table if exists "order_item" alter column "raw_shipped_quantity" type jsonb using ("raw_shipped_quantity"::jsonb);`
+    )
+    this.addSql(
+      `alter table if exists "order_item" alter column "raw_return_requested_quantity" drop default;`
+    )
+    this.addSql(
+      `alter table if exists "order_item" alter column "raw_return_requested_quantity" type jsonb using ("raw_return_requested_quantity"::jsonb);`
+    )
+    this.addSql(
+      `alter table if exists "order_item" alter column "raw_return_received_quantity" drop default;`
+    )
+    this.addSql(
+      `alter table if exists "order_item" alter column "raw_return_received_quantity" type jsonb using ("raw_return_received_quantity"::jsonb);`
+    )
+    this.addSql(
+      `alter table if exists "order_item" alter column "raw_return_dismissed_quantity" drop default;`
+    )
+    this.addSql(
+      `alter table if exists "order_item" alter column "raw_return_dismissed_quantity" type jsonb using ("raw_return_dismissed_quantity"::jsonb);`
+    )
+    this.addSql(
+      `alter table if exists "order_item" alter column "raw_written_off_quantity" drop default;`
+    )
+    this.addSql(
+      `alter table if exists "order_item" alter column "raw_written_off_quantity" type jsonb using ("raw_written_off_quantity"::jsonb);`
+    )
+
+    this.addSql(
+      `alter table if exists "return_item" alter column "raw_received_quantity" drop default;`
+    )
+    this.addSql(
+      `alter table if exists "return_item" alter column "raw_received_quantity" type jsonb using ("raw_received_quantity"::jsonb);`
+    )
+    this.addSql(
+      `alter table if exists "return_item" alter column "raw_damaged_quantity" drop default;`
+    )
+    this.addSql(
+      `alter table if exists "return_item" alter column "raw_damaged_quantity" type jsonb using ("raw_damaged_quantity"::jsonb);`
+    )
+  }
+}

packages/modules/order/src/models/order.ts

@@ -11,6 +11,7 @@ const _Order = model
   .define("Order", {
     id: model.id({ prefix: "order" }).primaryKey(),
     display_id: model.autoincrement().searchable(),
+    custom_display_id: model.text().nullable(),
     region_id: model.text().nullable(),
     customer_id: model.text().nullable(),
     version: model.number().default(1),
@@ -71,6 +72,12 @@ const _Order = model
       unique: false,
       where: "deleted_at IS NULL",
     },
+    {
+      name: "IDX_order_custom_display_id",
+      on: ["custom_display_id"],
+      unique: true,
+      where: "deleted_at IS NULL",
+    },
     {
       name: "IDX_order_region_id",
       on: ["region_id"],

packages/modules/order/src/schema/index.ts

@@ -249,6 +249,8 @@ type Order {
   status: OrderStatus!
   region_id: String
   customer_id: String
+  display_id: String
+  custom_display_id: String
   sales_channel_id: String
   email: String
   currency_code: String!

packages/modules/order/src/services/order-module-service.ts

@@ -7,7 +7,6 @@ import {
   FilterableOrderReturnReasonProps,
   FindConfig,
   InferEntityType,
-  InternalModuleDeclaration,
   IOrderModuleService,
   ModuleJoinerConfig,
   ModulesSdkTypes,
@@ -218,6 +217,14 @@ export default class OrderModuleService
   }>(generateMethodForModels)
   implements IOrderModuleService
 {
+  protected generateCustomDisplayId_: (
+    this: OrderModuleService,
+    order: OrderTypes.CreateOrderDTO,
+    sharedContext: Context
+  ) => Promise<string | undefined> = async () => {
+    return undefined
+  }
+
   protected baseRepository_: DAL.RepositoryService
   protected orderService_: OrderService
   protected orderAddressService_: ModulesSdkTypes.IMedusaInternalService<
@@ -311,7 +318,12 @@ export default class OrderModuleService
       orderExchangeService,
       orderCreditLineService,
     }: InjectedDependencies,
-    protected readonly moduleDeclaration: InternalModuleDeclaration
+    options?: {
+      generateCustomDisplayId?: (
+        order: OrderTypes.CreateOrderDTO,
+        sharedContext: Context
+      ) => Promise<string | undefined>
+    }
   ) {
     // @ts-ignore
     super(...arguments)
@@ -338,6 +350,9 @@ export default class OrderModuleService
     this.orderClaimService_ = orderClaimService
     this.orderExchangeService_ = orderExchangeService
     this.orderCreditLineService_ = orderCreditLineService
+
+    this.generateCustomDisplayId_ =
+      options?.generateCustomDisplayId ?? this.generateCustomDisplayId_
   }
 
   __joinerConfig(): ModuleJoinerConfig {
@@ -740,14 +755,15 @@ export default class OrderModuleService
     const creditLinesToCreate: CreateOrderCreditLineDTO[] = []
     const createdOrders: InferEntityType<typeof Order>[] = []
 
-    for (const {
-      items,
-      shipping_methods,
-      credit_lines,
-      shipping_address,
-      billing_address,
-      ...order
-    } of data) {
+    for (const data_ of data) {
+      const {
+        items,
+        shipping_methods,
+        credit_lines,
+        shipping_address,
+        billing_address,
+        ...order
+      } = data_
       const ord = order as any
 
       const shippingMethods = shipping_methods?.map((sm: any) => {
@@ -777,6 +793,11 @@ export default class OrderModuleService
         totals: calculated.summary,
       }
 
+      ord.custom_display_id = await this.generateCustomDisplayId_.bind(this)(
+        data_,
+        sharedContext
+      )
+
       const created = await this.orderService_.create(ord, sharedContext)
 
       creditLinesToCreate.push(

packages/modules/product/src/migrations/Migration20250911092221.ts

@@ -1,13 +1,13 @@
-import { Migration } from '@mikro-orm/migrations';
+import { Migration } from "@medusajs/framework/mikro-orm/migrations"
 
 export class Migration20250911092221 extends Migration {
-
   override async up(): Promise<void> {
-    this.addSql(`CREATE INDEX IF NOT EXISTS "IDX_product_status" ON "product" (status) WHERE deleted_at IS NULL;`);
+    this.addSql(
+      `CREATE INDEX IF NOT EXISTS "IDX_product_status" ON "product" (status) WHERE deleted_at IS NULL;`
+    )
   }
 
   override async down(): Promise<void> {
-    this.addSql(`drop index if exists "IDX_product_status";`);
+    this.addSql(`drop index if exists "IDX_product_status";`)
   }
-
 }

packages/modules/product/src/migrations/Migration20251011090511.ts

@@ -1,18 +1,15 @@
-import { Migration } from '@mikro-orm/migrations';
+import { Migration } from "@medusajs/framework/mikro-orm/migrations"
 
 export class Migration20251011090511 extends Migration {
-// UP: Fixes the bug by dropping the bad index from product_collection.
+  // UP: Fixes the bug by dropping the bad index from product_collection.
   override async up(): Promise<void> {
-    this.addSql(
-      'DROP INDEX IF EXISTS "IDX_product_category_deleted_at";'
-    );
+    this.addSql('DROP INDEX IF EXISTS "IDX_product_category_deleted_at";')
   }
 
   // DOWN: Reverts the fix by re-creating the original bug.
   override async down(): Promise<void> {
     this.addSql(
       'CREATE INDEX IF NOT EXISTS "IDX_product_category_deleted_at" ON "product_collection" ("deleted_at");'
-    );
+    )
   }
-
 }

packages/modules/promotion/src/migrations/Migration20250917143818.ts

@@ -1,19 +1,25 @@
-import { Migration } from '@mikro-orm/migrations';
+import { Migration } from "@medusajs/framework/mikro-orm/migrations"
 
 export class Migration20250917143818 extends Migration {
-
   override async up(): Promise<void> {
-    this.addSql(`CREATE INDEX IF NOT EXISTS "IDX_promotion_is_automatic" ON "promotion" (is_automatic) WHERE deleted_at IS NULL;`);
+    this.addSql(
+      `CREATE INDEX IF NOT EXISTS "IDX_promotion_is_automatic" ON "promotion" (is_automatic) WHERE deleted_at IS NULL;`
+    )
 
-    this.addSql(`CREATE INDEX IF NOT EXISTS "IDX_promotion_rule_value_rule_id_value" ON "promotion_rule_value" (promotion_rule_id, value) WHERE deleted_at IS NULL;`);
-    this.addSql(`CREATE INDEX IF NOT EXISTS "IDX_promotion_rule_value_value" ON "promotion_rule_value" (value) WHERE deleted_at IS NULL;`);
+    this.addSql(
+      `CREATE INDEX IF NOT EXISTS "IDX_promotion_rule_value_rule_id_value" ON "promotion_rule_value" (promotion_rule_id, value) WHERE deleted_at IS NULL;`
+    )
+    this.addSql(
+      `CREATE INDEX IF NOT EXISTS "IDX_promotion_rule_value_value" ON "promotion_rule_value" (value) WHERE deleted_at IS NULL;`
+    )
   }
 
   override async down(): Promise<void> {
-    this.addSql(`drop index if exists "IDX_promotion_is_automatic";`);
+    this.addSql(`drop index if exists "IDX_promotion_is_automatic";`)
 
-    this.addSql(`drop index if exists "IDX_promotion_rule_value_rule_id_value";`);
-    this.addSql(`drop index if exists "IDX_promotion_rule_value_value";`);
+    this.addSql(
+      `drop index if exists "IDX_promotion_rule_value_rule_id_value";`
+    )
+    this.addSql(`drop index if exists "IDX_promotion_rule_value_value";`)
   }
-
 }

packages/modules/promotion/src/migrations/Migration20250919122137.ts

@@ -1,13 +1,15 @@
-import { Migration } from '@mikro-orm/migrations';
+import { Migration } from "@medusajs/framework/mikro-orm/migrations"
 
 export class Migration20250919122137 extends Migration {
-
   override async up(): Promise<void> {
-    this.addSql(`CREATE INDEX IF NOT EXISTS "IDX_promotion_rule_attribute_operator_id" ON "promotion_rule" (operator, attribute, id) WHERE deleted_at IS NULL;`);
+    this.addSql(
+      `CREATE INDEX IF NOT EXISTS "IDX_promotion_rule_attribute_operator_id" ON "promotion_rule" (operator, attribute, id) WHERE deleted_at IS NULL;`
+    )
   }
 
   override async down(): Promise<void> {
-    this.addSql(`drop index if exists "IDX_promotion_rule_attribute_operator_id";`);
+    this.addSql(
+      `drop index if exists "IDX_promotion_rule_attribute_operator_id";`
+    )
   }
-
 }

packages/modules/promotion/src/migrations/Migration20251006000000.ts

@@ -1,15 +1,21 @@
-import { Migration } from '@mikro-orm/migrations';
+import { Migration } from "@medusajs/framework/mikro-orm/migrations"
 
 export class Migration20251006000000 extends Migration {
-
   override async up(): Promise<void> {
-    this.addSql(`ALTER TABLE "promotion_application_method" DROP CONSTRAINT IF EXISTS "promotion_application_method_allocation_check";`);
-    this.addSql(`ALTER TABLE "promotion_application_method" ADD CONSTRAINT "promotion_application_method_allocation_check" CHECK ("allocation" IN ('each', 'across', 'once'));`);
+    this.addSql(
+      `ALTER TABLE "promotion_application_method" DROP CONSTRAINT IF EXISTS "promotion_application_method_allocation_check";`
+    )
+    this.addSql(
+      `ALTER TABLE "promotion_application_method" ADD CONSTRAINT "promotion_application_method_allocation_check" CHECK ("allocation" IN ('each', 'across', 'once'));`
+    )
   }
 
   override async down(): Promise<void> {
-    this.addSql(`ALTER TABLE "promotion_application_method" DROP CONSTRAINT IF EXISTS "promotion_application_method_allocation_check";`);
-    this.addSql(`ALTER TABLE "promotion_application_method" ADD CONSTRAINT "promotion_application_method_allocation_check" CHECK ("allocation" IN ('each', 'across'));`);
+    this.addSql(
+      `ALTER TABLE "promotion_application_method" DROP CONSTRAINT IF EXISTS "promotion_application_method_allocation_check";`
+    )
+    this.addSql(
+      `ALTER TABLE "promotion_application_method" ADD CONSTRAINT "promotion_application_method_allocation_check" CHECK ("allocation" IN ('each', 'across'));`
+    )
   }
-
 }