Pretty order numbers

packages/medusa-plugin-brightpearl/src/services/brightpearl.js

@@ -374,7 +374,7 @@ class BrightpearlService extends BaseService {
       currency: {
         code: fromOrder.currency_code,
       },
-      ref: fromOrder._id,
+      ref: fromOrder.display_id,
       externalRef: fromOrder._id,
       channelId: this.options.channel_id || `1`,
       installedIntegrationInstanceId: authData.installation_instance_id,

packages/medusa/src/loaders/defaults.js

@@ -1,4 +1,5 @@
 export default async ({ container }) => {
+  const counterService = container.resolve("counterService")
   const storeService = container.resolve("storeService")
   const profileService = container.resolve("shippingProfileService")
 
@@ -23,6 +24,7 @@ export default async ({ container }) => {
     payment_providers: payIds,
   })
 
+  await counterService.createDefaults()
   await profileService.createDefault()
   await profileService.createGiftCardDefault()
 }

packages/medusa/src/models/counter.js

@@ -0,0 +1,13 @@
+import mongoose from "mongoose"
+import { BaseModel } from "medusa-interfaces"
+
+class CounterModel extends BaseModel {
+  static modelName = "Counter"
+
+  static schema = {
+    _id: String,
+    next: Number,
+  }
+}
+
+export default CounterModel

packages/medusa/src/models/order.js

@@ -15,6 +15,7 @@ class OrderModel extends BaseModel {
   static modelName = "Order"
 
   static schema = {
+    display_id: { type: String, required: true, unique: true },
     // pending, completed, archived, cancelled
     status: { type: String, default: "pending" },
     // not_fulfilled, partially_fulfilled (some line items have been returned), fulfilled, returned,

packages/medusa/src/services/counter.js

@@ -0,0 +1,33 @@
+import _ from "lodash"
+import { Validator, MedusaError } from "medusa-core-utils"
+import { BaseService } from "medusa-interfaces"
+
+/**
+ * Provides layer to manipulate carts.
+ * @implements BaseService
+ */
+class CounterService extends BaseService {
+  constructor({ counterModel }) {
+    super()
+
+    /** @private @const {CartModel} */
+    this.counterModel_ = counterModel
+  }
+
+  async createDefaults() {
+    const orderCounter = await this.counterModel_.findOne({ _id: "orders" })
+    if (!orderCounter) {
+      await this.counterModel_.create({ _id: "orders", next: 1000 })
+    }
+  }
+
+  async getNext(id) {
+    const counter = await this.counterModel_.updateOne(
+      { _id: id },
+      { $inc: { next: 1 } }
+    )
+    return counter.next
+  }
+}
+
+export default CounterService

packages/medusa/src/services/order.js

@@ -17,6 +17,7 @@ class OrderService extends BaseService {
 
   constructor({
     orderModel,
+    counterService,
     paymentProviderService,
     shippingProfileService,
     discountService,
@@ -54,6 +55,8 @@ class OrderService extends BaseService {
 
     /** @private @const {EventBus} */
     this.eventBus_ = eventBusService
+
+    this.counterService_ = counterService
   }
 
   /**
@@ -343,6 +346,7 @@ class OrderService extends BaseService {
         )
 
         const o = {
+          display_id: await this.counterService_.getNext("orders"),
           payment_method: {
             provider_id: paymentSession.provider_id,
             data: paymentData,
@@ -789,8 +793,8 @@ class OrderService extends BaseService {
         }
         return {
           ...i,
-          returned_quantity: returnedQuantity
+          returned_quantity: returnedQuantity,
-          returned
+          returned,
         }
       } else {
         if (!i.returned) {