@things-factory/operato-hub 4.3.189 → 4.3.191

package/openapi/v1/marketplace.yaml

@@ -446,6 +446,32 @@ paths:
                   paymentMethod:
                     type: 'string'
                     example: 'string'
+                  paymentStatus:
+                    type: 'string'
+                    example: 'string'
+                  payTime:
+                    type: 'datetime'
+                    example: '2021-01-14T14:32:15Z'
+                  totalAmount:
+                    type: 'integer'
+                    format: 'double'
+                    example: 0.00
+                  commissionFee:
+                    type: 'integer'
+                    format: 'double'
+                    example: 0.00
+                  serviceFee:
+                    type: 'integer'
+                    format: 'double'
+                    example: 0.00
+                  transactionFee:
+                    type: 'integer'
+                    format: 'double'
+                    example: 0.00
+                  platformFee:
+                    type: 'integer'
+                    format: 'double'
+                    example: 0.00
                   remark:
                     type: 'string'
                     example: 'string'
@@ -479,6 +505,42 @@ paths:
                         cancelBy:
                           type: 'string'
                           example: 'string'
+                        paidPrice:
+                          type: 'integer'
+                          format: 'double'
+                          example: 0.00
+                        originalPrice:
+                          type: 'integer'
+                          format: 'double'
+                          example: 0.00
+                        paymentFee:
+                          type: 'integer'
+                          format: 'double'
+                          example: 0.00
+                        commissionFee:
+                          type: 'integer'
+                          format: 'double'
+                          example: 0.00
+                        platformFee:
+                          type: 'integer'
+                          format: 'double'
+                          example: 0.00
+                        shippingFeePaidByCustomer:
+                          type: 'integer'
+                          format: 'double'
+                          example: 0.00
+                        promotionalCharges:
+                          type: 'integer'
+                          format: 'double'
+                          example: 0.00
+                        originalShippingFee:
+                          type: 'integer'
+                          format: 'double'
+                          example: 0.00
+                        taxAmount:
+                          type: 'integer'
+                          format: 'double'
+                          example: 0.00
                         returnStatus:
                           type: 'string'
                           example: 'string'
@@ -510,85 +572,91 @@ paths:
                               type: 'string'
                               required: true
                               example: 'string'
-                        marketplaceOrderShipping:
-                          type: 'object'
-                          required:
-                            - 'attentionTo'
-                            - 'address1'
-                            - 'state'
-                            - 'city'
-                            - 'postCode'
-                            - 'country'
-                            - 'phone1'
-                            - 'email'
-                          properties:
-                            attentionTo:
-                              type: 'string'
-                              required: true
-                              example: 'string'
-                            address1:
-                              type: 'string'
-                              required: true
-                              example: 'string'
-                            address2:
-                              type: 'string'
-                              example: 'string'
-                            address3:
-                              type: 'string'
-                              example: 'string'
-                            address4:
-                              type: 'string'
-                              example: 'string'
-                            address5:
-                              type: 'string'
-                              example: 'string'
-                            state:
-                              type: 'string'
-                              required: true
-                              example: 'string'
-                            city:
-                              type: 'string'
-                              required: true
-                              example: 'string'
-                            postCode:
-                              type: 'string'
-                              required: true
-                              example: 'string'
-                            country:
-                              type: 'string'
-                              required: true
-                              example: 'string'
-                            phone1:
-                              type: 'string'
-                              required: true
-                              example: 'string'
-                            phone2:
-                              type:
-                              example: 'string'
-                            email:
-                              type: 'string'
-                              required: true
-                              example: 'string'
-                            freightType:
-                              type: 'string'
-                              example: 'string'
-                            parcelType:
-                              type: 'string'
-                              example: 'string'
-                            deliveryMethod:
-                              type: 'string'
-                              example: 'string'
-                            totalWeight:
-                              type: 'integer'
-                              format: 'double'
-                              example: 1
-                            totalVolume:
-                              type: 'integer'
-                              format: 'double'
-                              example: 1
-                            transporter:
-                              type: 'string'
-                              example: 'string'
+                  marketplaceOrderShipping:
+                    type: 'object'
+                    required:
+                      - 'attentionTo'
+                      - 'address1'
+                      - 'state'
+                      - 'city'
+                      - 'postCode'
+                      - 'country'
+                      - 'phone1'
+                      - 'email'
+                    properties:
+                      attentionTo:
+                        type: 'string'
+                        required: true
+                        example: 'string'
+                      address1:
+                        type: 'string'
+                        required: true
+                        example: 'string'
+                      address2:
+                        type: 'string'
+                        example: 'string'
+                      address3:
+                        type: 'string'
+                        example: 'string'
+                      address4:
+                        type: 'string'
+                        example: 'string'
+                      address5:
+                        type: 'string'
+                        example: 'string'
+                      billingAddress:
+                        type: 'string'
+                        example: 'string'
+                      state:
+                        type: 'string'
+                        required: true
+                        example: 'string'
+                      city:
+                        type: 'string'
+                        required: true
+                        example: 'string'
+                      postCode:
+                        type: 'string'
+                        required: true
+                        example: 'string'
+                      country:
+                        type: 'string'
+                        required: true
+                        example: 'string'
+                      phone1:
+                        type: 'string'
+                        required: true
+                        example: 'string'
+                      phone2:
+                        type:
+                        example: 'string'
+                      email:
+                        type: 'string'
+                        required: true
+                        example: 'string'
+                      freightType:
+                        type: 'integer'
+                        example: 0
+                      parcelType:
+                        type: 'integer'
+                        example: 0
+                      deliveryMethod:
+                        type: 'integer'
+                        example: 0
+                      totalWeight:
+                        type: 'integer'
+                        format: 'double'
+                        example: 1
+                      totalVolume:
+                        type: 'integer'
+                        format: 'double'
+                        example: 1
+                      transporter:
+                        type: 'string'
+                        example: 'string'
+                      trackingNo:
+                        type: 'string'
+                        example: 'string'
       responses:
         '200':
           description: 'successful operation'
@@ -841,3 +909,381 @@ paths:
                 type: 'array'
                 items:
                   $ref: '#/definitions/UpdateMarketplaceShippingOrder'
+
+  # add-marketplace-products
+  api/v1/marketplace/add-marketplace-products:
+    post:
+      tags:
+        - 'Marketplace'
+      summary: 'Add marketplace product(s).'
+      description: 'Add Marketplace Products.'
+      operationId: 'addMarketplaceProducts'
+      produces:
+        - 'application/json'
+      parameters:
+        - in: 'body'
+          name: 'body'
+          schema:
+            type: 'object'
+            properties:
+              data:
+                type: 'object'
+                required:
+                  - 'storeId'
+                  - 'itemId'
+                  - 'marketplaceProducts'
+                properties:
+                  storeId:
+                    type: 'string'
+                    required: true
+                    example: 'BL76D28F'
+                  marketplaceProducts:
+                    type: 'array'
+                    items:
+                      type: 'object'
+                      required:
+                        - 'itemId'
+                        - 'isku'
+                        - 'name'
+                        - 'marketplaceProductVariations'
+                      properties:
+                        itemId:
+                          type: 'string'
+                          required: true
+                          example: '0001'
+                        isku:
+                          type: 'string'
+                          required: true
+                          example: 'SKU0001'
+                        name:
+                          type: 'string'
+                          required: true
+                          example: 'Product Name'
+                        marketplaceStatus:
+                          type: 'string'
+                          required: false
+                          example: 'ACTIVE'
+                        description:
+                          type: 'string'
+                          required: false
+                          example: 'Product Description'
+                        brand:
+                          type: 'string'
+                          requried: false
+                          example: 'Product Brand'
+                        type:
+                          type: 'string'
+                          required: false
+                          example: 'Product Type'
+                        currency:
+                          type: 'string'
+                          required: false
+                          example: 'MYR'
+                        categoryId:
+                          type: 'string'
+                          required: false
+                          example: 'Product Category'
+                        condition:
+                          type: 'string'
+                          required: false
+                          example: 'GOOD'
+                        daysToShip:
+                          type: 'integer'
+                          required: false
+                          example: 1
+                        discountId:
+                          type: 'string'
+                          required: false
+                          example: ''
+                        isPreOrder:
+                          type: 'boolean'
+                          required: false
+                          example: false
+                        marketplaceProductVariations:
+                          type: 'array'
+                          items:
+                            type: 'object'
+                            required:
+                              - 'variationId'
+                              - 'variationSku'
+                              - 'name'
+                            properties:
+                              variationId:
+                                type: 'string'
+                                required: true
+                                example: '0001'
+                              variationSku:
+                                type: 'string'
+                                required: true
+                                example: 'Variation SKU'
+                              channelSku:
+                                type: 'string'
+                                required: false
+                                example: 'Channel Display SKU'
+                              name:
+                                type: 'string'
+                                required: true
+                                example: 'Variation Name'
+                              description:
+                                type: 'string'
+                                required: false
+                                example: 'Variation Description'
+                              qty:
+                                type: 'integer'
+                                required: false
+                                example: 2
+                              type:
+                                type: 'string'
+                                required: false
+                                example: 'Variation Type'
+                              mrpPrice:
+                                type: 'integer'
+                                format: 'double'
+                                required: false
+                                example: 0.00
+                              costPrice:
+                                type: 'integer'
+                                format: 'double'
+                                required: false
+                                example: 0.00
+                              afterTaxCostPrice:
+                                type: 'integer'
+                                format: 'double'
+                                required: false
+                                example: 0.00
+                              sellPrice:
+                                type: 'integer'
+                                format: 'double'
+                                required: false
+                                example: 0.00
+                              afterTaxSalesPrice:
+                                type: 'integer'
+                                format: 'double'
+                                required: false
+                                example: 0.00
+                              discountId:
+                                type: 'string'
+                                required: false
+                                example: ''
+                              status:
+                                type: 'string'
+                                required: false
+                                example: 'ACTIVE'
+                              marketplaceStatus:
+                                type: 'string'
+                                required: false
+                                example: 'ACTIVE'
+                              primaryUnit:
+                                type: 'string'
+                                required: false
+                                example: 'kg'
+                              primaryUnitValue:
+                                type: 'integer'
+                                format: 'double'
+                                required: false
+                                example: 0.00
+                              inventoryPolicy:
+                                type: 'string'
+                                required: false
+                                example: ''
+                              inventoryItemId:
+                                type: 'string'
+                                required: false
+                                example: ''
+                              locationId:
+                                type: 'string'
+                                required: false
+                                example: ''
+      responses:
+        '200':
+          description: 'successful operation'
+          content:
+            application/json:
+              schema:
+                type: 'array'
+                items:
+                  $ref: '#/definitions/AddMarketplaceProducts'
+
+  # update-marketplace-product
+  api/v1/marketplace/update-marketplace-product:
+    post:
+      tags:
+        - 'Marketplace'
+      summary: 'Update marketplace product.'
+      description: 'Update Marketplace Product.'
+      operationId: 'updateMarketplaceProduct'
+      produces:
+        - 'application/json'
+      parameters:
+        - in: 'body'
+          name: 'body'
+          schema:
+            type: 'object'
+            properties:
+              data:
+                type: 'object'
+                required:
+                  - 'storeId'
+                  - 'itemId'
+                properties:
+                  storeId:
+                    type: 'string'
+                    required: true
+                    example: 'BL76D28F'
+                  itemId:
+                    type: 'string'
+                    required: true
+                    example: '0001'
+                  isku:
+                    type: 'string'
+                    required: true
+                    example: 'SKU0001'
+                  name:
+                    type: 'string'
+                    required: true
+                    example: 'Product Name'
+                  marketplaceStatus:
+                    type: 'string'
+                    required: false
+                    example: 'ACTIVE'
+                  description:
+                    type: 'string'
+                    required: false
+                    example: 'Product Description'
+                  brand:
+                    type: 'string'
+                    requried: false
+                    example: 'Product Brand'
+                  type:
+                    type: 'string'
+                    required: false
+                    example: 'Product Type'
+                  currency:
+                    type: 'string'
+                    required: false
+                    example: 'MYR'
+                  categoryId:
+                    type: 'string'
+                    required: false
+                    example: 'Product Category'
+                  condition:
+                    type: 'string'
+                    required: false
+                    example: 'GOOD'
+                  daysToShip:
+                    type: 'integer'
+                    required: false
+                    example: 1
+                  discountId:
+                    type: 'string'
+                    required: false
+                    example: ''
+                  isPreOrder:
+                    type: 'boolean'
+                    required: false
+                    example: false
+                  marketplaceProductVariations:
+                    type: 'array'
+                    items:
+                      type: 'object'
+                      required:
+                        - 'variationId'
+                        - 'variationSku'
+                        - 'name'
+                      properties:
+                        variationId:
+                          type: 'string'
+                          required: true
+                          example: '0001'
+                        variationSku:
+                          type: 'string'
+                          required: true
+                          example: 'Variation SKU'
+                        channelSku:
+                          type: 'string'
+                          required: false
+                          example: 'Channel Display SKU'
+                        name:
+                          type: 'string'
+                          required: true
+                          example: 'Variation Name'
+                        description:
+                          type: 'string'
+                          required: false
+                          example: 'Variation Description'
+                        qty:
+                          type: 'integer'
+                          required: false
+                          example: 2
+                        type:
+                          type: 'string'
+                          required: false
+                          example: 'Variation Type'
+                        mrpPrice:
+                          type: 'integer'
+                          format: 'double'
+                          required: false
+                          example: 0.00
+                        costPrice:
+                          type: 'integer'
+                          format: 'double'
+                          required: false
+                          example: 0.00
+                        afterTaxCostPrice:
+                          type: 'integer'
+                          format: 'double'
+                          required: false
+                          example: 0.00
+                        sellPrice:
+                          type: 'integer'
+                          format: 'double'
+                          required: false
+                          example: 0.00
+                        afterTaxSalesPrice:
+                          type: 'integer'
+                          format: 'double'
+                          required: false
+                          example: 0.00
+                        discountId:
+                          type: 'string'
+                          required: false
+                          example: ''
+                        status:
+                          type: 'string'
+                          required: false
+                          example: 'ACTIVE'
+                        marketplaceStatus:
+                          type: 'string'
+                          required: false
+                          example: 'ACTIVE'
+                        primaryUnit:
+                          type: 'string'
+                          required: false
+                          example: 'kg'
+                        primaryUnitValue:
+                          type: 'integer'
+                          format: 'double'
+                          required: false
+                          example: 0.00
+                        inventoryPolicy:
+                          type: 'string'
+                          required: false
+                          example: ''
+                        inventoryItemId:
+                          type: 'string'
+                          required: false
+                          example: ''
+                        locationId:
+                          type: 'string'
+                          required: false
+                          example: ''
+
+      responses:
+        '200':
+          description: 'successful operation'
+          content:
+            application/json:
+              schema:
+                type: 'array'
+                items:
+                  $ref: '#/definitions/UpdateMarketplaceProduct'