@things-factory/integration-marketplace 5.0.7 → 6.0.0-alpha.0

package/server/controllers/shopee/apis2/create-shipping-document.ts

@@ -0,0 +1,27 @@
+/* https://open.shopee.com/documents/v2/v2.logistics.create_shipping_document?module=95&type=1 */
+
+import { StoreAPI } from '../../store-api'
+
+export function createShippingDocument() {
+  return {
+    path: '/logistics/create_shipping_document',
+    method: 'postV2',
+    async denormalize(req, { store }) {
+      const { orderNo } = req
+
+      let trackingNo = await StoreAPI.getTrackingNumber(store, { orderNo })
+
+      return {
+        order_list: [
+          {
+            order_sn: orderNo,
+            tracking_number: trackingNo
+          }
+        ]
+      }
+    },
+    normalize(res) {
+      return res
+    }
+  }
+}

package/server/controllers/shopee/apis2/echo.ts

@@ -0,0 +1,14 @@
+export function echo() {
+  return {
+    path: '/echo',
+    denormalize(req) {
+      return { ...req }
+    },
+    normalize(res) {
+      return { ...res }
+    },
+    actionV2({ store, method, path, request, platformAction }) {
+      return { ...request }
+    }
+  }
+}

package/server/controllers/shopee/apis2/get-logistics-param.ts

@@ -0,0 +1,66 @@
+/* https://open.shopee.com/documents/v2/v2.logistics.get_shipping_parameter?module=95&type=1 */
+
+export function getLogisticsParam() {
+  return {
+    path: '/logistics/get_shipping_parameter',
+    method: 'getV2',
+    denormalize(req) {
+      var { orderNo } = req
+
+      return {
+        order_sn: orderNo
+      }
+    },
+    normalize(res) {
+      const infoNeeded: any = res.info_needed
+      let logisticsDetail: any
+
+      if (infoNeeded?.pickup?.length > 0) {
+        let addressList: any[] = []
+        const pickup: any = res.pickup
+
+        addressList = pickup.address_list.map(address => {
+          return {
+            ...address,
+            addressId: address.address_id,
+            timeSlot:
+              address?.time_slot_list && !address.time_slot_list?.error
+                ? address.time_slot_list.map(ts => {
+                    return {
+                      ...ts,
+                      pickupDate: new Date(ts.date * 1000).toDateString(),
+                      pickupTimeId: ts.pickup_time_id,
+                      timeText: ts.time_text
+                    }
+                  })
+                : []
+          }
+        })
+
+        logisticsDetail = { pickup: addressList?.length ? addressList : [] }
+      }
+
+      if (infoNeeded?.dropoff?.length > 0) {
+        const dropoff: any = res.dropoff
+        let branchList: any[] = []
+
+        if (dropoff?.branch_list?.length) {
+          branchList = dropoff.branch_list.map(branch => {
+            return {
+              ...branch,
+              branchId: branch.branch_id
+            }
+          })
+        }
+        logisticsDetail = { dropoff: branchList?.length ? branchList : [] }
+      }
+
+      if (infoNeeded?.non_integrated?.length > 0) {
+        logisticsDetail = { non_integrated: infoNeeded.non_integrated }
+      }
+
+      const result = { ...infoNeeded, logisticsDetail }
+      return result
+    }
+  }
+}

package/server/controllers/shopee/apis2/get-shipping-document-result.ts

@@ -0,0 +1,21 @@
+/* https://open.shopee.com/documents/v2/v2.logistics.get_shipping_document_result?module=95&type=1 */
+
+export function getShippingDocumentResult() {
+  return {
+    path: '/logistics/get_shipping_document_result',
+    method: 'postV2',
+    denormalize(req) {
+      const { orderNo } = req
+      return {
+        order_list: [
+          {
+            order_sn: orderNo[0]
+          }
+        ]
+      }
+    },
+    normalize(res) {
+      return res?.result_list[0]?.status
+    }
+  }
+}

package/server/controllers/shopee/apis2/get-store-logistics.ts

@@ -0,0 +1,23 @@
+/* https://open.shopee.com/documents/v2/v2.logistics.get_channel_list?module=95&type=1 */
+
+export function getStoreLogistics() {
+    return {
+      path: '/logistics/get_channel_list',
+      method: 'getV2',
+      denormalize(req) {
+        return {}
+      },
+      normalize(res) {
+  
+        let results = res.logistics_channel_list.filter(x=>x.enabled== true).map(provider => {
+          const { logistics_channel_name, preferred } = provider
+            return {
+              name : logistics_channel_name,
+              isDefault : preferred
+            }
+        })
+        return results
+      }
+    }
+  }
+  

package/server/controllers/shopee/apis2/get-store-order-by-batch.ts

@@ -0,0 +1,97 @@
+/* https://open.shopee.com/documents/v2/v2.order.get_order_detail?module=94&type=1 */
+
+import { StoreAPI } from '../../store-api'
+
+export function getStoreOrderByBatch() {
+  return {
+    path: '/order/get_order_detail',
+    method: 'getV2',
+    denormalize(req) {
+      const { orderIdList } = req
+
+      return {
+        order_sn_list: orderIdList,
+        response_optional_fields: [
+          'recipient_address',
+          'item_list',
+          'total_amount',
+          'shipping_carrier',
+          'estimated_shipping_fee',
+          'buyer_username',
+          'actual_shipping_fee',
+          'pay_time',
+          'cancel_by',
+          'cancel_reason',
+          'actual_shipping_fee_confirmed'
+        ]
+      }
+    },
+    async normalize(res, { store }) {
+      let results = []
+      for (let order of res.order_list) {
+        let recipientAddress = order?.recipient_address
+        let escrowDetails: any = {}
+        let trackingNo = null
+        try {
+          escrowDetails = await StoreAPI.getStoreOrderTransactionDetails(store, { orderNo: order.order_sn })
+        } catch (e) {}
+        try {
+          trackingNo = await StoreAPI.getTrackingNumber(store, { orderNo: order.order_sn })
+        } catch (e) {}
+        const result = {
+          name: order.order_sn,
+          orderNo: order.order_sn,
+          docRefNo: order.order_sn,
+          status: order.order_status.toLowerCase(),
+          orderCreatedAt: new Date(order.create_time * 1000),
+          orderUpdatedAt: new Date(order.update_time * 1000),
+          totalAmount: order.total_amount,
+          cancelBy: order?.cancel_by,
+          reason: order?.cancel_reason,
+          recipientAddress: recipientAddress ? JSON.stringify(recipientAddress) : null,
+          shippingProvider: order.shipping_carrier,
+          itemCount: order.item_list.length,
+          buyerUsername: order.buyer_username,
+          payTime: order?.pay_time ? new Date(order.pay_time * 1000) : null,
+          orderItems: order.item_list.map(item => {
+            return {
+              name: item.item_id,
+              variationId: item.model_id == 0 ? item.item_id : item.model_id,
+              qty: item.model_quantity_purchased,
+              paidPrice: item.model_discounted_price * item.model_quantity_purchased,
+              orderNo: order.order_sn,
+              promotionType: item?.promotion_type,
+              promotionId: item?.promotion_id,
+              isWholesale: item.wholesale,
+              docRefNo: order.order_sn,
+              originalPrice: item.model_quantity_purchased * item.model_original_price,
+              discount:
+                item.model_quantity_purchased * item.model_original_price -
+                item.model_quantity_purchased * item.model_discounted_price
+            }
+          }),
+          orderShipping: {
+            address1: recipientAddress?.full_address,
+            phone1: recipientAddress?.phone,
+            postCode: recipientAddress?.zipcode,
+            city: recipientAddress?.city,
+            state: recipientAddress?.state,
+            country: recipientAddress?.region == 'MY' ? 'Malaysia' : recipientAddress?.region,
+            attentionTo: recipientAddress?.name,
+            transporter: order?.shipping_carrier,
+            shippingFee: parseFloat(order?.estimated_shipping_fee) || null,
+            actualShippingFee: order.actual_shipping_fee_confirmed
+              ? parseFloat(order?.actual_shipping_fee)
+              : parseFloat(order?.estimated_shipping_fee) || null,
+            trackingNo
+          },
+          ...escrowDetails,
+          trackingNo
+        }
+        results.push(result)
+      }
+
+      return results
+    }
+  }
+}

package/server/controllers/shopee/apis2/get-store-order-document.ts

@@ -0,0 +1,39 @@
+/* https://open.shopee.com/documents/v2/v2.logistics.download_shipping_document?module=95&type=1 */
+
+import { StoreAPI } from '../../store-api'
+import { uploadAwb } from '@things-factory/attachment-base'
+
+export function getStoreOrderDocument() {
+  return {
+    path: '/logistics/download_shipping_document',
+    method: 'postV2',
+    async denormalize(req, { store }) {
+      var { docRefNo } = req
+
+      return {
+        order_list: [
+          {
+            order_sn: docRefNo[0]
+          }
+        ]
+      }
+    },
+    async normalize(res) {
+      let awb
+      try {
+        awb = await uploadAwb({
+          content: res.awb,
+          title: res.data.order_list[0].order_sn
+        })
+      } catch (e) {
+        return []
+      }
+      return [
+        {
+          orderNo: res.data.order_list[0].order_sn,
+          airwayBill: awb?.url
+        }
+      ]
+    }
+  }
+}

package/server/controllers/shopee/apis2/get-store-order-payout-dates.ts

@@ -0,0 +1,33 @@
+/* https://open.shopee.com/documents/v2/v2.payment.get_payout_detail?module=97&type=1 */
+
+export function getStoreOrderPayoutDates() {
+  return {
+    path: '/payment/get_payout_detail',
+    method: 'getV2',
+    denormalize(req) {
+      var { fromCreatedDate, toCreatedDate, pagination } = req || {}
+      var { page, limit } = pagination
+      return {
+        payout_time_from: new Date(fromCreatedDate).getTime() / 1000,
+        payout_time_to: new Date(toCreatedDate).getTime() / 1000,
+        page_size: limit,
+        page_no: page * limit
+      }
+    },
+    normalize(res) {
+      var { payout_list, more } = res
+      let results = []
+
+      for (let payout of payout_list) {
+        let payoutDate = new Date(payout.payout_info.payout_time * 1000).toISOString()
+        for (let escrow of payout.escrow_list) {
+          results.push({
+            orderNo: escrow.order_sn,
+            payoutDate
+          })
+        }
+      }
+      return { results, more }
+    }
+  }
+}

package/server/controllers/shopee/apis2/get-store-order-transaction-details.ts

@@ -0,0 +1,28 @@
+/* https://open.shopee.com/documents/v2/v2.payment.get_escrow_detail?module=97&type=1 */
+
+export function getStoreOrderTransactionDetails() {
+  return {
+    method: 'getV2',
+    path: '/payment/get_escrow_detail',
+    denormalize(req) {
+      var { orderNo } = req
+
+      return {
+        order_sn: orderNo
+      }
+    },
+    normalize(res) {
+      var { order_income } = res
+      const result = {
+        voucherAmount: parseFloat(order_income?.discount_from_voucher_seller) || null,
+        shippingRebate: parseFloat(order_income?.shopee_shipping_rebate) || null,
+        commissionFee: parseFloat(order_income?.commission_fee) || null,
+        serviceFee: parseFloat(order_income?.service_fee) || null,
+        transactionFee: parseFloat(order_income?.seller_transaction_fee) || null,
+        totalRealeasedAmount: parseFloat(order_income?.escrow_amount) || null,
+        voucherCode: order_income?.seller_voucher_code
+      }
+      return result
+    }
+  }
+}

package/server/controllers/shopee/apis2/get-store-order.ts

@@ -0,0 +1,93 @@
+/* https://open.shopee.com/documents/v2/v2.order.get_order_detail?module=94&type=1 */
+
+import { StoreAPI } from '../../store-api'
+
+export function getStoreOrder() {
+  return {
+    path: '/order/get_order_detail',
+    method: 'getV2',
+    denormalize(req) {
+      const { orderNo } = req
+
+      return {
+        order_sn_list: [orderNo],
+        response_optional_fields: [
+          'recipient_address',
+          'item_list',
+          'total_amount',
+          'shipping_carrier',
+          'estimated_shipping_fee',
+          'buyer_username',
+          'actual_shipping_fee',
+          'pay_time',
+          'cancel_by',
+          'cancel_reason',
+          'actual_shipping_fee_confirmed'
+        ]
+      }
+    },
+    async normalize(res, { store }) {
+      let order = res.order_list[0]
+      let recipientAddress = order?.recipient_address
+      let escrowDetails: any = {}
+      let trackingNo = null
+      try {
+        escrowDetails = await StoreAPI.getStoreOrderTransactionDetails(store, { orderNo: order.order_sn })
+      } catch (e) {}
+      try {
+        trackingNo = await StoreAPI.getTrackingNumber(store, { orderNo: order.order_sn })
+      } catch (e) {}
+      const result = {
+        name: order.order_sn,
+        orderNo: order.order_sn,
+        docRefNo: order.order_sn,
+        status: order.order_status.toLowerCase(),
+        orderCreatedAt: new Date(order.create_time * 1000),
+        orderUpdatedAt: new Date(order.update_time * 1000),
+        totalAmount: order.total_amount,
+        cancelBy: order?.cancel_by,
+        reason: order?.cancel_reason,
+        recipientAddress: recipientAddress ? JSON.stringify(recipientAddress) : null,
+        shippingProvider: order.shipping_carrier,
+        itemCount: order.item_list.length,
+        buyerUsername: order.buyer_username,
+        payTime: order?.pay_time ? new Date(order.pay_time * 1000) : null,
+        orderItems: order.item_list.map(item => {
+          return {
+            name: item.item_id,
+            variationId: item.model_id == 0 ? item.item_id : item.model_id,
+            qty: item.model_quantity_purchased,
+            paidPrice: item.model_discounted_price * item.model_quantity_purchased,
+            orderNo: order.order_sn,
+            promotionType: item?.promotion_type,
+            promotionId: item?.promotion_id,
+            isWholesale: item.wholesale,
+            docRefNo: order.order_sn,
+            originalPrice: item.model_quantity_purchased * item.model_original_price,
+            discount:
+              item.model_quantity_purchased * item.model_original_price -
+              item.model_quantity_purchased * item.model_discounted_price
+          }
+        }),
+        orderShipping: {
+          address1: recipientAddress?.full_address,
+          phone1: recipientAddress?.phone,
+          postCode: recipientAddress?.zipcode,
+          city: recipientAddress?.city,
+          state: recipientAddress?.state,
+          country: recipientAddress?.region == 'MY' ? 'Malaysia' : recipientAddress?.region,
+          attentionTo: recipientAddress?.name,
+          transporter: order?.shipping_carrier,
+          shippingFee: parseFloat(order?.estimated_shipping_fee) || null,
+          actualShippingFee: order.actual_shipping_fee_confirmed
+            ? parseFloat(order?.actual_shipping_fee)
+            : parseFloat(order?.estimated_shipping_fee) || null,
+          trackingNo
+        },
+        trackingNo,
+        ...escrowDetails
+      }
+      return result
+    }
+  }
+}

package/server/controllers/shopee/apis2/get-store-orders.ts

@@ -0,0 +1,40 @@
+/* https://open.shopee.com/documents/v2/v2.order.get_order_list?module=94&type=1 */
+
+import { StoreAPI } from '../../store-api'
+
+export function getStoreOrders() {
+  return {
+    path: '/order/get_order_list',
+    method: 'getV2',
+    denormalize(req) {
+      var { pagination, fromCreatedDate, toCreatedDate, nextCursor } = req || {}
+      var { limit = 100 } = pagination || {}
+
+      var time_from = Math.floor(new Date(fromCreatedDate).getTime() / 1000)
+      var time_to = Math.floor(new Date(toCreatedDate).getTime() / 1000)
+      var time_range_field = 'create_time' // Available values: create_time, update_time
+
+      let payload: any = { time_from, time_to, time_range_field, page_size: limit }
+
+      if (nextCursor) {
+        payload.cursor = nextCursor
+      }
+
+      return {
+        ...payload
+      }
+    },
+    async normalize(res, { store }) {
+      let results = []
+      const orderIdList = res.order_list.map(order => {
+        return order.order_sn
+      })
+      while (orderIdList.length > 0) {
+        let splicedList = orderIdList.splice(0, orderIdList.length >= 50 ? 50 : orderIdList.length)
+        let result = await StoreAPI.getStoreOrderByBatch(store, { orderIdList: splicedList })
+        results.push(...result)
+      }
+      return { results, more: res.more, cursor: res.next_cursor }
+    }
+  }
+}

package/server/controllers/shopee/apis2/get-store-product-variations.ts

@@ -0,0 +1,17 @@
+/* https://open.shopee.com/documents/v2/v2.product.get_model_list?module=89&type=1 */
+
+export function getStoreProductVariations() {
+  return {
+    path: '/product/get_model_list',
+    method: 'getV2',
+    denormalize(req) {
+      const { itemId } = req
+      return {
+          item_id: itemId
+      }
+    },
+    normalize(res) {
+      return res
+    }
+  }
+}

package/server/controllers/shopee/apis2/get-store-product.ts

@@ -0,0 +1,105 @@
+/* https://open.shopee.com/documents/v2/v2.product.get_item_base_info?module=89&type=1 */
+
+import { StoreAPI } from '../../store-api'
+
+export function getStoreProduct() {
+  return {
+    path: '/product/get_item_base_info',
+    method: 'getV2',
+    denormalize(req) {
+      return {
+        item_id_list: req.itemIds
+      }
+    },
+    async normalize(res, { store }) {
+      let items = res.item_list
+      let results = []
+      for (let i = 0; i < items.length; i++) {
+        const item = items[i]
+        let variations
+        if (item.has_model) {
+          variations = await StoreAPI.getStoreProductVariations(store, { itemId: item.item_id })
+        }
+        const result = {
+          itemId: item.item_id,
+          isku: item?.item_sku,
+          weight: item.weight,
+          categoryId: item.category_id,
+          condition: item.condition,
+          marketplaceStatus: item.item_status,
+          name: item.item_name,
+          description: item.description_info?.extended_description?.field_list?.find(f => f.field_type == 'text')?.text,
+          currency: item?.price_info ? item?.price_info[0]?.currency : undefined,
+          costPrice: item?.price_info ? item?.price_info[0]?.original_price : undefined,
+          sellPrice: item?.price_info ? item?.price_info[0]?.current_price : undefined,
+          qty: item?.stock_info_v2?.summary_info?.total_available_stock,
+          bufferQty: item?.stock_info_v2?.summary_info?.total_reserved_stock,
+          packageLength: item.dimension.package_length,
+          packageWidth: item.dimension.package_width,
+          packageHeight: item.dimension.package_height,
+          daysToShip: item.pre_order.days_to_ship,
+          discountId: item.promotion_id,
+          isPreOrder: item.pre_order.is_pre_order,
+          hasVariation: item.has_model,
+          attributes: item?.attribute_list?.map(attribute => {
+            return {
+              attributeId: attribute.attribute_id,
+              name: attribute.original_attribute_name,
+              isMandatory: attribute.is_mandatory,
+              originalValue: JSON.stringify(
+                attribute?.attribute_value_list?.map(v => {
+                  return v.original_value_name
+                })
+              ) || ''
+            }
+          }) || [],
+          variations: item.has_model
+            ? variations.model.map(variation => {
+                return {
+                  variationId: variation.model_id,
+                  variationSku: variation.model_sku,
+                  channelSku: variation.model_sku,
+                  name: `${item.item_name} - ${
+                    variations.tier_variation[0].option_list[variation.tier_index[0]].option
+                  }${
+                    variations.tier_variation[1]
+                      ? ' - ' + variations.tier_variation[1].option_list[variation.tier_index[1]].option
+                      : ''
+                  }`,
+                  description: item.description_info?.extended_description?.field_list?.find(
+                    f => f.field_type == 'text'
+                  )?.text,
+                  qty: variation.stock_info_v2.summary_info.total_available_stock,
+                  bufferQty: variation.stock_info_v2.summary_info.total_reserved_stock,
+                  costPrice: variation.price_info[0].original_price,
+                  sellPrice: variation.price_info[0].current_price,
+                  discountId: variation.promotion_id,
+                  marketplaceStatus: item.item_status,
+                  primaryUnitValue: item.weight
+                }
+              })
+            : [
+                {
+                  variationId: item.item_id,
+                  variationSku: item.item_sku,
+                  channelSku: item.item_sku,
+                  name: item.item_name,
+                  description: item.description_info?.extended_description?.field_list?.find(
+                    f => f.field_type == 'text'
+                  )?.text,
+                  qty: item.stock_info_v2.summary_info.total_available_stock,
+                  bufferQty: item.stock_info_v2.summary_info.total_reserved_stock,
+                  costPrice: item.price_info[0].original_price,
+                  sellPrice: item.price_info[0].current_price,
+                  discountId: item.promotion_id,
+                  marketplaceStatus: item.item_status,
+                  primaryUnitValue: item.weight
+                }
+              ]
+        }
+        results.push(result)
+      }
+      return results
+    }
+  }
+}

package/server/controllers/shopee/apis2/get-store-products.ts

@@ -0,0 +1,28 @@
+/* https://open.shopee.com/documents/v2/v2.product.get_item_list?module=89&type=1 */
+
+import { StoreAPI } from '../../store-api'
+
+export function getStoreProducts() {
+  return {
+    path: '/product/get_item_list',
+    method: 'getV2',
+    denormalize(req) {
+      var { pagination } = req || {}
+      var { page = 0, limit = 100 } = pagination || {}
+
+      return {
+        offset: page * limit,
+        page_size: limit,
+        item_status: ['NORMAL']
+      }
+    },
+    async normalize(res, { store }) {
+      const itemIds = res.item.map(product => {
+        return product.item_id
+      })
+
+      const results = await StoreAPI.getStoreProduct(store, { itemIds })
+      return { results, total: res.total_count }
+    }
+  }
+}

package/server/controllers/shopee/apis2/get-store-refund-order-details.ts

@@ -0,0 +1,39 @@
+/* https://open.shopee.com/documents/v2/v2.returns.get_return_detail?module=102&type=1 */
+
+export function getStoreRefundOrderDetails() {
+  return {
+    path: '/returns/get_return_detail',
+    method: 'getV2',
+    denormalize(req) {
+      var { refundOrderNo } = req
+
+      return {
+        return_sn: refundOrderNo
+      }
+    },
+    async normalize(res) {
+      let refundItems = res.items.map(item => {
+        let { item_id: name, item_id: orderItemId, item_price: price, amount: qty, variation_id: variationId } = item
+        name = name.toString()
+        orderItemId = orderItemId.toString()
+        return {
+          name,
+          orderItemId,
+          price,
+          qty,
+          variationId
+        }
+      })
+
+      let results = {
+        name: res.return_sn.toString(),
+        orderNo: res.return_sn.toString(),
+        amount: res.refund_amount,
+        status: res.status,
+        items: refundItems
+      }
+
+      return results
+    }
+  }
+}