@things-factory/operato-hub 4.3.79-alpha.0 → 4.3.80-alpha.0

package/openapi/v1/inbound.yaml

@@ -1,308 +1,652 @@
 definitions:
-  GRN:
+# AddInboundOrder
+  AddInboundOrder:
+    type: 'object'
+    properties: 
+      data: 
+        type: 'object'
+        properties:
+          id: 
+            type: 'string'
+            example: 1d61cd39-f9de-4a28-8d24-981e6ea5c626
+          ganNo: 
+            type: 'string'
+            example: 'xxxxxxx'
+          refNo: 
+            type: 'string'
+            example: 'reference doc 1'
+          refNo2: 
+            type: 'string'
+            example: 'reference doc 2'
+          refNo3: 
+            type: 'string'
+            example: 'reference doc 3'
+          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'
+          orderProducts: 
+            type: 'object'
+            properties: 
+              product:
+                type: 'object'
+                properties:
+                  sku: 
+                    type: 'string' 
+                    example: '00F8Y6'
+                  uom: 
+                    type: 'string' 
+                    example: 'UNIT'
+                  uomValue: 
+                    type: 'integer' 
+                    format: 'double'
+                    example: 24      
+              batchId: 
+                type: 'string' 
+                example: 'batch no 1'
+              packingType: 
+                type: 'string' 
+                example: 'CARTON'
+              packingSize: 
+                type: 'integer' 
+                example: 24
+              packQty: 
+                type: 'integer' 
+                example: 1
+              palletQty: 
+                type: 'integer' 
+                example: 1
+          supplier: 
+            type: 'object'
+            properties: 
+              name: 
+                type: 'string'
+                example: 'Supplier A'
+              companyName: 
+                type: 'string'
+                example: 'Supplier Company A'
+              email: 
+                type: 'string'
+                example: 'email@companyA.com'
+              accountNo: 
+                type: 'string'
+                example: 'COMPANY-ACODE'
+    xml:
+      name: 'AddInboundOrder'
+
+# CancelInboundOrder
+  CancelInboundOrder:
+    type: 'object'
+    properties: 
+      data:
+        type: 'object'
+        properties:
+          ganNo: 
+            type: 'string'
+            example: 'xxxxx'
+    xml:
+      name: 'CancelInboundOrder'
+
+# GetInboundOrderList
+  GetInboundOrderList:
     type: 'object'
     properties:
-      result:
+      data: 
         type: 'object'
         properties:
-          goodsReceivalNotes:
+          id: 
+            type: 'string'
+            example: '1d61cd39-f9de-4a28-8d24-981e6ea5c626'
+          ganNo:
+            type: 'string'
+            example: 'xxxxxx'
+          refNo:
+            type: 'string'
+            example: 'reference doc 1'
+          refNo2:
+            type: 'string'
+            example: 'reference doc 2'
+          refNo3: 
+            type: 'string'
+            example: 'reference doc 3'
+          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'
+          orderProducts: 
             type: 'object'
             properties:
-              items:
-                type: 'array'
-                items:
-                  type: 'object'
-                  properties:
-                    id:
-                      type: 'string'
-                      example: '7347f0de-127d-473a-a103-00a086dd67be'
-                    name:
-                      type: 'string'
-                      example: 'GRN-2022225847648'
-                    refNo:
-                      type: 'string'
-                      example: 'GAN-202222571720651'
-                    description:
-                      type: 'string'
-                      example: null
-                    customerStatus:
-                      type: 'string'
-                      example: null
-                    status:
-                      type: 'string'
-                      example: 'PENDING_RECEIVE'
-                    domain:
-                      type: 'object'
-                      properties:
-                        id:
-                          type: 'string'
-                          example: 'df6dba81-6029-4f95-96ff-748570dc2f4e'
-                        name:
-                          type: 'string'
-                          example: 'ABC Warehouse'
-                    arrivalNotice:
-                      type: 'object'
-                      properties:
-                        id:
-                          type: 'string'
-                          example: '33db4bbe-f652-440b-9c36-13af627d3989'
-                        name:
-                          type: 'string'
-                          example: 'GAN-202222572720659'
-                        description:
-                          type: 'string'
-                          example: null
-                        status:
-                          type: 'string'
-                          example: 'DONE'
-                        refNo:
-                          type: 'string'
-                          example: 'ABC Transportation - 3 Ton'
-                        refNo2:
-                          type: 'string'
-                          example: 'Loose'
-                        refNo3:
-                          type: 'string'
-                          example: null
-                        orderProducts:
-                          type: 'object'
-                          properties:
-                            id:
-                              type: 'string'
-                              example: 'b6e18590-4876-4cf4-87af-3c53f7c623d1'
-                            type:
-                              type: 'string'
-                              example: null
-                            batchId:
-                              type: 'string'
-                              example: '-'
-                            packingType:
-                              type: 'string'
-                              example: 'CARTON'
-                            packingSize:
-                              type: 'number'
-                              example: 24
-                            releaseQty:
-                              type: 'number'
-                              example: null
-                            releaseUomValue:
-                              type: 'number'
-                              example: null
-                            status:
-                              type: 'string'
-                              example: 'ACTIVE'
-                    bizplace:
-                      type: 'object'
-                      properties:
-                        id:
-                          type: 'string'
-                          example: 'b60feaf2-1940-40cd-9c53-9e9ac072049d'
-                        name:
-                          type: 'string'
-                          example: 'ABC E-commerce'
-                        description:
-                          type: 'string'
-                          example: ''
-                    attachments:
-                      type: 'string'
-                      example: ''
-                    createdAt:
-                      type: 'number'
-                      example: 1645750026391
-                    updatedAt:
-                      type: 'number'
-                      example: 1645750026391
-                    updater:
-                      type: 'object'
-                      properties:
-                        id:
-                          type: 'string'
-                          example: '2ce54c66-436a-40cf-a042-24d032c28ceb'
-                        name:
-                          type: 'string'
-                          example: 'Ee Chern Hao'
-                        description:
-                          type: 'string'
-                          example: null
-              total:
-                type: 'number'
-                example: 12
+              products:
+                type: 'object'
+                properties: 
+                  sku: 
+                    type: 'string'
+                    example: '00F8Y6'
+                  uom: 
+                    type: 'string'
+                    example: 'UNIT'
+                  uomValue: 
+                    type: 'integer'
+                    format: 'double'
+                    example: 24      
+              batchId: 
+                type: 'string'
+                example: 'batch no 1'
+              packingType: 
+                type: 'string'
+                example: 'CARTON'
+              packingSize: 
+                type: 'integer'
+                example: 24
+              packQty: 
+                type: 'integer'
+                example: 1
+              palletQty: 
+                type: 'integer'
+                example: 1
+          supplier: 
+            type: 'object'
+            properties:
+              name: 
+                type: 'string'
+                example: 'Supplier A'
+              companyName: 
+                type: 'string'
+                example: 'Supplier Company A'
+              email: 
+                type: 'string'
+                example: 'email@companyA.com'
+              accountNo: 
+                type: 'string'
+                example: 'COMPANY-ACODE'
+      totalCount: 
+        type: 'integer'
+        example: 35
+      limit: 
+        type: 'integer'
+        example: 100
+      offset: 
+        type: 'integer'
+        example: 0
     xml:
-      name: 'GRN'
-  Inbound:
+      name: 'GetInboundOrderList'
+
+# GetInboundOrderDetails
+  GetInboundOrderDetails:
     type: 'object'
-    required:
-      - 'etaDate'
-      - 'orderProducts'
     properties:
-      refNo:
-        type: 'string'
-        example: 'reference doc 1'
-      refNo2:
-        type: 'string'
-        example: 'reference doc 2'
-      refNo3:
-        type: 'string'
-        example: 'reference doc 3'
-      etaDate:
-        type: 'string'
-        example: '2019-10-31'
-      ownTransport:
-        type: 'boolean'
-        default: false
-      importCargo:
-        type: 'boolean'
-        default: false
-      container:
-        type: 'boolean'
-        default: false
-      truckNo:
-        type: 'string'
-        example: 'ANN1020'
-      deliveryOrderNo:
-        type: 'string'
-        example: 'DO1905739'
-      containerNo:
-        type: 'string'
-        example: 'TEM10203'
-      containerSize:
-        type: 'string'
-        example: '5 tonnes'
-      orderProducts:
-        type: 'array'
-        items:
-          type: 'object'
-          required:
-            - 'sku'
-            - 'packingType'
-            - 'batchId'
-            - 'packQty'
-          properties:
-            products:
-              type: 'object'
-              properties:
-                sku:
-                  type: 'string'
-                  example: '00F8Y6'
-                uom:
-                  type: 'string'
-                  example: 'UNIT'
-                uomValue:
-                  type: 'number'
-                  format: 'float'
-                  minimum: 24
-            batchId:
-              type: 'string'
-              description: 'set as dash if no value'
-              example: 'batch no 1'
-            packingType:
-              type: 'string'
-              example: 'CARTON'
-            packingSize:
-              type: 'integer'
-              description: 'default value is 1'
-              example: 24
-            packQty:
-              type: 'integer'
-              minimum: 1.0
-              format: 'int32'
-            palletQty:
-              type: 'integer'
-              minimum: 1.0
-              format: 'int32'
-      supplier:
+      data:
         type: 'object'
-        required:
-          - 'name'
-          - 'companyName'
-          - 'email'
-          - 'accountNo'
-        properties:
-          name:
+        properties: 
+          id: 
+            type: 'string'
+            example: '1d61cd39-f9de-4a28-8d24-981e6ea5c626'
+          ganNo: 
+            type: 'string'
+            example: 'xxxxxx'
+          refNo: 
+            type: 'string'
+            example: 'reference doc 1'
+          refNo2: 
             type: 'string'
-            example: 'Supplier A'
-          companyName:
+            example: 'reference doc 2'
+          refNo3: 
             type: 'string'
-            example: 'Supplier Company A'
-          email:
+            example: 'reference doc 3'
+          etaDate: 
             type: 'string'
-            example: 'email@companyA.com'
-          accountNo:
+            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'
+          orderProducts:
+            type: 'object'
+            properties: 
+              products:
+                type: 'object'
+                properties: 
+                  sku: 
+                    type: 'string'
+                    example: '00F8Y6'
+                  uom: 
+                    type: 'string'
+                    example: 'UNIT'
+                  uomValue: 
+                    type: 'integer'
+                    format: 'double'
+                    example: 24      
+              batchId: 
+                type: 'string'
+                example: 'batch no 1'
+              packingType: 
+                type: 'string'
+                example: 'CARTON'
+              packingSize: 
+                type: 'integer'
+                example: 24
+              packQty: 
+                type: 'integer'
+                example: 1
+              palletQty: 
+                type: 'integer'
+                example: 1
+          supplier:
+            type: 'object'
+            properties:  
+              name: 
+                type: 'string'
+                example: 'Supplier A'
+              companyName: 
+                type: 'string'
+                example: 'Supplier Company A'
+              email: 
+                type: 'string'
+                example: 'email@companyA.com'
+              accountNo: 
+                type: 'string'
+                example: 'COMPANY-ACODE'
+    xml:
+      name: 'GetInboundOrderDetails'
+
+# GetGoodsReceivedNoteList
+  GetGoodsReceivedNoteList:
+    type: 'object'
+    properties:
+      data:
+        type: 'object'
+        properties:
+          id: 
+            type: 'string' 
+            example: '7347f0de-127d-473a-a103-00a086dd67be'
+          grnNo: 
+            type: 'string' 
+            example: 'GRN-2022225847648'
+          refNo: 
+            type: 'string' 
+            example: 'GAN-202222571720651'
+          customerStatus: 
+            type: 'string' 
+            example: 'string'
+          status: 
+            type: 'string' 
+            example: 'PENDING_RECEIVE'
+          bizplace:
+            type: 'object'
+            properties: 
+              id: 
+                type: 'string' 
+                example: 'b60feaf2-1940-40cd-9c53-9e9ac072049d'
+              name: 
+                type: 'string' 
+                example: 'ABC E-commerce'
+              description: 
+                type: 'string' 
+                example: 'string'
+          domain:
+            type: 'object'
+            properties: 
+              id: 
+                type: 'string'
+                example: 'df6dba81-6029-4f95-96ff-748570dc2f4e'
+              name: 
+                type: 'string'
+                example: 'ABC Warehouse'
+          arrivalNotice: 
+            type: 'object'
+            properties:
+              id: 
+                type: 'string'
+                example: '33db4bbe-f652-440b-9c36-13af627d3989'
+              ganNo: 
+                type: 'string'
+                example: 'GAN-202222572720659'
+              status: 
+                type: 'string'
+                example: DONE
+              refNo: 
+                type: 'string'
+                example: 'ABC Transportation - 3 Ton'
+              refNo2: 
+                type: 'string'
+                example: 'Loose'
+              refNo3: 
+                type: 'string'
+                example: 'string'
+              orderProducts:
+                type: 'object'
+                properties: 
+                  product:
+                    type: 'object'
+                    properties: 
+                      sku: 
+                        type: 'string'
+                        example: 'string'
+                      brandSku: 
+                        type: 'string'
+                        example: 'string'
+                      name: 
+                        type: 'string'
+                        example: 'string'
+                      description: 
+                        type: 'string'
+                        example: 'string'
+                  type: 
+                    type: 'string'
+                    example: 'string'
+                  batchId: 
+                    type: 'string'
+                    example: 'string'
+                  packingType: 
+                    type: 'string'
+                    example: 'CARTON'
+                  packingSize: 
+                    type: 'integer'
+                    example: 24
+                  releaseQty: 
+                    type: 'integer'
+                    example: 1
+                  releaseUomValue: 
+                    type: 'integer'
+                    format: 'double'
+                    example: 1
+                  status: 
+                    type: 'string'
+                    example: 'ACTIVE'
+          attachments: 
             type: 'string'
-            example: 'COMPANY-ACODE'
+            example: 'string'
+      totalCount: 
+        type: 'integer'
+        example: 35
+      limit: 
+        type: 'integer'
+        example: 100
+      offset: 
+        type: 'integer'
+        example: 0
     xml:
-      name: 'Inbound'
+      name: 'GetGoodsReceivedNoteList'
+
 
 paths:
-  /warehouse/{warehouseId}/add-inbound-order:
+  # add-inbound-order
+  api/v1/warehouse/add-inbound-order:         
     post:
       tags:
-        - 'inbound'
-      description: 'Use this API to create inbound order in WMS.'
+        - 'Inbound'
+      summary: 'Add inbound order(s).'
+      description: 'Add Inbound Order.'
       operationId: 'addInboundOrder'
       produces:
         - 'application/json'
       parameters:
-        - in: 'path'
-          name: 'warehouseId'
-          required: true
-          type: 'string'
         - in: 'body'
           name: 'body'
-          description: 'Inbound order object to be added to WMS.'
-          required: true
-          schema:
-            $ref: '#/definitions/Inbound'
+          schema: 
+            type: 'object'
+            properties:
+              data: 
+                type: 'object'
+                required:
+                  - 'bizplaceId'
+                  - 'etaDate'
+                  - 'orderProducts'
+                properties:
+                  bizplaceId: 
+                    type: 'string'
+                    example: 'ed2cd631-ac50-44aa-b798-6567d7acde63'
+                    required: true
+                  refNo: 
+                    type: 'string'
+                    example: 'reference doc 1'
+                  refNo2: 
+                    type: 'string'
+                    example: 'reference doc 2'
+                  refNo3: 
+                    type: 'string'
+                    example: 'reference doc 3'
+                  etaDate: 
+                    type: 'string'
+                    example: '2019-10-31'
+                    required: true
+                  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 //compulsory when container is true'
+                  containerSize: 
+                    type: 'string'
+                    example: '5 tonnes //compulsory when container is true'
+                  orderProducts: 
+                    type: 'object'
+                    required: 
+                      - 'product'
+                      - 'batchId'
+                      - 'packQty'
+                    properties:
+                      product:
+                        type: 'object'
+                        required:
+                          - 'sku'
+                        properties: 
+                          sku: 
+                            type: 'string'
+                            example : '00F8Y6'
+                          refCode:
+                            type: 'string'
+                            example : 'string' 
+                          uom: 
+                            type: 'string'
+                            example : 'UNIT'
+                          uomValue: 
+                            type: 'integer'
+                            format: 'double'
+                            example : 24
+                      batchId: 
+                        type: 'string'
+                        example: 'batch no 1'
+                        required: true
+                      packingType: 
+                        type: 'string'
+                        example: 'CARTON'
+                      packingSize: 
+                        type: 'integer'
+                        example: 24
+                      packQty: 
+                        type: 'integer'
+                        example: 1
+                        required: true
+                      palletQty: 
+                        type: 'integer'
+                        example: 1
+                  supplier:
+                    type: 'object'
+                    required: 
+                      - 'name'
+                      - 'companyName'
+                      - 'email'
+                      - 'accountNo'
+                    properties:
+                      name: 
+                        type: 'string' 
+                        example: 'Supplier A'
+                        required: true 
+                      companyName: 
+                        type: 'string' 
+                        example: 'Supplier Company A'
+                        required: true
+                      email: 
+                        type: 'string' 
+                        example: 'email@companyA.com'
+                        required: true
+                      accountNo: 
+                        type: 'string' 
+                        example: 'COMPANY-ACODE'
+                        required: true
       responses:
         '200':
-          description: 'successful operation'
+          description: 'success'
+          content:
+            application/json:
+              schema:
+                type: 'array'
+                items:
+                  $ref: '#/definitions/AddInboundOrder'
+
+  # cancel-inbound-order
+  api/v1/warehouse/cancel-inbound-order:         
+    post:
+      tags:
+        - 'Inbound'
+      summary: 'Cancel inbound order(s).'
+      description: 'Cancel Inbound Order.'
+      operationId: 'cancelInboundOrder'
+      produces:
+        - 'application/json'
+      parameters:
+        - in: 'body'
+          name: 'body'
+          schema: 
+            type: 'object'
+            properties:
+              data:
+                type: 'object'
+                properties:
+                  bizplaceId: 
+                    type: 'string' 
+                    example: 'ed2cd631-ac50-44aa-b798-6567d7acde63'
+                    required: true
+                  ganNo: 
+                    type: 'string' 
+                    example: 'xxxxx'
+                    required: true
+                  remark: 
+                    type: 'string' 
+                    example: 'reference reference'
+                    required: true      
+      responses:
+        '200':
+          description: 'success'
           content:
             application/json:
               schema:
-                $ref: '#/definitions/Inbound'
-        '400':
-          description: 'Bad request is sent'
-        '401':
-          description: 'Authentication Error'
-        '404':
-          description: 'Resource not found'
-        '500':
-          description: 'Server error'
-      deprecated: false
-  /warehouse/{warehouseId}/get-inbound-order-list:
+                type: 'array'
+                items:
+                  $ref: '#/definitions/CancelInboundOrder'
+
+  # get-inbound-order-list
+  api/v1/warehouse/get-inbound-order-list: 
     get:
       tags:
-        - 'inbound'
-      description: 'Use this API to get inbound order from WMS.'
+        - 'Inbound'
+      summary: 'Get list of inbound order.'
+      description: 'Get list of Inbound Order.'
       operationId: 'getInboundOrderList'
+      consumes:
+        - 'application/json'
       produces:
         - 'application/json'
       parameters:
-        - in: 'path'
-          name: 'warehouseId'
+        - in: 'query'
+          name: 'bizplaceId'
+          type: 'string'
           required: true
+        - in: 'query'
+          name: 'ganNo'
           type: 'string'
         - in: 'query'
           name: 'status'
           type: 'string'
         - in: 'query'
           name: 'fromDate'
-          required: false
           type: 'string'
+          description: '(Must use in conjunction with “toDate”) ISO 8601 format in UTC time eg: 2022-07-25T03:40:04Z'
+          default: '7 days before current datetime.'
         - in: 'query'
           name: 'toDate'
-          required: false
           type: 'string'
+          description: '(Must use in conjunction with “fromDate”) ISO 8601 format in UTC time eg: 2022-07-25T03:40:04Z'
+          default: 'Current datetime.'
         - in: 'query'
-          name: 'paginationEntriesPerPage'
-          description: 'This integer value is used to specify the maximum number of entries to return in a single "page" of data. Max entries per page is 100.'
+          name: 'limit'
           type: 'integer'
-          format: 'uint32'
+          default: 100
+          max: 100
         - in: 'query'
-          name: 'paginationOffset'
-          description: 'Specifies the starting entry of data to return in the current call. Default is 1. if data is more than one page, the offset can be some entry to start next call.'
+          name: 'offset'
           type: 'integer'
-          format: 'uint32'
+          default: 0
       responses:
         '200':
           description: 'successful operation'
@@ -311,95 +655,81 @@ paths:
               schema:
                 type: 'array'
                 items:
-                  $ref: '#/definitions/Inbound'
-        '400':
-          description: 'Bad request is sent'
-        '401':
-          description: 'Authentication Error'
-        '404':
-          description: 'Resource not found'
-        '500':
-          description: 'Server error'
-      deprecated: false
-  /warehouse/{warehouseId}/get-inbound-order-detail:
+                  $ref: '#/definitions/GetInboundOrderList'
+
+  # get-inbound-order-details
+  api/v1/warehouse/get-inbound-order-details: 
     get:
       tags:
-        - 'inbound'
-      description: 'Use this API to get single inbound order detail from WMS.'
-      operationId: 'getInboundOrderDetail'
+        - 'Inbound'
+      summary: 'Get inbound order details.'
+      description: 'Get Inbound Order Details.'
+      operationId: 'getInboundOrderDetails'
+      consumes:
+        - 'application/json'
       produces:
         - 'application/json'
       parameters:
-        - in: 'path'
-          name: 'warehouseId'
-          required: true
+        - in: 'query'
+          name: 'bizplaceId'
           type: 'string'
-        - name: 'ganNo'
-          in: 'query'
-          description: 'The specific inbound order no (arrival notice no).'
           required: true
+        - in: 'query'
+          name: 'ganNo'
           type: 'string'
+          required: true
       responses:
         '200':
           description: 'successful operation'
           content:
             application/json:
               schema:
-                $ref: '#/definitions/Inbound'
-        '400':
-          description: 'Bad request is sent'
-        '401':
-          description: 'Authentication Error'
-        '404':
-          description: 'Resource not found'
-        '500':
-          description: 'Server error'
-      deprecated: false
-  /warehouse/{warehouseId}/get-goods-received-note:
+                type: 'array'
+                items:
+                  $ref: '#/definitions/GetInboundOrderDetails'
+
+  # get-goods-received-note-list
+  api/v1/warehouse/get-goods-received-note-list: 
     get:
       tags:
-        - 'inbound'
-      description: 'Use this API to get a list of goods receival notes from WMS.'
-      operationId: 'getGoodsReceivedNote'
+        - 'Inbound'
+      summary: 'Get goods received note list(s).'
+      description: 'Get Goods Received Note List.'
+      operationId: 'getGoodsReceivedNoteList'
+      consumes:
+        - 'application/json'
       produces:
         - 'application/json'
       parameters:
-        - in: 'path'
-          name: 'warehouseId'
-          required: true
+        - in: 'query'
+          name: 'bizplaceId'
           type: 'string'
-        - name: 'fromDate'
-          in: 'query'
           required: true
+        - in: 'query'
+          name: 'fromDate'
           type: 'string'
-        - name: 'toDate'
-          in: 'query'
-          description: 'Maximum date range is 1 month'
-          required: true
+          description: '(Must use in conjunction with “toDate”) ISO 8601 format in UTC time eg: 2022-07-25T03:40:04Z'
+          default: '7 days before current datetime.'
+        - in: 'query'
+          name: 'toDate'
           type: 'string'
-        - name: 'limit'
-          in: 'query'
-          default: 10
-          required: false
-          type: 'number'
-        - name: 'page'
-          in: 'query'
-          default: 1
-          required: false
-          type: 'number'
+          description: '(Must use in conjunction with “fromDate”) ISO 8601 format in UTC time eg: 2022-07-25T03:40:04Z'
+          default: 'Current datetime.'
+        - in: 'query'
+          name: 'limit'
+          type: 'integer'
+          default: 100
+          max: 100
+        - in: 'query'
+          name: 'offset'
+          type: 'integer'
+          default: 0
       responses:
         '200':
           description: 'successful operation'
           content:
             application/json:
               schema:
-                $ref: '#/definitions/GRN'
-        '400':
-          description: 'Bad request is sent'
-        '401':
-          description: 'Authentication Error'
-        '404':
-          description: 'Resource not found'
-        '500':
-          description: 'Server error'
-      deprecated: false
+                type: 'array'
+                items:
+                  $ref: '#/definitions/GetGoodsReceivedNoteList'