@things-factory/integration-marketplace 8.0.0-beta.9 → 8.0.2

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
+    }
+  }
+}

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

@@ -0,0 +1,37 @@
+/* https://open.shopee.com/documents/v2/v2.returns.get_return_list?module=102&type=1 */
+
+import { StoreAPI } from '../../store-api'
+
+export function getStoreRefundOrders() {
+  return {
+    path: '/returns/get_return_list',
+    method: 'getV2',
+    denormalize(req) {
+      var { pagination, fromDate, toDate } = req || {}
+      var { page = 0, limit = 100 } = pagination || {}
+
+      var create_time_from = Math.floor(new Date(fromDate).getTime() / 1000)
+      var create_time_to = Math.floor(new Date(toDate).getTime() / 1000)
+
+      return {
+        page_size: limit,
+        page_no: page * limit,
+        create_time_from,
+        create_time_to
+      }
+    },
+    async normalize(res, { store }) {
+      let results: any[] = []
+
+      for (var i = 0; i < res.return?.length; i++) {
+        const refundOrder = res.return[i]
+        const refundOrderNo = refundOrder.return_sn
+
+        const result = await StoreAPI.getStoreRefundOrderDetails(store, { refundOrderNo })
+
+        results.push({ ...result, originalOrderNo: refundOrder.order_sn })
+      }
+      return { results, more: res.more }
+    }
+  }
+}

package/server/controllers/shopee/apis2/get-tracking-number.ts

@@ -0,0 +1,17 @@
+/* https://open.shopee.com/documents/v2/v2.logistics.get_tracking_number?module=95&type=1 */
+
+export function getTrackingNumber() {
+  return {
+    path: '/logistics/get_tracking_number',
+    method: 'getV2',
+    denormalize(req) {
+      const { orderNo } = req
+      return {
+        order_sn: orderNo
+      }
+    },
+    normalize(res) {
+      return res?.tracking_number || null
+    }
+  }
+}

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

@@ -0,0 +1,20 @@
+export * from './echo'
+export * from './get-store-products'
+export * from './get-store-product'
+export * from './get-store-product-variations'
+export * from './get-store-orders'
+export * from './get-store-order'
+export * from './get-store-order-by-batch'
+export * from './get-store-order-transaction-details'
+export * from './update-store-product-stock'
+export * from './update-store-product-variation-stock'
+export * from './get-store-order-payout-dates'
+export * from './get-store-refund-orders'
+export * from './get-store-refund-order-details'
+export * from './get-store-logistics'
+export * from './get-logistics-param'
+export * from './get-tracking-number'
+export * from './init-logistics'
+export * from './create-shipping-document'
+export * from './get-shipping-document-result'
+export * from './get-store-order-document'

package/server/controllers/shopee/apis2/init-logistics.ts

@@ -0,0 +1,39 @@
+/* https://open.shopee.com/documents?module=3&type=1&id=389 */
+
+export function initLogistics() {
+  return {
+    path: '/logistics/ship_order',
+    method: 'postV2',
+    denormalize(req) {
+      var { orderNo: order_sn, deliveryType } = req
+      let pickup = {}
+      let dropoff = {}
+      let non_integrated = {}
+      let args = {}
+
+      if (deliveryType?.pickup) {
+        var { addressId, pickupTimeId: pickup_time_id } = deliveryType.pickup
+        var address_id = parseInt(addressId)
+        pickup = { address_id, pickup_time_id }
+        args = { order_sn, pickup: { ...pickup } }
+      }
+
+      if (deliveryType?.non_integrated) {
+        var { trackingNo: tracking_number } = deliveryType.non_integrated
+        non_integrated = { tracking_number }
+        args = { order_sn, non_integrated: { tracking_number } }
+      }
+
+      if (deliveryType?.dropoff) {
+        var { branchId: branch_id } = deliveryType.dropoff
+        dropoff = { branch_id }
+        args = { order_sn, dropoff: { ...dropoff } }
+      }
+
+      return args
+    },
+    normalize(res) {
+      return res
+    }
+  }
+}

package/server/controllers/shopee/apis2/update-store-product-stock.ts

@@ -0,0 +1,26 @@
+/* https://open.shopee.com/documents/v2/v2.product.update_stock?module=89&type=1 */
+
+export function updateStoreProductStock() {
+  return {
+    path: '/product/update_stock',
+    method: 'postV2',
+    denormalize(req) {
+      let data = req[0]
+      return {
+        item_id: parseInt(data.itemId),
+        stock_list: [
+          {
+            seller_stock: [
+              {
+                stock: data.qty
+              }
+            ]
+          }
+        ]
+      }
+    },
+    normalize(res) {
+      return res
+    }
+  }
+}

package/server/controllers/shopee/apis2/update-store-product-variation-stock.ts

@@ -0,0 +1,28 @@
+/* https://open.shopee.com/documents/v2/v2.product.update_stock?module=89&type=1 */
+
+
+export function updateStoreProductVariationStock() {
+  return {
+    path: '/product/update_stock',
+    method: 'postV2',
+    denormalize(req) {
+      let data = req[0]
+      return {
+        item_id: parseInt(data.itemId),
+        stock_list: [
+          {
+            model_id: parseInt(data.variationId),
+            seller_stock: [
+              {
+                stock: data.qty
+              }
+            ]
+          }
+        ]
+      }
+    },
+    normalize(res) {
+      return res
+    }
+  }
+}

package/server/controllers/shopee/index.ts

@@ -0,0 +1,16 @@
+export * from './shopee'
+
+import { config } from '@things-factory/env'
+import { StoreAPI } from '../store-api'
+import { action, actionV2 } from './platform-action'
+import * as APIS from './apis'
+import * as APISV2 from './apis2'
+
+const shopeeConfig = config.get('marketplaceIntegrationShopee', {})
+const { v2 } = shopeeConfig
+
+if (v2) {
+    StoreAPI.registerPlatform('shopee', actionV2, APISV2)
+} else {
+    StoreAPI.registerPlatform('shopee', action, APIS)
+}

package/server/controllers/shopee/platform-action.ts

@@ -0,0 +1,58 @@
+import { Shopee } from './shopee'
+
+import { config } from '@things-factory/env'
+import { refreshAccessToken } from './refresh-access-token'
+const shopeeConfig = config.get('marketplaceIntegrationShopee', {})
+const { partnerId, partnerKey, isUAT } = shopeeConfig
+
+export const actionV2 = async ({ store, path, request, method = 'post' }) => {
+  let response = await _action({ store, path, request, method })
+  if (response.error) {
+    if (response.error == 'error_auth') {
+      try {
+        const { accessToken } = await refreshAccessToken(store.id, store.storeId, store.refreshToken, store.accessToken)
+        store = {
+          ...store,
+          accessToken
+        }
+        response = await _action({ store, path, request, method })
+      } catch (e) {
+        throw e
+      }
+    } else {
+      throw response
+    }
+  }
+  return response.response || response
+}
+
+const _action = async ({ store, path, request, method = 'post' }) => {
+  const client = new Shopee({
+    isUAT: isUAT,
+    shopid: Number(store.storeId),
+    partner_id: partnerId,
+    partner_key: partnerKey,
+    access_token: store.accessToken
+  })
+
+  var response = await client[method](path, request)
+
+  return response
+}
+
+export const action = async ({ store, path, request }) => {
+  const client = new Shopee({
+    isUAT: isUAT,
+    shopid: Number(store.storeId),
+    partner_id: partnerId,
+    partner_key: partnerKey,
+    access_token: store.accessToken
+  })
+
+  var response = await client.post(path, request)
+  if (response.error) {
+    throw response
+  }
+
+  return response
+}

package/server/controllers/shopee/refresh-access-token.ts

@@ -0,0 +1,78 @@
+import crypto from 'crypto'
+import fetch from 'node-fetch'
+import { createQueryBuilder } from 'typeorm'
+
+import { config, logger } from '@things-factory/env'
+import { getRepository } from '@things-factory/shell'
+
+import { MarketplaceStore } from '../../entities'
+
+const shopeeConfig = config.get('marketplaceIntegrationShopee', {})
+const { partnerId, partnerKey, isUAT } = shopeeConfig
+const refreshPath = '/auth/access_token/get'
+
+export const refreshAccessToken = async (store_uuid, shop_id, refresh_token, old_access_token) => {
+  let marketplaceStore: MarketplaceStore = await getRepository(MarketplaceStore)
+    .createQueryBuilder('ms')
+    .where('ms.id = :id', { id: store_uuid })
+    .getOne()
+
+  if (old_access_token != marketplaceStore.accessToken) {
+    return {
+      accessToken: marketplaceStore.accessToken
+    }
+  }
+
+  const timestamp = Math.floor(Date.now() / 1000)
+  const sign = crypto
+    .createHmac('sha256', partnerKey)
+    .update(partnerId + '/api/v2' + refreshPath + timestamp)
+    .digest('hex')
+
+  const auth = {
+    partner_id: partnerId,
+    sign: sign,
+    timestamp: timestamp
+  }
+
+  const qs = Object.entries(auth)
+    .map(([k, v]) => `${k}=${encodeURIComponent(String(v))}`)
+    .join('&')
+
+  const data = {
+    refresh_token: refresh_token,
+    partner_id: partnerId,
+    shop_id: parseInt(shop_id)
+  }
+
+  const jsondata = JSON.stringify(data)
+
+  const response = await fetch(`${getAuthUrl()}?${qs}`, {
+    method: 'post',
+    body: jsondata
+  })
+
+  if (!response.ok) {
+    throw 'Failed to get response to refresh Shopee access token'
+  }
+
+  const result = await response.json()
+
+  if (result.error) {
+    logger.error(`Failed to refresh Shopee token: ${result.error} - shop ID (${shop_id})`)
+    throw result.error
+  }
+
+  const tokens = {
+    accessToken: result.access_token, // expires in 4 hours
+    refreshToken: result.refresh_token // expires in 30 days
+  }
+
+  await createQueryBuilder().update(MarketplaceStore).set(tokens).where('id = :id', { id: store_uuid }).execute()
+
+  return tokens
+}
+
+function getAuthUrl() {
+  return `https://partner${isUAT ? '.test-stable' : ''}.shopeemobile.com/api/v2${refreshPath}`
+}