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

package/openapi/v1/marketplace.yaml

@@ -1,843 +0,0 @@
-definitions:
-  # GetMarketplace
-  GetMarketplace:
-    type: 'object'
-    properties:
-      data:
-        type: 'array'
-        items:
-          type: 'object'
-          properties:
-            id:
-              type: 'string'
-              example: 'c409e848-b952-4ebe-9705-14614dde60aa'
-            name:
-              type: 'string'
-              example: Hatio Shopee
-            platform:
-              type: 'string'
-              example: shopee
-            eTrax:
-              type: 'boolean'
-              example: false
-            storeName:
-              type: 'string'
-              example: Hatio Shopee
-            storeUrl:
-              type: 'string'
-              example: https://shop.hatio.com/
-            isAutoUpdateStockQty:
-              type: 'boolean'
-              example: true
-            isAutoUpdateShipment:
-              type: 'boolean'
-              example: true
-            storeId:
-              type: 'string'
-              example: '6336552'
-            countryCode:
-              type: 'string'
-              example: 'my'
-            status:
-              type: 'string'
-              example: 'ACTIVE'
-      totalCount:
-        type: 'integer'
-        example: 1
-      limit:
-        type: 'integer'
-        example: 100
-      offset:
-        type: 'integer'
-        example: 0
-    xml:
-      name: 'GetMarketplace'
-
-  # AddMarketplaceOrder
-  AddMarketplaceOrder:
-    type: 'object'
-    properties:
-      data:
-        type: 'object'
-        properties:
-          orderNo:
-            type: 'string'
-            example: 'string'
-          itemCount:
-            type: 'integer'
-            example: 0
-          paymentMethod:
-            type: 'string'
-            example: 'string'
-          remark:
-            type: 'string'
-            example: 'string'
-          giftOption:
-            type: 'boolean'
-            example: false
-          orderCreatedAt:
-            type: 'datetime'
-            example: '2021-01-14 14:32:15'
-          orderUpdatedAt:
-            type: 'datetime'
-            example: '2021-01-14 14:32:15'
-          marketplaceOrderItems:
-            type: 'array'
-            items:
-              type: 'object'
-              properties:
-                marketplaceProductVariation:
-                  type: 'object'
-                  properties:
-                    variationId:
-                      type: 'string'
-                      example: 'string'
-                    sku:
-                      type: 'string'
-                      example: 'string'
-                    variationSku:
-                      type: 'string'
-                      example: 'string'
-                    variationName:
-                      type: 'string'
-                      example: 'string'
-                marketplaceOrderShipping:
-                  type: 'object'
-                  properties:
-                    attentionTo:
-                      type: 'string'
-                      example: 'string'
-                    address1:
-                      type: 'string'
-                      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'
-                      example: 'string'
-                    city:
-                      type: 'string'
-                      example: 'string'
-                    postCode:
-                      type: 'string'
-                      example: 'string'
-                    country:
-                      type: 'string'
-                      example: 'string'
-                    phone1:
-                      type: 'string'
-                      example: 'string'
-                    phone2:
-                      type: 'string'
-                      example: 'string'
-                    email:
-                      type: 'string'
-                      example: 'string'
-                    freightType:
-                      type: 'string'
-                      example: 'string'
-                    parcelType:
-                      type: 'string'
-                      example: 'string'
-                    deliveryMethod:
-                      type: 'string'
-                      example: 'string'
-                    totalWeight:
-                      type: 'string'
-                      example: 'string'
-                    totalVolume:
-                      type: 'string'
-                      example: 'string'
-                    transporter:
-                      type: 'string'
-                      example: 'string'
-                orderItemId:
-                  type: 'string'
-                  example: 'string'
-                qty:
-                  type: 'integer'
-                  example: 1
-                cancelBy:
-                  type: 'string'
-                  example: 'string'
-                returnStatus:
-                  type: 'string'
-                  example: 'string'
-                packageId:
-                  type: 'string'
-                  example: 'string'
-                status:
-                  type: 'string'
-                  example: 'string'
-    xml:
-      name: 'AddMarketplaceOrder'
-
-  # CancelMarketplaceOrder
-  CancelMarketplaceOrder:
-    type: 'object'
-    properties:
-      data:
-        type: 'object'
-        properties:
-          storeId:
-            type: 'string'
-            example: 'BL76D28F'
-          orderNo:
-            type: 'string'
-            example: 'string'
-          status:
-            type: 'string'
-            example: 'string'
-          cancelBy:
-            type: 'string'
-            example: 'string'
-          updatedAt:
-            type: 'datetime'
-            example: '2021-01-14T14:32:15Z'
-    xml:
-      name: 'CancelMarketplaceOrder'
-
-  # UpdateMarketplaceOrderDelivered
-  UpdateMarketplaceOrderDelivered:
-    type: 'object'
-    properties:
-      data:
-        type: 'object'
-        properties:
-          orderNo:
-            type: 'string'
-            example: 'string'
-    xml:
-      name: 'UpddateMarketplaceOrderDelivered'
-
-  # GetMarketplaceOrderShippingList
-  GetMarketplaceOrderShippingList:
-    type: 'object'
-    properties:
-      data:
-        type: 'array'
-        items:
-          type: 'object'
-          properties:
-            attentionTo:
-              type: 'string'
-              example: 'string'
-            address1:
-              type: 'string'
-              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'
-              example: 'string'
-            city:
-              type: 'string'
-              example: 'string'
-            postCode:
-              type: 'string'
-              example: 'string'
-            country:
-              type: 'string'
-              example: 'string'
-            phone1:
-              type: 'string'
-              example: 'string'
-            phone2:
-              type: 'string'
-              example: 'string'
-            email:
-              type: 'string'
-              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'
-            marketplaceStore:
-              type: 'object'
-              properties:
-                name:
-                  type: 'string'
-                  example: 'string'
-                storeId:
-                  type: 'string'
-                  example: 'string'
-            marketplaceOrderItems:
-              type: 'array'
-              items:
-                type: 'object'
-                properties:
-                  marketplaceProductVariation:
-                    type: 'object'
-                    properties:
-                      variationId:
-                        type: 'string'
-                        example: 'string'
-                      sku:
-                        type: 'string'
-                        example: 'string'
-                      variationSku:
-                        type: 'string'
-                        example: 'string'
-                      variationName:
-                        type: 'string'
-                        example: 'string'
-                  orderItemId:
-                    type: 'string'
-                    example: 'string'
-                  qty:
-                    type: 'integer'
-                    example: 1
-                  cancelBy:
-                    type: 'string'
-                    example: 'string'
-                  returnStatus:
-                    type: 'string'
-                    example: 'string'
-                  packageId:
-                    type: 'string'
-                    example: 'string'
-                  status:
-                    type: 'string'
-                    example: 'string'
-      totalCount:
-        type: 'integer'
-        example: 1
-      limit:
-        type: 'integer'
-        example: 100
-      offset:
-        type: 'integer'
-        example: 0
-    xml:
-      name: 'GetMarketplaceOrderShippingList'
-
-  # UpdateMarketplaceShippingOrder
-  UpdateMarketplaceShippingOrder:
-    type: 'object'
-    properties:
-      data:
-        type: 'object'
-        properties:
-          orderNoRef:
-            type: 'string'
-            example: 'string'
-          transporter:
-            type: 'string'
-            example: 'string'
-          airwayBill:
-            type: 'string'
-            example: 'string'
-          trackingNo:
-            type: 'string'
-            example: 'string'
-          # status:
-          #   type: 'string'
-          #   example: 'string'
-    xml:
-      name: 'UpdateMarketplaceShippingOrder'
-
-paths:
-  # get-marketplace-store-list
-  api/v1/marketplace/get-marketplace-store-list:
-    get:
-      tags:
-        - 'Marketplace'
-      summary: 'Get List of Marketplace Store(s).'
-      description: 'Get list of marketplace store.'
-      operationId: 'getMarketplaceStoreList'
-      consumes:
-        - 'application/json'
-      produces:
-        - 'application/json'
-      parameters:
-        - in: 'query'
-          name: 'limit'
-          type: 'integer'
-          default: 100
-        - in: 'query'
-          name: 'offset'
-          type: 'integer'
-          default: 0
-      responses:
-        '200':
-          description: 'successful operation'
-          content:
-            application/json:
-              schema:
-                type: 'array'
-                items:
-                  $ref: '#/definitions/GetMarketplace'
-
-  # add-marketplace-order
-  api/v1/marketplace/add-marketplace-order:
-    post:
-      tags:
-        - 'Marketplace'
-      summary: 'Add marketplace order(s).'
-      description: 'Add Marketplace Order.'
-      operationId: 'addMarketPlace'
-      produces:
-        - 'application/json'
-      parameters:
-        - in: 'body'
-          name: 'body'
-          schema:
-            type: 'object'
-            properties:
-              data:
-                type: 'object'
-                required:
-                  - 'storeId'
-                  - 'orderNo'
-                  - 'status'
-                  - 'marketplaceOrderItems'
-                properties:
-                  storeId:
-                    type: 'string'
-                    required: true
-                    example: 'BL76D28F'
-                  orderNo:
-                    type: 'string'
-                    required: true
-                    example: 'string'
-                  status:
-                    type: 'string'
-                    required: true
-                    example: 'processing'
-                  itemCount:
-                    type: 'integer'
-                    example: 0
-                  paymentMethod:
-                    type: 'string'
-                    example: 'string'
-                  remark:
-                    type: 'string'
-                    example: 'string'
-                  giftOption:
-                    type: 'boolean'
-                    example: false
-                  orderCreatedAt:
-                    type: 'datetime'
-                    example: '2021-01-14T14:32:15Z'
-                  orderUpdatedAt:
-                    type: 'datetime'
-                    example: '2021-01-14T14:32:15Z'
-                  marketplaceOrderItems:
-                    type: 'array'
-                    items:
-                      type: 'object'
-                      required:
-                        - 'orderItemId'
-                        - 'qty'
-                        - 'marketplaceProductVariation'
-                        - 'marketplaceOrderShipping'
-                      properties:
-                        orderItemId:
-                          type: 'string'
-                          required: true
-                          example: 'string'
-                        qty:
-                          type: 'integer'
-                          required: true
-                          example: 1
-                        cancelBy:
-                          type: 'string'
-                          example: 'string'
-                        returnStatus:
-                          type: 'string'
-                          example: 'string'
-                        packageId:
-                          type: 'string'
-                          example: 'string'
-                        status:
-                          type: 'string'
-                          example: 'string'
-                        marketplaceProductVariation:
-                          type: 'object'
-                          required:
-                            - 'variationId'
-                            - 'variationSku'
-                            - 'variationName'
-                          properties:
-                            variationId:
-                              type: 'string'
-                              required: true
-                              example: 'string'
-                            sku:
-                              type: 'string'
-                              example: 'string'
-                            variationSku:
-                              type: 'string'
-                              required: true
-                              example: 'string'
-                            variationName:
-                              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'
-      responses:
-        '200':
-          description: 'successful operation'
-          content:
-            application/json:
-              schema:
-                type: 'array'
-                items:
-                  $ref: '#/definitions/AddMarketplaceOrder'
-
-  # cancel-marketplace-order
-  api/v1/marketplace/cancel-marketplace-order:
-    post:
-      tags:
-        - 'Marketplace'
-      summary: 'Cancel marketplace order(s).'
-      description: 'Cancel Marketplace Order.'
-      operationId: 'cancelMarketplaceOrder'
-      produces:
-        - 'application/json'
-      parameters:
-        # - in: 'query'
-        #   name: 'storeId'
-        #   description: 'storeId parameter refers to the name column in the MarketplaceStores table.'
-        #   type: 'string'
-        #   required: true
-        # - in: 'query'
-        #   name: 'orderNo'
-        #   description: 'Order Number'
-        #   type: 'string'
-        #   required: true
-        # - in: 'query'
-        #   name: 'remark'
-        #   description: 'Remarks'
-        #   type: 'string'
-        #   required: true
-        # - in: 'query'
-        #   name: 'cancelBy'
-        #   description: 'For MarketplaceOrderItems table'
-        #   type: 'string'
-        - in: 'body'
-          name: 'body'
-          schema:
-            type: 'object'
-            properties:
-              data:
-                type: 'object'
-                properties:
-                  storeId:
-                    type: 'string'
-                    example: 'BL76D28F'
-                    required: true
-                    description: 'storeId parameter refers to the name column in the MarketplaceStores table.'
-                  orderNo:
-                    type: 'string'
-                    example: 'string'
-                    required: true
-                  remark:
-                    type: 'string'
-                    example: 'string'
-                    required: true
-                  cancelBy:
-                    type: 'string'
-                    example: 'string'
-                    description: 'For MarketplaceOrderItems table'
-      responses:
-        '200':
-          description: 'successful operation'
-          content:
-            application/json:
-              schema:
-                type: 'array'
-                items:
-                  $ref: '#/definitions/CancelMarketplaceOrder'
-
-  # update-marketplace-order-delivered
-  api/v1/marketplace/update-marketplace-order-delivered:
-    post:
-      tags:
-        - 'Marketplace'
-      summary: 'Update marketplace order delivered.'
-      description: 'Update Marketplace Order Delivered.'
-      operationId: 'updateMarketplaceOrderDelivered'
-      produces:
-        - 'application/json'
-      parameters:
-        # - in: 'query'
-        #   name: 'storeId'
-        #   description: 'storeId parameter refers to the name column in the MarketplaceStores table.'
-        #   type: 'string'
-        #   required: true
-        # - in: 'query'
-        #   name: 'orderNo'
-        #   description: 'Order Number'
-        #   type: 'string'
-        #   required: true
-        - in: 'body'
-          name: 'body'
-          schema:
-            type: 'object'
-            properties:
-              data:
-                type: 'object'
-                properties:
-                  storeId:
-                    type: 'string'
-                    example: 'BL76D28F'
-                    description: 'storeId parameter refers to the name column in the MarketplaceStores table.'
-                    required: true
-                  orderNo:
-                    type: 'string'
-                    example: 'string'
-                    required: true
-      responses:
-        '200':
-          description: 'success'
-          content:
-            application/json:
-              schema:
-                type: 'array'
-                items:
-                  $ref: '#/definitions/UpdateMarketplaceOrderDelivered'
-
-  # get-marketplace-order-shipping-list
-  api/v1/marketplace/get-marketplace-order-shipping-list:
-    get:
-      tags:
-        - 'Marketplace'
-      summary: 'Get list of marketplace order shipping list.'
-      description: 'Get list of marketplace order shipping list.'
-      operationId: 'getMarketplaceOrderShippingList'
-      consumes:
-        - 'application/json'
-      produces:
-        - 'application/json'
-      parameters: # edit fields
-        - in: 'query'
-          name: 'storeId'
-          type: 'string'
-          required: true
-        - in: 'query'
-          name: 'shippingNo'
-          type: 'string'
-        - in: 'query'
-          name: 'orderNo'
-          type: 'string'
-        - in: 'query'
-          name: 'status'
-          type: 'string'
-        - in: 'query'
-          name: 'fromDate'
-          type: 'datetime'
-          default: '7 days before current datetime.'
-          description: '(Must use in conjunction with “toDate”) In UTC format eg: 2022-07-25T03:40:04Z'
-        - in: 'query'
-          name: 'toDate'
-          type: 'datetime'
-          default: 'Current datetime.'
-          description: '(Must use in conjunction with “fromDate”) In UTC format eg: 2022-07-25T03:40:04Z'
-        - 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:
-                type: 'array'
-                items:
-                  $ref: '#/definitions/GetMarketplaceOrderShippingList'
-
-  # update-marketplace-shipping-order
-  api/v1/marketplace/update-marketplace-shipping-order:
-    post:
-      tags:
-        - 'Marketplace'
-      summary: 'Update marketplace shipping order.'
-      description: 'Update Marketplace Shipping Order.'
-      operationId: 'updateMarketplaceShippingOrder'
-      produces:
-        - 'application/json'
-      parameters:
-        # - in: 'query'
-        #   name: 'storeId'
-        #   description: 'storeId parameter refers to the name column in the MarketplaceStores table.'
-        #   type: 'string'
-        #   required: true
-        # - in: 'query'
-        #   name: 'orderNo'
-        #   description: 'Order Number'
-        #   type: 'string'
-        #   required: true
-        # - in: 'query'
-        #   name: 'transporter'
-        #   type: 'string'
-        # - in: 'query'
-        #   name: 'airwayBill'
-        #   type: 'string'
-        #   required: true
-        # - in: 'query'
-        #   name: 'trackingNo'
-        #   type: 'string'
-        #   required: true
-        # - in: 'query'
-        #   name: 'status'
-        #   type: 'string'
-        - in: 'body'
-          name: 'body'
-          schema:
-            type: 'object'
-            properties:
-              data:
-                type: 'object'
-                properties:
-                  storeId:
-                    type: 'string'
-                    example: 'BL76D28F'
-                    required: true
-                  orderNo:
-                    type: 'string'
-                    example: 'string'
-                    required: true
-                  transporter:
-                    type: 'string'
-                    example: 'string'
-                  airwayBill:
-                    type: 'string'
-                    example: 'string'
-                    required: true
-                  trackingNo:
-                    type: 'string'
-                    example: 'string'
-                    required: true
-                  # status:
-                  #   type: 'string'
-                  #   example: 'string'
-      responses:
-        '200':
-          description: 'success'
-          content:
-            application/json:
-              schema:
-                type: 'array'
-                items:
-                  $ref: '#/definitions/UpdateMarketplaceShippingOrder'