@things-factory/operato-hub 4.3.82 → 4.3.83

package/openapi/v1/ecommerce.yaml

@@ -0,0 +1,549 @@
+definitions:
+  MarketplaceStore:
+    type: 'object'
+    properties:
+      name:
+        type: 'string'
+      platform:
+        type: 'string'
+      eTrax:
+        type: 'boolean'
+      storeName:
+        type: 'string'
+      isAutoUpdateStockQty:
+        type: 'boolean'
+      isAutoUpdateShipment:
+        type: 'boolean'
+      storeId:
+        type: 'string'
+      countryCode:
+        type: 'string'
+      status:
+        type: 'string'
+      updatedAt:
+        type: 'datetime'
+        example: '2021-01-14 14:32:15'
+    xml:
+      name: 'MarketplaceStore'
+  MarketplaceOrder:
+    type: 'object'
+    required:
+      - 'orderNo'
+      - 'marketplaceOrderItems'
+    properties:
+      orderNo:
+        type: 'string'
+      orderNo:
+        type: 'string'
+        example: 'SGD'
+      itemCount:
+        type: 'integer'
+        format: 'int32'
+      paymentMethod:
+        type: 'string'
+      remark:
+        type: 'string'
+      giftOption:
+        type: 'boolean'
+        default: 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'
+          required:
+            - 'qty'
+            - 'orderItemId'
+          properties:
+            marketplaceProductVariation:
+              type: 'object'
+              properties:
+                variationId:
+                  type: 'string'
+                sku:
+                  type: 'string'
+                variationSku:
+                  type: 'string'
+                variationName:
+                  type: 'string'
+            marketplaceOrderShipping:
+              type: 'object'
+              properties:
+                attentionTo:
+                  type: 'string'
+                address1:
+                  type: 'string'
+                address2:
+                  type: 'string'
+                address3:
+                  type: 'string'
+                address4:
+                  type: 'string'
+                address5:
+                  type: 'string'
+                state:
+                  type: 'string'
+                city:
+                  type: 'string'
+                postCode:
+                  type: 'string'
+                country:
+                  type: 'string'
+                phone1:
+                  type: 'string'
+                phone2:
+                  type: 'string'
+                email:
+                  type: 'string'
+                freightType:
+                  type: 'string'
+                parcelType:
+                  type: 'string'
+                deliveryMethod:
+                  type: 'string'
+                totalWeight:
+                  type: 'string'
+                totalVolume:
+                  type: 'string'
+                transporter:
+                  type: 'string'
+            orderItemId:
+              type: 'string'
+            qty:
+              type: 'integer'
+              minimum: 1.0
+              format: 'int32'
+            cancelBy:
+              type: 'string'
+            returnStatus:
+              type: 'string'
+            packageId:
+              type: 'string'
+            status:
+              type: 'string'
+    xml:
+      name: 'MarketplaceOrder'
+  MarketplaceOrderShipping:
+    type: 'object'
+    required:
+      - 'attentionTo'
+      - 'address1'
+      - 'postCode'
+      - 'country'
+      - 'phone1'
+    properties:
+      attentionTo:
+        type: 'string'
+      address1:
+        type: 'string'
+      address2:
+        type: 'string'
+      address3:
+        type: 'string'
+      address4:
+        type: 'string'
+      address5:
+        type: 'string'
+      state:
+        type: 'string'
+      city:
+        type: 'string'
+      postCode:
+        type: 'string'
+      country:
+        type: 'string'
+      phone1:
+        type: 'string'
+      phone2:
+        type: 'string'
+      email:
+        type: 'string'
+      freightType:
+        type: 'string'
+      parcelType:
+        type: 'string'
+      deliveryMethod:
+        type: 'string'
+      totalWeight:
+        type: 'string'
+      totalVolume:
+        type: 'string'
+      transporter:
+        type: 'string'
+      marketplaceStore:
+        type: 'object'
+        properties:
+          name:
+            type: 'string'
+          storeId:
+            type: 'string'
+      marketplaceOrderItems:
+        type: 'array'
+        items:
+          type: 'object'
+          required:
+            - 'qty'
+            - 'orderItemId'
+          properties:
+            marketplaceProductVariation:
+              type: 'object'
+              properties:
+                variationId:
+                  type: 'string'
+                sku:
+                  type: 'string'
+                variationSku:
+                  type: 'string'
+                variationName:
+                  type: 'string'
+            orderItemId:
+              type: 'string'
+            qty:
+              type: 'integer'
+              minimum: 1.0
+              format: 'int32'
+            cancelBy:
+              type: 'string'
+            returnStatus:
+              type: 'string'
+            packageId:
+              type: 'string'
+            status:
+              type: 'string'
+    xml:
+      name: 'MarketplaceOrderShipping'
+paths:
+  /warehouse/{storeId}/add-marketplace-order:
+    post:
+      tags:
+        - 'marketplaceOrder'
+      description: 'Use this API to create marketplace order in Operato ecommerce omnichannel management.'
+      operationId: 'addMarketplaceOrder'
+      produces:
+        - 'application/json'
+      parameters:
+        - in: 'path'
+          name: 'storeId'
+          required: true
+          type: 'string'
+        - in: 'body'
+          name: 'body'
+          description: 'Marketplace order object to be added to MMS.'
+          required: true
+          schema:
+            $ref: '#/definitions/MarketplaceOrder'
+      responses:
+        '200':
+          description: 'successful operation'
+        '400':
+          description: 'Bad request is sent'
+        '401':
+          description: 'Authentication Error'
+        '404':
+          description: 'Resource not found'
+        '500':
+          description: 'Server error'
+      deprecated: false
+  /warehouse/{storeId}/get-marketplace-order-shipping-list:
+    get:
+      tags:
+        - 'marketplaceOrder'
+      description: 'Use this API to get marketplace order shipping from MMS.'
+      operationId: 'getMarketplaceOrderShippingList'
+      produces:
+        - 'application/json'
+      parameters:
+        - in: 'path'
+          name: 'storeId'
+          required: true
+          type: 'string'
+        - in: 'query'
+          name: 'shippingNo'
+          required: false
+          type: 'string'
+        - in: 'query'
+          name: 'orderNo'
+          required: false
+          type: 'string'
+        - in: 'query'
+          name: 'status'
+          required: false
+          type: 'string'
+        - in: 'query'
+          name: 'fromDate'
+          required: false
+          type: 'string'
+        - in: 'query'
+          name: 'toDate'
+          required: false
+          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.'
+          type: 'integer'
+          format: 'uint32'
+        - 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.'
+          type: 'integer'
+          format: 'uint32'
+      responses:
+        '200':
+          description: 'successful operation'
+          content:
+            application/json:
+              schema:
+                type: 'array'
+                items:
+                  $ref: '#/definitions/MarketplaceOrderShipping'
+        '400':
+          description: 'Bad request is sent'
+        '401':
+          description: 'Authentication Error'
+        '404':
+          description: 'Resource not found'
+        '500':
+          description: 'Server error'
+      deprecated: false
+  /warehouse/{storeId}/update-marketplace-shipping-order:
+    post:
+      tags:
+        - 'marketplaceOrder'
+      description: 'Use this API to update tracking no, airway bill and other information in MMS shipping order.'
+      operationId: 'getOutboundOrderDetail'
+      produces:
+        - 'application/json'
+      parameters:
+        - in: 'path'
+          name: 'storeId'
+          required: true
+          type: 'string'
+        - in: 'body'
+          name: 'body'
+          description: 'orderNo is a mandatory in body, trackingNo, airwayBill and status'
+          schema:
+            type: 'object'
+            required:
+              - orderNo
+              - trackingNo
+              - airwayBill
+              - status
+            properties:
+              orderNoRef:
+                type: 'string'
+              transporter:
+                type: 'string'
+              airwayBill:
+                type: 'string'
+              trackingNo:
+                type: 'string'
+              status: 
+                type: 'string'
+      responses:
+        '200':
+          description: 'successful operation'
+          content:
+            application/json:
+              schema:
+                $ref: '#/definitions/MarketplaceOrderShipping'
+        '400':
+          description: 'Bad request is sent'
+        '401':
+          description: 'Authentication Error'
+        '404':
+          description: 'Resource not found'
+        '500':
+          description: 'Server error'
+      deprecated: false
+  /warehouse/{storeId}/cancel-marketplace-order:
+    post:
+      tags:
+        - 'marketplaceOrder'
+      description: 'Use this API to cancel marketplace order and set status to CANCELLED.'
+      operationId: 'cancelMarketplaceOrder'
+      produces:
+        - 'application/json'
+      parameters:
+        - in: 'path'
+          name: 'storeId'
+          required: true
+          type: 'string'
+        - in: 'body'
+          name: 'body'
+          description: 'orderNo is a mandatory in body, send status as cancelled'
+          required: true
+          schema:
+            type: 'object'
+            required:
+              - orderNo
+              - status
+            properties:
+              orderNo:
+                type: 'string'
+              status:
+                type: 'string'
+              remark:
+                type: 'string'
+              cancelBy:
+                type: 'string'
+      responses:
+        '200':
+          description: 'successful operation'
+          content:
+            application/json:
+              schema:
+                $ref: '#/definitions/MarketplaceOrder'
+        '400':
+          description: 'Bad request is sent'
+        '401':
+          description: 'Authentication Error'
+        '404':
+          description: 'Resource not found'
+        '500':
+          description: 'Server error'
+      deprecated: false
+  /warehouse/{storeId}/set-marketplace-order-delivered:
+    post:
+      tags:
+        - 'marketplaceOrder'
+      description: 'Use this API to set marketplace order status to Delivered. Only for Lazada Platform'
+      operationId: 'setMarketplaceOrderDelivered'
+      produces:
+        - 'application/json'
+      parameters:
+        - in: 'path'
+          name: 'storeId'
+          required: true
+          type: 'string'
+        - in: 'body'
+          name: 'body'
+          description: 'orderNo is a mandatory in body'
+          required: true
+          schema:
+            type: 'object'
+            required:
+              - orderNo
+            properties:
+              orderNo:
+                type: 'string'
+      responses:
+        '200':
+          description: 'successful operation'
+        '400':
+          description: 'Bad request is sent'
+        '401':
+          description: 'Authentication Error'
+        '404':
+          description: 'Resource not found'
+        '500':
+          description: 'Server error'
+      deprecated: false
+  /warehouse/{storeId}/set-marketplace-order-failed-delivery:
+    post:
+      tags:
+        - 'marketplaceOrder'
+      description: 'Use this API to set marketplace order status to Failed Delivery. Only for Lazada Platform'
+      operationId: 'setMarketplaceOrderFailedDelivery'
+      produces:
+        - 'application/json'
+      parameters:
+        - in: 'path'
+          name: 'storeId'
+          required: true
+          type: 'string'
+        - in: 'body'
+          name: 'body'
+          description: 'orderNo is a mandatory in body'
+          required: true
+          schema:
+            type: 'object'
+            required:
+              - orderNo
+            properties:
+              orderNo:
+                type: 'string'
+      responses:
+        '200':
+          description: 'successful operation'
+        '400':
+          description: 'Bad request is sent'
+        '401':
+          description: 'Authentication Error'
+        '404':
+          description: 'Resource not found'
+        '500':
+          description: 'Server error'
+      deprecated: false
+  /warehouse/get-marketplace-store-list:
+    get:
+      tags:
+        - 'marketplaceStore'
+      description: 'Use this API to get marketplace stores from MMS.'
+      operationId: 'getMarketplaceStoreList'
+      produces:
+        - 'application/json'
+      responses:
+        '200':
+          description: 'successful operation'
+          content:
+            application/json:
+              schema:
+                type: 'array'
+                items:
+                  $ref: '#/definitions/MarketplaceStore'
+        '400':
+          description: 'Bad request is sent'
+        '401':
+          description: 'Authentication Error'
+        '404':
+          description: 'Resource not found'
+        '500':
+          description: 'Server error'
+      deprecated: false
+  /warehouse/{storeId}/update-marketplace-order:
+    post:
+      tags:
+        - 'marketplaceOrder'
+      description: 'Use this API to update status in MMS order.'
+      operationId: 'updateMarketplaceOrder'
+      produces:
+        - 'application/json'
+      parameters:
+        - in: 'path'
+          name: 'storeId'
+          required: true
+          type: 'string'
+        - in: 'body'
+          name: 'body'
+          description: 'orderNo and status are mandatory in body'
+          schema:
+            type: 'object'
+            required:
+              - orderNo
+              - status
+            properties:
+              orderNo:
+                type: 'string'
+              status: 
+                type: 'string'
+      responses:
+        '200':
+          description: 'successful operation'
+          content:
+            application/json:
+              schema:
+                $ref: '#/definitions/MarketplaceOrder'
+        '400':
+          description: 'Bad request is sent'
+        '401':
+          description: 'Authentication Error'
+        '404':
+          description: 'Resource not found'
+        '500':
+          description: 'Server error'
+      deprecated: false