@things-factory/operato-hub 4.3.103 → 4.3.105-alpha.0

package/openapi/v1/inventory.yaml

@@ -1,167 +1,215 @@
 definitions:
-  Inventory:
+  # GetOnhandInventoryList
+  GetOnhandInventoryList:
     type: 'object'
     properties:
-      id:
+      data:
+        type: 'array'
+        items:
+          type: 'object'
+          properties:
+            id:
+              type: 'string'
+              example: 'b60feaf2-1940-40cd-9c53-9e9ac072049d'
+            name:
+              type: 'string'
+              example: 'string'
+            palletId:
+              type: 'string'
+              example: 'string'
+            cartonId:
+              type: 'string'
+              example: 'string'
+            batchId:
+              type: 'string'
+              example: 'string'
+            packingType:
+              type: 'string'
+              example: 'string'
+            packingSize:
+              type: 'string'
+              example: 'string'
+            qty:
+              type: 'integer'
+              example: 0
+            expirationDate:
+              type: 'date'
+              example: ' '
+            weight:
+              type: 'integer'
+              format: 'double'
+              example: 0
+            lastSeq:
+              type: 'integer'
+              format: 'double'
+              example: 0
+            status:
+              type: 'string'
+              example: 'STORED'
+            product:
+              type: 'object'
+              properties:
+                sku:
+                  type: 'string'
+                  example: 'LB-18'
+                name:
+                  type: 'string'
+                  example: '50PCS PLASTIC LUNCH BOX'
+                description:
+                  type: 'string'
+                  example: 'Lid 5 Compartments HIRO Sekat Disposable Paper Recyclable biodegradable Microwavable'
+                type:
+                  type: 'string'
+                  example: 'PLASTIC'
+                weightUnit:
+                  type: 'string'
+                  example: 'kg'
+                weight:
+                  type: 'integer'
+                  format: 'double'
+                  example: 20.5
+                lengthUnit:
+                  type: 'string'
+                  example: 'cm'
+                width:
+                  type: 'integer'
+                  format: 'double'
+                  example: 10.5
+                depth:
+                  type: 'integer'
+                  format: 'double'
+                  example: 5
+                height:
+                  type: 'integer'
+                  format: 'double'
+                  example: 6
+            location:
+              type: 'object'
+              properties:
+                name:
+                  type: 'string'
+                  example: '01-01-01-A'
+                type:
+                  type: 'string'
+                  example: 'SHELF'
+                zone:
+                  type: 'string'
+                  example: '05'
+      totalCount:
         type: 'integer'
-        format: 'int64'
-      name:
-        type: 'string'
-      palletId:
-        type: 'string'
-      cartonId:
-        type: 'string'
-      batchId:
-        type: 'string'
-      packingType:
-        type: 'string'
-      packingSize:
-        type: 'string'
-      zone:
-        type: 'string'
-        example: '05'
-        description: 'zone location'
-      qty:
+        example: 35
+      limit:
         type: 'integer'
-      expirationDate:
-        type: 'date'
-      weight:
+        example: 100
+      offset:
         type: 'integer'
-        format: 'float'
-      lastSeq:
-        type: 'integer'
-      status:
-        type: 'string'
-        enum:
-          - 'STORED'
-          - 'TERMINATED'
-      product:
-        type: 'object'
-        properties:
-          sku:
-            type: 'string'
-            example: 'LB-18'
-            description: 'value should be unique for all variations'
-          name:
-            type: 'string'
-            example: '50PCS PLASTIC LUNCH BOX'
-          description:
-            type: 'string'
-            example: 'Lid 5 Compartments HIRO Sekat Disposable Paper Recyclable biodegradable Microwavable'
-          type:
-            type: 'string'
-            example: 'PLASTIC'
-          packingType:
-            type: 'string'
-            example: 'CARTON'
-          weightUnit:
-            type: 'string'
-            example: 'kg'
-          weight:
-            type: 'integer'
-            format: 'double'
-            example: '20.5'
-          lengthUnit:
-            type: 'string'
-            example: 'cm'
-          width:
-            type: 'integer'
-            format: 'double'
-            example: '10.5'
-          depth:
-            type: 'integer'
-            format: 'double'
-            example: '5'
-          height:
-            type: 'integer'
-            format: 'double'
-            example: '6'
-      location:
-        type: 'object'
-        properties:
-          name:
-            type: 'string'
-            example: '01-01-01-A'
-          type:
-            type: 'string'
-            example: 'SHELF'
+        example: 0
     xml:
-      name: 'Inventory'
-  InventoryProductGroup:
+      name: 'GetOnhandInventoryList'
+
+  # GetInventoryProductGroupList
+  GetInventoryProductGroupList:
     type: 'object'
     properties:
-      batchId:
-        type: 'string'
-      packingType:
-        type: 'string'
-      packingSize:
-        type: 'string'
-      qty:
+      data:
+        type: 'array'
+        items:
+          type: 'object'
+          properties:
+            product:
+              type: 'object'
+              properties:
+                sku:
+                  type: 'string'
+                  example: 'LB-18'
+                name:
+                  type: 'string'
+                  example: 'LB-18'
+                description:
+                  type: 'string'
+                  example: 'LB-18'
+                type:
+                  type: 'string'
+                  example: 'SINGLE    '
+            batchId:
+              type: 'string'
+              example: 'string'
+            packingType:
+              type: 'string'
+              example: 'string'
+            packingSize:
+              type: 'integer'
+              format: 'double'
+              example: 24
+            qty:
+              type: 'integer'
+              example: 0
+            uomValue:
+              type: 'integer'
+              format: 'double'
+              example: 0
+            uom:
+              type: 'string'
+              example: 'UNIT'
+            averageUnitCost:
+              type: 'integer'
+              format: 'double'
+              example: 24
+      totalCount:
+        type: 'integer'
+        example: 35
+      limit:
+        type: 'integer'
+        example: 100
+      offset:
         type: 'integer'
-      averageUnitCost:
-        type: 'float'
-        example: 24
-      product:
-        type: 'object'
-        properties:
-          productSku:
-            type: 'string'
-            example: 'LB-18'
-            description: 'value should be unique for all variations'
-          batchId:
-            type: 'string'
-          type:
-            type: 'string'
-            example: 'PLASTIC'
-          packingType:
-            type: 'string'
-            example: 'CARTON'
-          packingSize:
-            type: 'integer'
-            example: 24
-          remainQty:
-            type: 'float'
-            example: 24
-          remainUomValue:
-            type: 'float'
-            example: 24
-          uom:
-            type: 'string'
-            example: 'UNIT'
+        example: 0
     xml:
-      name: 'InventoryProductGroup'
+      name: 'GetInventoryProductGroupList'
+
 paths:
-  /warehouse/{warehouseId}/onhand-inventories:
+  # get-onhand-inventory-list
+  api/v1/warehouse/get-onhand-inventory-list:
     get:
       tags:
-        - 'inventory'
-      description: 'Use this API to get current onhand inventories from a specific company.'
-      operationId: 'onhandInventories'
+        - 'Inventory'
+      summary: 'Get onhand inventory list.'
+      description: 'Get Onhand Inventory List.'
+      operationId: 'getOnhandInventoryList'
+      consumes:
+        - 'application/json'
       produces:
         - 'application/json'
       parameters:
-        - in: 'path'
-          name: 'warehouseId'
-          required: true
+        - in: 'query'
+          name: 'bizplaceId'
           type: 'string'
-        - name: 'skuId'
-          in: 'query'
           required: true
+        - in: 'query'
+          name: 'sku'
           type: 'string'
-        - name: 'batchId'
-          in: 'query'
-          required: true
+        - in: 'query'
+          name: 'batchId'
+          type: 'string'
+        - in: 'query'
+          name: 'fromDate'
+          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'
           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'
@@ -170,62 +218,46 @@ paths:
               schema:
                 type: 'array'
                 items:
-                  $ref: '#/definitions/Inventory'
-        '400':
-          description: 'Bad request is sent'
-        '401':
-          description: 'Authentication Error'
-        '404':
-          description: 'Resource not found'
-        '500':
-          description: 'Server error'
-      deprecated: false
-  /warehouse/{warehouseId}/get-inventory-product-group:
+                  $ref: '#/definitions/GetOnhandInventoryList'
+
+  # get-inventory-product-group-list
+  api/v1/warehouse/get-inventory-product-group-list:
     get:
       tags:
-        - 'inventory'
-      description: 'Use this API to get current inventories by product group from a specific company.'
-      operationId: 'getInventoryProductGroup'
+        - 'Inventory'
+      summary: 'Get inventory product group list.'
+      description: 'Get Inventory Product Group List.'
+      operationId: 'getInventoryProductGroupList'
+      consumes:
+        - 'application/json'
       produces:
         - 'application/json'
       parameters:
-        - in: 'path'
-          name: 'warehouseId'
-          required: true
+        - in: 'query'
+          name: 'bizplaceId'
           type: 'string'
-        - name: 'skuId'
-          in: 'query'
-          required: false
+          required: true
+        - in: 'query'
+          name: 'sku'
           type: 'string'
-        - name: 'batchId'
-          in: 'query'
-          required: false
+        - in: 'query'
+          name: 'batchId'
           type: 'string'
         - 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'
+          description: 'successful operation'
           content:
             application/json:
               schema:
                 type: 'array'
                 items:
-                  $ref: '#/definitions/InventoryProductGroup'
-        '400':
-          description: 'Bad request is sent'
-        '401':
-          description: 'Authentication Error'
-        '404':
-          description: 'Resource not found'
-        '500':
-          description: 'Server error'
-      deprecated: false
+                  $ref: '#/definitions/GetInventoryProductGroupList'