@things-factory/operato-hub 4.3.94-alpha.1 → 4.3.96

package/openapi/v1/product.yaml

@@ -1,558 +1,218 @@
 definitions:
-  # AddProduct
-  AddProduct:
+  Product:
     type: 'object'
+    required:
+      - 'sku'
+      - 'name'
+      - 'type'
     properties:
-      data:
+      id:
+        type: 'uuid'
+        example: '4550ba8e-5702-4337-bfa6-5e2718468724'
+      sku:
+        type: 'string'
+        example: 'LB-18'
+        description: 'internal sku code usage or can reuse based on supplier sku code'
+      brandSku:
+        type: 'string'
+        description: 'normally use to reference supplier/brand sku code'
+      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'
+      brand:
+        type: 'string'
+        example: 'COLGATE-PALMOLIVE'
+      subBrand:
+        type: 'string'
+        example: 'COLGATE MINT'
+      isRequiredCheckExpiry:
+        type: 'boolean'
+      pickingStrategy:
+        type: 'string'
+        example: 'FIFO'
+      expirationPeriod:
+        type: 'integer'
+        description: 'value should be in days (eg:300 and half day)'
+        example: 300
+      auxUnit1:
+        type: 'string'
+        description: 'An extra field that is provided for user to set other fields needed to store in product master'
+      auxValue1:
+        type: 'string'
+        description: 'An extra field value that is provided for user to set other fields needed to store in product master'
+      auxUnit2:
+        type: 'string'
+        description: 'An extra field that is provided for user to set other fields needed to store in product master'
+      auxValue2:
+        type: 'string'
+        description: 'An extra field value that is provided for user to set other fields needed to store in product master'
+      auxUnit3:
+        type: 'string'
+        description: 'An extra field that is provided for user to set other fields needed to store in product master'
+      auxValue3:
+        type: 'string'
+        description: 'An extra field value that is provided for user to set other fields needed to store in product master'
+      productDetails:
         type: 'array'
         items:
-          type:
+          type: 'object'
+          required:
+            - 'gtin'
+            - 'packingType'
+            - 'packingSize'
+            - 'uom'
+            - 'uomValue'
           properties:
-            sku:
-              type: 'string'
-              example: 'LB-18'
-            brandSku:
-              type: 'string'
-              example: 'string'
-            name:
+            isDefault:
+              type: 'boolean'
+            gtin:
               type: 'string'
-              example: '50PCS PLASTIC LUNCH BOX'
-            description:
+              description: 'product barcode. fill up with sku code if there is no product barcode'
+            refCode:
               type: 'string'
-              example: 'Lid 5 Compartments HIRO Sekat Disposable Paper Recyclable biodegradable Microwavable'
-            type:
+            packingType:
               type: 'string'
-              example: 'PLASTIC'
-            brand:
+              example: 'CARTON'
+            uom:
               type: 'string'
-              example: 'COLGATE-PALMOLIVE'
-            subBrand:
+              example: 'UNIT'
+            uomValue:
+              type: 'integer'
+              format: 'double'
+              example: 24
+            packingSize:
+              type: 'integer'
+              example: 24
+            costPrice:
+              type: 'integer'
+              format: 'double'
+              example: 12.50
+            minQty:
+              type: 'integer'
+            maxQty:
+              type: 'integer'
+            bufferQty:
+              type: 'integer'
+            movement:
               type: 'string'
-              example: 'COLGATE MINT'
-            isRequiredCheckExpiry:
-              type: 'boolean'
-              example: true
-            isRequireSerialNumberScanning:
-              type: 'boolean'
-              example: true
-            isRequireSerialNumberScanningInbound:
-              type: 'boolean'
-              example: true
-            isRequireSerialNumberScanningOutbound:
-              type: 'boolean'
-              example: true
-            pickingStrategy:
+              example: 'FAST'
+            weightUnit:
               type: 'string'
-              example: 'FIFO'
-            expirationPeriod:
+              example: 'kg'
+            nettWeight:
               type: 'integer'
-              description: 'value should be in days (eg:300 and half day)'
-              example: 300
-            productDetails:
-              type: 'array'
-              items:
-                type: 'object'
-                properties:
-                  isDefault:
-                    type: 'boolean'
-                    example: true
-                  gtin:
-                    type: 'string'
-                    example: 'string'
-                  refCode:
-                    type: 'string'
-                    example: 'string'
-                  packingType:
-                    type: 'string'
-                    example: 'CARTON'
-                  packingSize:
-                    type: 'integer'
-                    format: 'double'
-                    example: 24
-                  uom:
-                    type: 'string'
-                    example: 'UNIT'
-                  uomValue:
-                    type: 'integer'
-                    format: 'double'
-                    example: 24
-                  costPrice:
-                    type: 'integer'
-                    format: 'double'
-                    example: 12.50
-                  minQty:
-                    type: 'integer'
-                    example: 0
-                  maxQty:
-                    type: 'integer'
-                    example: 0
-                  bufferQty:
-                    type: 'integer'
-                    example: 0
-                  movement:
-                    type: 'string'
-                    example: 'normal'
-                  weightUnit:
-                    type: 'string'
-                    example: 'kg'
-                  nettWeight:
-                    type: 'integer'
-                    format: 'double'
-                    example: 20.5
-                  grossWeight:
-                    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: 2
-                  height:
-                    type: 'integer'
-                    forrmat: 'double'
-                    example: 4
-                  volume:
-                    type: 'integer'
-                    format: 'double'
-                    example: 6
-                  auxUnit1:
-                    type: 'string'
-                    example: 'string'
-                  auxValue1:
-                    type: 'string'
-                    example: 'string'
-                  auxUnit2:
-                    type: 'string'
-                    example: 'string'
-                  auxValue2:
-                    type: 'string'
-                    example: 'string'
-                  auxUnit3:
-                    type: 'string'
-                    example: 'string'
-                  auxValue3:
-                    type: 'string'
-                    example: 'string'
-                  auxUnit4:
-                    type: 'string'
-                    example: 'string'
-                  auxValue4:
-                    type: 'string'
-                    example: 'string'
-                  auxUnit5:
-                    type: 'string'
-                    example: 'string'
-                  auxValue5:
-                    type: 'string'
-                    example: 'string'
-                  childProductDetail:
-                    type: 'string'
-                    example: 'string'
-    xml:
-      name: 'AddProduct'
-
-  # GetProductList
-  GetProductList:
-    type: 'object'
-    properties:
-      data:
-        type: 'array'
-        items:
-          type: 'object'
-          properties:
-            sku:
+              format: 'double'
+              example: 20.5
+            lengthUnit:
               type: 'string'
-              example: 'LB-18'
-            brandSku:
+              example: 'cm'
+            width:
+              type: 'integer'
+              format: 'double'
+              example: 10.5
+            depth:
+              type: 'integer'
+              format: 'double'
+              example: 2.00
+            height:
+              type: 'integer'
+              format: 'double'
+              example: 4.00
+            volume:
+              type: 'integer'
+              format: 'double'
+              example: 6.00
+            auxUnit1:
               type: 'string'
-              example: 'string'
-            name:
+              description: 'An extra field that is provided for user to set other fields needed to store in product master'
+            auxValue1:
               type: 'string'
-              example: '50PCS PLASTIC LUNCH BOX'
-            description:
+              description: 'An extra field value that is provided for user to set other fields needed to store in product master'
+            auxUnit2:
               type: 'string'
-              example: 'Lid 5 Compartments HIRO Sekat Disposable Paper Recyclable biodegradable Microwavable'
-            type:
+              description: 'An extra field that is provided for user to set other fields needed to store in product master'
+            auxValue2:
               type: 'string'
-              example: 'PLASTIC'
-            brand:
+              description: 'An extra field value that is provided for user to set other fields needed to store in product master'
+            auxUnit3:
               type: 'string'
-              example: 'COLGATE-PALMOLIVE'
-            subBrand:
+              description: 'An extra field that is provided for user to set other fields needed to store in product master'
+            auxValue3:
               type: 'string'
-              example: 'COLGATE MINT'
-            isRequiredCheckExpiry:
-              type: 'boolean'
-              example: true
-            isRequireSerialNumberScanning:
-              type: 'boolean'
-              example: true
-            isRequireSerialNumberScanningInbound:
-              type: 'boolean'
-              example: true
-            isRequireSerialNumberScanningOutbound:
-              type: 'boolean'
-              example: true
-            pickingStrategy:
+              description: 'An extra field value that is provided for user to set other fields needed to store in product master'
+            childProductDetail:
               type: 'string'
-              example: 'FIFO'
-            expirationPeriod:
-              type: 'integer'
-              example: 300
-            productDetails:
-              type: 'array'
-              items:
-                type: 'object'
-                properties:
-                  isDefault:
-                    type: 'boolean'
-                    example: true
-                  gtin:
-                    type: 'string'
-                    required: true
-                    example: 'string'
-                  refCode:
-                    type: 'string'
-                    example: 'string'
-                  packingType:
-                    type: 'string'
-                    example: 'CARTON'
-                  packingSize:
-                    type: 'integer'
-                    format: 'double'
-                    example: 24
-                  uom:
-                    type: 'string'
-                    example: 'UNIT'
-                  uomValue:
-                    type: 'integer'
-                    format: 'double'
-                    example: 24
-                  costPrice:
-                    type: 'integer'
-                    format: 'double'
-                    example: 12.5
-                  minQty:
-                    type: 'integer'
-                    example: 0
-                  maxQty:
-                    type: 'integer'
-                    example: 0
-                  bufferQty:
-                    type: 'integer'
-                    example: 0
-                  movement:
-                    type: 'string'
-                    example: 'normal'
-                  weightUnit:
-                    type: 'string'
-                    example: 'kg'
-                  nettWeight:
-                    type: 'integer'
-                    format: 'double'
-                    example: 20.5
-                  grossWeight:
-                    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: 2
-                  height:
-                    type: 'integer'
-                    format: 'double'
-                    example: 4
-                  volume:
-                    type: 'integer'
-                    format: 'double'
-                    example: 6
-                  auxUnit1:
-                    type: 'string'
-                    example: 'string'
-                  auxValue1:
-                    type: 'string'
-                    example: 'string'
-                  auxUnit2:
-                    type: 'string'
-                    example: 'string'
-                  auxValue2:
-                    type: 'string'
-                    example: 'string'
-                  auxUnit3:
-                    type: 'string'
-                    example: 'string'
-                  auxValue3:
-                    type: 'string'
-                    example: 'string'
-                  auxUnit4:
-                    type: 'string'
-                    example: 'string'
-                  auxValue4:
-                    type: 'string'
-                    example: 'string'
-                  auxUnit5:
-                    type: 'string'
-                    example: 'string'
-                  auxValue5:
-                    type: 'string'
-                    example: 'string'
-                  childProductDetail:
-                    type: 'string'
-                    example: 'string'
-      totalCount:
-        type: 'integer'
-        example: 1
-      limit:
-        type: 'integer'
-        example: 100
-      offset:
-        type: 'integer'
-        example: 0
+              description: 'Fill in GTIN to link among the product details'
     xml:
-      name: 'GetProductList'
+      name: 'Product'
 
 paths:
-  # add-products
-  /api/v1/company/add-products:
+  /warehouse/{warehouseId}/add-products:
     post:
       tags:
-        - 'Product'
-      summary: 'Add product(s).'
-      description: 'Add multiple product. (From Scope we should be able to determine this is for which company).'
+        - 'product'
+      description: 'Use this call to add single or multiple product item.'
       operationId: 'addProduct'
+      consumes:
+        - 'application/json'
       produces:
         - 'application/json'
       parameters:
+        - in: 'path'
+          name: 'warehouseId'
+          required: true
+          type: 'string'
         - in: 'body'
           name: 'body'
+          description: 'Product object to be added to WMS.'
+          required: true
           schema:
-            type: 'object'
-            properties:
-              data:
-                type: 'array'
-                items:
-                  type: 'object'
-                  require:
-                    - 'sku'
-                    - 'name'
-                    - 'type'
-                    - 'productDetails'
-                  properties:
-                    sku:
-                      type: 'string'
-                      required: true
-                      example: 'LB-18'
-                    brandSku:
-                      type: 'string'
-                      example: 'string'
-                    name:
-                      type: 'string'
-                      required: true
-                      example: '50PCS PLASTIC LUNCH BOX'
-                    description:
-                      type: 'string'
-                      example: 'Lid 5 Compartments HIRO Sekat Disposable Paper Recyclable biodegradable Microwavable'
-                    type:
-                      type: 'string'
-                      required: true
-                      example: 'PLASTIC'
-                    brand:
-                      type: 'string'
-                      example: 'COLGATE-PALMOLIVE'
-                    subBrand:
-                      type: 'string'
-                      example: 'COLGATE MINT'
-                    isRequiredCheckExpiry:
-                      type: 'boolean'
-                      example: true
-                    isRequireSerialNumberScanning:
-                      type: 'boolean'
-                      example: true
-                    isRequireSerialNumberScanningInbound:
-                      type: 'boolean'
-                      example: true
-                    isRequireSerialNumberScanningOutbound:
-                      type: 'boolean'
-                      example: true
-                    pickingStrategy:
-                      type: 'string'
-                      example: 'FIFO'
-                    expirationPeriod:
-                      type: 'integer'
-                      example: 300
-                    productDetails:
-                      type: 'array'
-                      items:
-                        type: 'object'
-                        required:
-                          - 'isDefault'
-                          - 'gtin'
-                          - 'packingType'
-                          - 'packingSize'
-                          - 'uom'
-                          - 'uomValue'
-                        properties:
-                          isDefault:
-                            type: 'boolean'
-                            required: true
-                            example: true
-                          gtin:
-                            type: 'string'
-                            required: true
-                            example: 'string'
-                          refCode:
-                            type: 'string'
-                            example: 'string'
-                          packingType:
-                            type: 'string'
-                            required: true
-                            example: CARTON
-                          packingSize:
-                            type: 'integer'
-                            required: true
-                            example: 24
-                          uom:
-                            type: 'string'
-                            required: true
-                            example: UNIT
-                          uomValue:
-                            type: 'integer'
-                            format: 'double'
-                            required: true
-                            example: 24
-                          costPrice:
-                            type: 'integer'
-                            format: 'double'
-                            example: 12.5
-                          minQty:
-                            type: 'integer'
-                            example: 0
-                          maxQty:
-                            type: 'integer'
-                            example: 0
-                          bufferQty:
-                            type: 'integer'
-                            example: 0
-                          movement:
-                            type: 'string'
-                            example: 'normal'
-                          weightUnit:
-                            type: 'string'
-                            example: 'kg'
-                          nettWeight:
-                            type: 'integer'
-                            format: 'double'
-                            example: 20.5
-                          grossWeight:
-                            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: 2
-                          height:
-                            type: 'integer'
-                            format: 'double'
-                            example: 4
-                          volume:
-                            type: 'integer'
-                            format: 'double'
-                            example: 6
-                          auxUnit1:
-                            type: 'string'
-                            example: 'string'
-                          auxValue1:
-                            type: 'string'
-                            example: 'string'
-                          auxUnit2:
-                            type: 'string'
-                            example: 'string'
-                          auxValue2:
-                            type: 'string'
-                            example: 'string'
-                          auxUnit3:
-                            type: 'string'
-                            example: 'string'
-                          auxValue3:
-                            type: 'string'
-                            example: 'string'
-                          auxUnit4:
-                            type: 'string'
-                            example: 'string'
-                          auxValue4:
-                            type: 'string'
-                            example: 'string'
-                          auxUnit5:
-                            type: 'string'
-                            example: 'string'
-                          auxValue5:
-                            type: 'string'
-                            example: 'string'
-                          childProductDetail:
-                            type: 'string'
-                            example: 'string'
+            type: 'array'
+            items:
+              $ref: '#/definitions/Product'
       responses:
-        '200':
-          description: 'success'
-          content:
-            application/json:
-              schema:
-                type: 'array'
-                items:
-                  $ref: '#/definitions/AddProduct'
-  # get-product-list
-  /api/v1/company/get-product-list:
+        '400':
+          description: 'Bad request is sent'
+        '401':
+          description: 'Authentication Error'
+        '404':
+          description: 'Resource not found'
+        '500':
+          description: 'Server error'
+  /warehouse/{warehouseId}/get-products:
     get:
       tags:
-        - 'Product'
-      summary: 'Get list of product(s)'
-      description: 'Get list of product. Specify bizplace that is within this company.'
-      operationId: 'getContactPoint'
+        - 'product'
+      description: 'Use this API to get a list of products from wms.'
+      operationId: 'getProduct'
       consumes:
         - 'application/json'
       produces:
         - 'application/json'
       parameters:
-        - in: 'query'
-          name: 'bizplaceId'
-          type: 'string'
-          description: 'Required to specify the bizplace to search.'
+        - in: 'path'
+          name: 'warehouseId'
           required: true
+          type: 'string'
         - in: 'query'
           name: 'skuId'
           type: 'string'
         - in: 'query'
-          name: 'limit'
+          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.'
           type: 'integer'
-          default: 100
-          max: 100
+          format: 'uint32'
         - in: 'query'
-          name: 'offset'
+          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.'
           type: 'integer'
-          default: 0
+          format: 'uint32'
       responses:
         '200':
           description: 'successful operation'
@@ -561,4 +221,12 @@ paths:
               schema:
                 type: 'array'
                 items:
-                  $ref: '#/definitions/GetProductList'
+                  $ref: '#/definitions/Product'
+        '400':
+          description: 'Bad request is sent'
+        '401':
+          description: 'Authentication Error'
+        '404':
+          description: 'Resource not found'
+        '500':
+          description: 'Server error'