@things-factory/operato-hub 4.3.744 → 4.3.745

package/openapi/v1/inbound.yaml

@@ -708,6 +708,137 @@ definitions:
     xml:
       name: 'UpdateGANtoARRIVED'
 
+  # UpdateArrivalNotice
+  UpdateArrivalNotice:
+    type: 'object'
+    properties:
+      responseCode:
+        type: 'string'
+        example: '200'
+      message:
+        type: 'string'
+        example: 'success'
+      data:
+        type: 'object'
+        properties:
+          id:
+            type: 'string'
+            example: '1d61cd39-f9de-4a28-8d24-981e6ea5c626'
+          ganNo:
+            type: 'string'
+            example: 'GAN-20240115001'
+          refNo:
+            type: 'string'
+            example: 'reference doc 1'
+          refNo2:
+            type: 'string'
+            example: 'reference doc 2'
+          refNo3:
+            type: 'string'
+            example: 'reference doc 3'
+          status:
+            type: 'string'
+            example: 'PENDING_RECEIVE'
+            description: 'Current status of the arrival notice. Updates are only allowed when status is PENDING, PENDING_RECEIVE, INTRANSIT, ARRIVED, or READY_TO_UNLOAD.'
+          etaDate:
+            type: 'string'
+            example: '2019-10-31'
+          ownTransport:
+            type: 'boolean'
+            example: false
+          importCargo:
+            type: 'boolean'
+            example: false
+          container:
+            type: 'boolean'
+            example: false
+          truckNo:
+            type: 'string'
+            example: 'ANN1020'
+          deliveryOrderNo:
+            type: 'string'
+            example: 'DO1905739'
+          containerNo:
+            type: 'string'
+            example: 'TEM10203'
+          containerSize:
+            type: 'string'
+            example: '5 tonnes'
+          remark:
+            type: 'string'
+            example: 'Additional notes'
+          description:
+            type: 'string'
+            example: 'Order description'
+          orderProducts:
+            type: 'array'
+            items:
+              type: 'object'
+              properties:
+                id:
+                  type: 'string'
+                  example: 'uuid2669-646f-42a0-8364-56f670fuuid'
+                product:
+                  type: 'object'
+                  properties:
+                    name:
+                      type: 'string'
+                      example: 'Product Name'
+                    sku:
+                      type: 'string'
+                      example: '00F8Y6'
+                batchId:
+                  type: 'string'
+                  example: 'batch no 1'
+                packingType:
+                  type: 'string'
+                  example: 'CARTON'
+                packingSize:
+                  type: 'integer'
+                  example: 24
+                qty:
+                  type: 'number'
+                  example: 10
+                palletQty:
+                  type: 'number'
+                  example: 1
+                uom:
+                  type: 'string'
+                  example: 'UNIT'
+                uomValue:
+                  type: 'number'
+                  example: 24.23
+                refItemId:
+                  type: 'string'
+                  example: 'ref item id'
+                unitPrice:
+                  type: 'number'
+                  example: 100.50
+                manufactureDate:
+                  type: 'string'
+                  example: '2024-01-15'
+                remark:
+                  type: 'string'
+                  example: 'Item remark'
+          supplier:
+            type: 'object'
+            nullable: true
+            properties:
+              id:
+                type: 'string'
+                example: 'uuid2669-646f-42a0-8364-56f670fuuid'
+              name:
+                type: 'string'
+                example: 'Supplier A'
+              email:
+                type: 'string'
+                example: 'email@companyA.com'
+              phone:
+                type: 'string'
+                example: '012-3456789'
+    xml:
+      name: 'UpdateArrivalNotice'
+
 paths:
   # add-inbound-order
 
@@ -1089,3 +1220,221 @@ paths:
                 type: 'array'
                 items:
                   $ref: '#/definitions/UpdateGANtoARRIVED'
+
+  # update-arrival-notice
+  api/v1/warehouse/update-arrival-notice:
+    post:
+      tags:
+        - 'Inbound'
+      summary: 'Update Arrival Notice.'
+      description: |
+        Update arrival notice information and manage order products (add, update quantity, remove items). 
+        Updates are only allowed when arrival notice status is: PENDING, PENDING_RECEIVE, INTRANSIT, ARRIVED, or READY_TO_UNLOAD.
+
+        **Order Product Matching:**
+        - To update an existing item, provide matching fields: id, sku, batchId, packingType, or refItemId
+        - To add a new item, provide product information without matching existing items
+        - To remove an item, set _action: 'remove' with matching fields
+      operationId: 'updateArrivalNotice'
+      produces:
+        - 'application/json'
+      parameters:
+        - in: 'body'
+          name: 'body'
+          schema:
+            type: 'object'
+            required:
+              - data
+            properties:
+              data:
+                type: 'object'
+                required:
+                  - arrivalNoticeId
+                properties:
+                  arrivalNoticeId:
+                    type: 'string'
+                    description: 'UUID of the arrival notice. Alternatively, use ganNo.'
+                    example: '1d61cd39-f9de-4a28-8d24-981e6ea5c626'
+                  ganNo:
+                    type: 'string'
+                    description: 'GAN number of the arrival notice. Alternative to arrivalNoticeId.'
+                    example: 'GAN-20240115001'
+                  refNo:
+                    type: 'string'
+                    description: 'Reference number 1 (optional - only update if provided)'
+                    example: 'reference doc 1'
+                  refNo2:
+                    type: 'string'
+                    description: 'Reference number 2 (optional - only update if provided)'
+                    example: 'reference doc 2'
+                  refNo3:
+                    type: 'string'
+                    description: 'Reference number 3 (optional - only update if provided)'
+                    example: 'reference doc 3'
+                  etaDate:
+                    type: 'string'
+                    description: 'Estimated time of arrival date (optional - only update if provided)'
+                    example: '2019-10-31'
+                  ownTransport:
+                    type: 'boolean'
+                    description: 'Whether using own transport (optional - only update if provided)'
+                    example: false
+                  importCargo:
+                    type: 'boolean'
+                    description: 'Whether it is import cargo (optional - only update if provided)'
+                    example: false
+                  container:
+                    type: 'boolean'
+                    description: 'Whether using container (optional - only update if provided)'
+                    example: false
+                  containerNo:
+                    type: 'string'
+                    description: 'Container number (optional - only update if provided)'
+                    example: 'TEM10203'
+                  containerSize:
+                    type: 'string'
+                    description: 'Container size (optional - only update if provided)'
+                    example: '5 tonnes'
+                  truckNo:
+                    type: 'string'
+                    description: 'Truck number (optional - only update if provided)'
+                    example: 'ANN1020'
+                  deliveryOrderNo:
+                    type: 'string'
+                    description: 'Delivery order number (optional - only update if provided)'
+                    example: 'DO1905739'
+                  remark:
+                    type: 'string'
+                    description: 'Remarks (optional - only update if provided)'
+                    example: 'Additional notes'
+                  description:
+                    type: 'string'
+                    description: 'Description (optional - only update if provided)'
+                    example: 'Order description'
+                  supplierId:
+                    type: 'string'
+                    description: 'Supplier contact point ID. Set to null to remove supplier. (optional - only update if provided)'
+                    example: '69a462c5-9a58-4a61-915d-7ef4c31c8937'
+                  orderProducts:
+                    type: 'array'
+                    description: 'Array of order products to add, update, or remove'
+                    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 (for matching or new items)'
+                              example: '00F8Y6'
+                            refCode:
+                              type: 'string'
+                              description: 'Product reference code (alternative to SKU)'
+                              example: 'REF-001'
+                        sku:
+                          type: 'string'
+                          description: 'Product SKU (alternative to product.sku)'
+                          example: '00F8Y6'
+                        batchId:
+                          type: 'string'
+                          description: 'Batch ID (for matching or new items)'
+                          example: 'batch no 1'
+                        packingType:
+                          type: 'string'
+                          description: 'Packing type (for matching or new items)'
+                          example: 'CARTON'
+                        packingSize:
+                          type: 'integer'
+                          description: 'Packing size (for new items)'
+                          example: 24
+                        qty:
+                          type: 'number'
+                          description: 'Quantity to update (for updates) or add (for new items). Must be greater than 0.'
+                          example: 10
+                        packQty:
+                          type: 'number'
+                          description: 'Alternative to qty'
+                          example: 10
+                        refItemId:
+                          type: 'string'
+                          description: 'Reference item ID (for matching or new items)'
+                          example: 'ref item id'
+                        unitPrice:
+                          type: 'number'
+                          description: 'Unit price (optional - only update if provided)'
+                          example: 100.50
+                        manufactureDate:
+                          type: 'string'
+                          description: 'Manufacture date (optional - only update if provided)'
+                          example: '2024-01-15'
+                        remark:
+                          type: 'string'
+                          description: 'Item remark (optional - only update if provided)'
+                          example: 'Item remark'
+                        _action:
+                          type: 'string'
+                          description: 'Set to "remove" to delete this item. Provide matching fields (id, sku, batchId, packingType, or refItemId) along with this field.'
+                          enum:
+                            - 'remove'
+                          example: 'remove'
+      responses:
+        '200':
+          description: 'success'
+          content:
+            application/json:
+              schema:
+                $ref: '#/definitions/UpdateArrivalNotice'
+        '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: 'arrivalNoticeId or ganNo is required'
+        '404':
+          description: 'Not found - arrival notice 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: 'Arrival notice not found: GAN-20240115001'
+        '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'