@things-factory/operato-hub 4.3.744 → 4.3.746

package/openapi/v1/outbound.yaml

@@ -240,45 +240,59 @@ definitions:
   UpdateReleaseOrderDetails:
     type: 'object'
     properties:
+      responseCode:
+        type: 'string'
+        example: '200'
+      message:
+        type: 'string'
+        example: 'success'
       data:
         type: 'object'
         properties:
           id:
             type: 'string'
+            description: 'Release order UUID'
             example: '1d61cd39-f9de-4a28-8d24-981e6ea5c626'
           roNo:
             type: 'string'
-            example: 'xxxxx'
-          collectionOrderNo:
+            description: 'Release order number'
+            example: 'RO-20240115001'
+          refOrderId:
             type: 'string'
-            example: 'string'
+            description: 'Reference order ID'
+            example: 'ORDER-12345'
           refNo:
             type: 'string'
-            example: 'string'
+            description: 'Reference number 1'
+            example: 'reference doc 1'
           refNo2:
             type: 'string'
-            example: 'string'
+            description: 'Reference number 2'
+            example: 'reference doc 2'
           refNo3:
             type: 'string'
-            example: 'string'
-          refOrderId:
+            description: 'Reference number 3'
+            example: 'reference doc 3'
+          description:
             type: 'string'
-            example: 'string'
+            description: 'Order description'
+            example: 'Order description'
           marketplaceOrderStatus:
             type: 'string'
-            example: 'string'
+            description: 'Marketplace order status'
+            example: 'Ready To Ship'
           billingAddress:
             type: 'string'
-            example: 'string'
-          deliveryAddress1:
+            description: 'Billing address'
+            example: '36 Jalan Kerongsang 2 Bandar Puteri KlangSelangor Klang 41200 Malaysia'
+          deliveryAddress:
             type: 'string'
-            example: 'string'
+            description: 'Delivery address'
+            example: '36 Jalan Kerongsang 2'
           attentionTo:
             type: 'string'
-            example: 'string'
-          ward:
-            type: 'string'
-            example: 'string'
+            description: 'Attention to'
+            example: 'Annie'
           city:
             type: 'string'
             example: 'string'
@@ -291,7 +305,7 @@ definitions:
           postalCode:
             type: 'string'
             example: 'string'
-          phone1:
+          phone:
             type: 'string'
             example: 'string'
           transporter:
@@ -306,6 +320,43 @@ definitions:
           invoice:
             type: 'string'
             example: 'string'
+          truckNo:
+            type: 'string'
+            description: 'Truck number'
+            example: 'TRUCK-12345'
+          collectionOrderNo:
+            type: 'string'
+            description: 'Collection order number'
+            example: 'CO-001'
+          releaseDate:
+            type: 'string'
+            format: 'date'
+            description: 'Release date'
+            example: '2024-02-15'
+          ownTransport:
+            type: 'boolean'
+            description: 'Whether using own transport'
+            example: false
+          exportOption:
+            type: 'boolean'
+            description: 'Whether it is export order'
+            example: false
+          packingOption:
+            type: 'boolean'
+            description: 'Whether packing is required'
+            example: false
+          courierOption:
+            type: 'boolean'
+            description: 'Whether courier is required'
+            example: false
+          status:
+            type: 'string'
+            description: 'Current status of the release order'
+            example: 'PENDING_RECEIVE'
+          remark:
+            type: 'string'
+            description: 'Remarks'
+            example: 'Additional notes'
           shippingOrder:
             type: 'object'
             properties:
@@ -3289,8 +3340,18 @@ paths:
     post:
       tags:
         - 'Outbound'
-      summary: 'Update release order details.'
-      description: 'Update Release Order Details'
+      summary: 'Update Release Order Details.'
+      description: |
+        Update release order information and manage order products (add, update quantity, remove items).
+
+        **Status Restrictions:**
+        - **Order Information Updates** (refNo, refNo2, refNo3, description, etc.) are allowed when status is: PENDING, PENDING_RECEIVE, PENDING_WORKSHEET, READY_TO_PICK, PICKING, READY_TO_LOAD, LOADING, READY_TO_PACK, or PACKING.
+        - **Order Product Updates** (add, update, remove items) are only allowed when status is: PENDING, PENDING_RECEIVE, PENDING_WORKSHEET, or READY_TO_PICK.
+
+        **Order Product Matching:**
+        - To update an existing item, provide matching fields: id, sku, refCode, batchId, packingType, or refItemId
+        - To add a new item, provide product information (sku or refCode) without matching existing items
+        - To remove an item, set _action: 'remove' with matching fields
       operationId: 'updateReleaseOrderDetails'
       produces:
         - 'application/json'
@@ -3303,121 +3364,281 @@ paths:
               data:
                 type: 'object'
                 required:
-                  - 'releaseGood'
+                  - bizplaceId
+                  - releaseGood
                 properties:
                   bizplaceId:
                     type: 'string'
-                    example: "ed2cd631-ac50-44aa-b798-6567d7acde63'(MANDATORY)"
-                    required: true
+                    description: 'UUID of the bizplace/warehouse'
+                    example: 'ed2cd631-ac50-44aa-b798-6567d7acde63'
                   releaseGood:
                     type: 'object'
                     required:
-                      - 'bizplaceId'
-                      - 'roId'
+                      - roId
                     properties:
                       roId:
                         type: 'string'
-                        example: "1d61cd39-f9de-4a28-8d24-981e6ea5c626'(MANDATORY)"
-                        required: true
+                        description: 'UUID of the release order. Alternatively, use refOrderId.'
+                        example: '1d61cd39-f9de-4a28-8d24-981e6ea5c626'
+                      refOrderId:
+                        type: 'string'
+                        description: 'Reference order ID. Alternative to roId.'
+                        example: 'ORDER-12345'
                       collectionOrderNo:
                         type: 'string'
-                        example: "string'(MANDATORY)"
+                        description: 'Collection order number'
+                        example: 'CO-001'
                       refNo:
                         type: 'string'
-                        example: "string'(MANDATORY)"
+                        description: 'Reference number 1'
+                        example: 'reference doc 1'
                       refNo2:
                         type: 'string'
-                        example: "string'(MANDATORY)"
+                        description: 'Reference number 2'
+                        example: 'reference doc 2'
                       refNo3:
                         type: 'string'
-                        example: "string'(MANDATORY)"
-                      refOrderId:
-                        type: 'string'
-                        example: "string'(MANDATORY)"
+                        description: 'Reference number 3'
+                        example: 'reference doc 3'
                       marketplaceOrderStatus:
                         type: 'string'
-                        example: "string'(MANDATORY)"
-                      billingAddress:
-                        type: 'string'
-                        example: "string'(MANDATORY)"
+                        description: 'Marketplace order status'
+                        example: 'ready_to_ship'
                       deliveryAddress1:
                         type: 'string'
-                        example: "string'(MANDATORY)"
+                        description: 'Delivery address line 1'
+                        example: '123 Main St'
                       attentionTo:
                         type: 'string'
-                        example: "string'(MANDATORY)"
-                      ward:
-                        type: 'string'
-                        example: "PHƯỜNG HÀNG BUỒM'(MANDATORY)"
+                        description: 'Attention to'
+                        example: 'John Doe'
                       city:
                         type: 'string'
-                        example: "string'(MANDATORY)"
+                        description: 'City'
+                        example: 'Kuala Lumpur'
                       district:
                         type: 'string'
-                        example: "string'(MANDATORY)"
+                        description: 'District'
+                        example: 'Petaling'
                       country:
                         type: 'string'
-                        example: "string'(MANDATORY)"
+                        description: 'Country'
+                        example: 'MY'
                       postalCode:
                         type: 'string'
-                        example: "string'(MANDATORY)"
+                        description: 'Postal code'
+                        example: '50000'
                       phone1:
                         type: 'string'
-                        example: "string'(MANDATORY)"
+                        description: 'Phone number 1'
+                        example: '60123456789'
                       transporter:
                         type: 'string'
-                        example: "string'(MANDATORY)"
+                        description: 'Transporter'
+                        example: 'DHL'
                       trackingNo:
                         type: 'string'
-                        example: "string'(MANDATORY)"
+                        description: 'Tracking number'
+                        example: 'TRACK-12345'
                       airwayBill:
                         type: 'string'
-                        example: "string'(MANDATORY)"
+                        description: 'Url to airwayBill'
+                        example: 'http://example.com/airwaybill.pdf'
                       invoice:
                         type: 'string'
-                        example: "string'(MANDATORY)"
+                        description: 'Url to invoice'
+                        example: 'http://example.com/invoice.pdf'
+                      description:
+                        type: 'string'
+                        description: 'Description'
+                        example: 'Order description'
+                      truckNo:
+                        type: 'string'
+                        description: 'Truck number'
+                        example: 'TRUCK-12345'
+                      collectionOrderNo:
+                        type: 'string'
+                        description: 'Collection order number'
+                        example: 'CO-001'
+                      releaseDate:
+                        type: 'string'
+                        format: 'date'
+                        description: 'Release date'
+                        example: '2024-02-15'
+                      ownTransport:
+                        type: 'boolean'
+                        description: 'Whether using own transport'
+                        example: false
+                      exportOption:
+                        type: 'boolean'
+                        description: 'Whether it is export order'
+                        example: false
+                      packingOption:
+                        type: 'boolean'
+                        description: 'Whether packing is required'
+                        example: false
+                      courierOption:
+                        type: 'boolean'
+                        description: 'Whether courier is required'
+                        example: false
+                      remark:
+                        type: 'string'
+                        description: 'Remarks'
+                        example: 'Additional notes'
                   shippingOrder:
                     type: 'object'
-                    required:
-                      - 'shipName'
-                      - 'containerNo'
-                      - 'containerArrivalDate'
-                      - 'containerLeavingDate'
+                    description: 'Shipping order information'
                     properties:
-                      shipName:
-                        type: 'string'
-                        example: "string'(MANDATORY)"
-                        required: true
                       containerNo:
                         type: 'string'
-                        example: "string'(MANDATORY)"
-                        required: true
-                      loadType:
+                        description: 'Container number'
+                        example: 'CONT-001'
+                      containerArrivalDate:
                         type: 'string'
-                        example: "string'(MANDATORY)"
-                      from:
+                        format: 'date'
+                        description: 'Container arrival date'
+                        example: '2024-02-15'
+                      containerLeavingDate:
                         type: 'string'
-                        example: 'string'
-                      to:
+                        format: 'date'
+                        description: 'Container leaving date'
+                        example: '2024-02-20'
+                      containerClosureDate:
                         type: 'string'
-                        example: 'string'
-                      containerArrivalDate:
+                        format: 'date'
+                        description: 'Container closure date'
+                        example: '2024-02-18'
+                      containerSize:
                         type: 'string'
-                        example: "2020-02-14'(MANDATORY)"
-                        required: true
-                      containerLeavingDate:
+                        description: 'Container size'
+                        example: '20ft'
+                      exportRemark:
                         type: 'string'
-                        example: "2020-02-14'(MANDATORY)"
-                        required: true
+                        description: 'Export remarks (mapped to remark)'
+                        example: 'Export notes'
+                  orderProducts:
+                    type: 'array'
+                    description: 'Array of order products to add, update, or remove. Only allowed when release order status is PENDING, PENDING_RECEIVE, PENDING_WORKSHEET, or READY_TO_PICK.'
+                    items:
+                      type: 'object'
+                      properties:
+                        id:
+                          type: 'string'
+                          description: 'Order product ID (optional - for matching existing items)'
+                          example: 'uuid2669-646f-42a0-8364-56f670fuuid'
+                        product:
+                          type: 'object'
+                          description: 'Product information (required for new items, optional for updates)'
+                          properties:
+                            sku:
+                              type: 'string'
+                              description: 'Product SKU'
+                              example: 'SKU-001'
+                            refCode:
+                              type: 'string'
+                              description: 'Product reference code'
+                              example: 'REF-001'
+                        sku:
+                          type: 'string'
+                          description: 'Product SKU'
+                          example: 'SKU-001'
+                        refCode:
+                          type: 'string'
+                          description: 'Product reference code'
+                          example: 'REF-001'
+                        batchId:
+                          type: 'string'
+                          description: 'Batch ID'
+                          example: 'BATCH-001'
+                        packingType:
+                          type: 'string'
+                          description: 'Packing type'
+                          example: 'CARTON'
+                        packingSize:
+                          type: 'integer'
+                          description: 'Packing size (for new items)'
+                          example: 24
+                        releaseQty:
+                          type: 'number'
+                          description: 'Quantity to update (for updates) or add (for new items). Must be greater than 0.'
+                          example: 10
+                        qty:
+                          type: 'number'
+                          description: 'Alternative to releaseQty'
+                          example: 10
+                        refItemId:
+                          type: 'string'
+                          description: 'Reference item ID (for matching or new items)'
+                          example: 'REF-12345'
+                        unitPrice:
+                          type: 'number'
+                          description: 'Unit price'
+                          example: 100.50
+                        remark:
+                          type: 'string'
+                          description: 'Item remark'
+                          example: 'Item remark'
+                        _action:
+                          type: 'string'
+                          description: 'Set to "remove" to delete this item. Provide matching fields (id, sku, refCode, batchId, packingType, or refItemId) along with this field.'
+                          enum:
+                            - 'remove'
+                          example: 'remove'
       responses:
         '200':
           description: 'success'
           content:
             application/json:
               schema:
-                type: 'array'
-                items:
-                  $ref: '#/definitions/UpdateReleaseOrderDetails'
+                $ref: '#/definitions/UpdateReleaseOrderDetails'
+        '400':
+          description: 'Bad request - validation error'
+          content:
+            application/json:
+              schema:
+                type: 'object'
+                properties:
+                  error:
+                    type: 'object'
+                    properties:
+                      code:
+                        type: 'string'
+                        example: 'E01'
+                      message:
+                        type: 'string'
+                        example: 'warehouse id not found'
+        '404':
+          description: 'Not found - release order not found or status not allowed for updates'
+          content:
+            application/json:
+              schema:
+                type: 'object'
+                properties:
+                  error:
+                    type: 'object'
+                    properties:
+                      code:
+                        type: 'string'
+                        example: 'E04'
+                      message:
+                        type: 'string'
+                        example: 'Release order status "DONE" does not allow updates. Allowed statuses: PENDING, PENDING_RECEIVE, PENDING_WORKSHEET, READY_TO_PICK, PICKING, READY_TO_LOAD, LOADING, READY_TO_PACK, PACKING'
+        '500':
+          description: 'Internal server error'
+          content:
+            application/json:
+              schema:
+                type: 'object'
+                properties:
+                  error:
+                    type: 'object'
+                    properties:
+                      code:
+                        type: 'string'
+                        example: 'INTERNAL_SERVER_ERROR'
+                      message:
+                        type: 'string'
+                        example: 'An unexpected error occurred'
 
   # get-release-order-list
   api/v1/warehouse/get-release-order-list:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@things-factory/operato-hub",
-  "version": "4.3.744",
+  "version": "4.3.746",
   "main": "dist-server/index.js",
   "browser": "client/index.js",
   "things-factory": true,
@@ -60,8 +60,8 @@
     "@things-factory/attachment-base": "^4.3.743",
     "@things-factory/auth-base": "^4.3.743",
     "@things-factory/auth-ui": "^4.3.743",
-    "@things-factory/biz-base": "^4.3.743",
-    "@things-factory/biz-ui": "^4.3.743",
+    "@things-factory/biz-base": "^4.3.745",
+    "@things-factory/biz-ui": "^4.3.745",
     "@things-factory/board-service": "^4.3.743",
     "@things-factory/board-ui": "^4.3.743",
     "@things-factory/code-ui": "^4.3.743",
@@ -77,22 +77,22 @@
     "@things-factory/i18n-base": "^4.3.743",
     "@things-factory/import-ui": "^4.3.743",
     "@things-factory/import-ui-excel": "^4.3.743",
-    "@things-factory/integration-accounting": "^4.3.743",
-    "@things-factory/integration-fulfillment": "^4.3.743",
-    "@things-factory/integration-lmd": "^4.3.743",
-    "@things-factory/integration-marketplace": "^4.3.743",
-    "@things-factory/integration-pos": "^4.3.743",
-    "@things-factory/integration-powrup": "^4.3.743",
-    "@things-factory/integration-sellercraft": "^4.3.743",
-    "@things-factory/integration-sftp": "^4.3.743",
+    "@things-factory/integration-accounting": "^4.3.745",
+    "@things-factory/integration-fulfillment": "^4.3.745",
+    "@things-factory/integration-lmd": "^4.3.745",
+    "@things-factory/integration-marketplace": "^4.3.745",
+    "@things-factory/integration-pos": "^4.3.745",
+    "@things-factory/integration-powrup": "^4.3.745",
+    "@things-factory/integration-sellercraft": "^4.3.745",
+    "@things-factory/integration-sftp": "^4.3.745",
     "@things-factory/lite-menu": "^4.3.743",
-    "@things-factory/marketplace-base": "^4.3.743",
+    "@things-factory/marketplace-base": "^4.3.745",
     "@things-factory/more-ui": "^4.3.743",
     "@things-factory/notification": "^4.3.743",
     "@things-factory/pdf": "^4.3.743",
-    "@things-factory/product-ui": "^4.3.743",
+    "@things-factory/product-ui": "^4.3.745",
     "@things-factory/resource-ui": "^4.3.743",
-    "@things-factory/sales-base": "^4.3.743",
+    "@things-factory/sales-base": "^4.3.745",
     "@things-factory/scene-data-transform": "^4.3.743",
     "@things-factory/scene-excel": "^4.3.743",
     "@things-factory/scene-firebase": "^4.3.743",
@@ -107,9 +107,9 @@
     "@things-factory/setting-ui": "^4.3.743",
     "@things-factory/shell": "^4.3.743",
     "@things-factory/system-ui": "^4.3.743",
-    "@things-factory/transport-base": "^4.3.743",
-    "@things-factory/warehouse-base": "^4.3.743",
-    "@things-factory/worksheet-base": "^4.3.744",
+    "@things-factory/transport-base": "^4.3.745",
+    "@things-factory/warehouse-base": "^4.3.745",
+    "@things-factory/worksheet-base": "^4.3.745",
     "cron-parser": "^4.7.0",
     "koa2-swagger-ui": "^5.0.2",
     "swagger-jsdoc": "^5.0.0",
@@ -122,5 +122,5 @@
   "resolutions": {
     "core-js": "^3.16.0"
   },
-  "gitHead": "1519990fa45b1edfdfa52b0ac3748b841fb18afd"
+  "gitHead": "6895d09e02b72d5adfac4ea120bef1ae7981a60a"
 }