@things-factory/integration-marketplace 5.0.0-alpha.9 → 5.0.0-y.0

package/server/controllers/shopify/apis/get-store-orders.ts

@@ -5,22 +5,28 @@ export function getStoreOrders() {
     method: 'get',
     path: '/orders.json',
     denormalize(req) {
-      var { pagination, fromDate, toDate, lastOrderId } = req || {}
+      var { pagination, fromCreatedDate, toCreatedDate, fromUpdatedDate, toUpdatedDate, lastOrderId } = req || {}
       var { page = 0, limit = 100 } = pagination || {}
 
-      var created_at_min = new Date(fromDate).toISOString()
-      var created_at_max = new Date(toDate).toISOString()
-      /* Must include only create_time or update_time in the request. */
-      // var update_time_from = lastOneDay
-      // var update_time_to = now
-
       var payload: any = {
         limit,
-        created_at_min,
-        created_at_max,
         status: 'any'
       }
 
+      if (fromCreatedDate && toCreatedDate) {
+        var created_at_min = new Date(fromCreatedDate).toISOString()
+        var created_at_max = new Date(toCreatedDate).toISOString()
+        payload.created_at_min = created_at_min
+        payload.created_at_max = created_at_max
+      }
+
+      if (fromUpdatedDate && toUpdatedDate) {
+        var updated_at_min = new Date(fromUpdatedDate).toISOString()
+        var updated_at_max = new Date(toUpdatedDate).toISOString()
+        payload.updated_at_min = updated_at_min
+        payload.updated_at_max = updated_at_max
+      }
+
       if (lastOrderId) payload.since_id = Number(lastOrderId)
 
       return { payload }
@@ -45,7 +51,9 @@ export function getStoreOrders() {
         .map(order => {
           const orderId = order.id
           const fulfillmentStatus = order.fulfillment_status
+          const paymentStatus = order?.financial_status || ''
           let orderStatus = order?.cancelled_at ? 'cancelled' : fulfillmentStatus ? fulfillmentStatus : 'unfulfilled'
+          let sellercraftStatus = getSellercraftStatus(fulfillmentStatus, paymentStatus)
 
           let itemCount: Number = 0
           let result: any
@@ -63,6 +71,7 @@ export function getStoreOrders() {
               orderUpdatedAt: new Date(order.updated_at).toUTCString(),
               discountValue: order.total_discounts,
               status: order.financial_status == 'pending' ? 'unpaid' : orderStatus,
+              sellercraftStatus,
               trackingNo: fulfillment.tracking_number,
               shippingProvider: fulfillment.tracking_company,
               recipientAddress:
@@ -78,7 +87,10 @@ export function getStoreOrders() {
                   variationId: lineItem.product_exists === true ? lineItem.variant_id : lineItem.id.toString(),
                   variationSku: lineItem.sku,
                   channelSku: lineItem.sku,
-                  variationName: lineItem.name
+                  variationName: lineItem.name,
+                  originalPrice: lineItem.price,
+                  total: lineItem.price,
+                  subtotal: lineItem.price
                 }
               })
             }
@@ -122,7 +134,8 @@ export function getStoreOrders() {
                   variationId: lineItem.product_exists === true ? lineItem.variant_id : lineItem.id.toString(),
                   variationSku: lineItem.sku,
                   channelSku: lineItem.sku,
-                  variationName: lineItem.name
+                  variationName: lineItem.name,
+                  originalPrice: lineItem.price
                 }
 
                 lineItems.push(lineItem)
@@ -135,7 +148,8 @@ export function getStoreOrders() {
                   variationId: lineItem.product_exists === true ? lineItem.variant_id : lineItem.id.toString(),
                   variationSku: lineItem.sku,
                   channelSku: lineItem.sku,
-                  variationName: lineItem.name
+                  variationName: lineItem.name,
+                  originalPrice: lineItem.price
                 }
 
                 if (lineItem.qty >= 0) lineItems.push(lineItem)
@@ -153,6 +167,7 @@ export function getStoreOrders() {
               discountValue: order.total_discounts,
               recipientAddress: order.billing_address,
               status: order.financial_status == 'pending' ? 'unpaid' : orderStatus,
+              sellercraftStatus,
               reason: order.cancel_reason,
               orderItems: lineItems
             }
@@ -183,11 +198,44 @@ export function getStoreOrders() {
               city,
               state,
               country: country === 'MY' ? 'Malaysia' : country,
-              collectionCurrency: null,
+              collectionCurrency: order.currency,
               attentionTo: `${first_name} ${last_name}`
             }
 
             result.orderShipping = orderShipping
+
+            // For SC mapping
+
+            let shippingAddress = order?.shipping_address
+            let billingAddress = order?.billing_address || shippingAddress
+
+            result.shipping = {
+              address_1: shippingAddress.address1,
+              address_2: shippingAddress.address2,
+              address_3: shippingAddress.province,
+              postcode: shippingAddress.zip,
+              country: shippingAddress.country_code,
+              city: shippingAddress.city,
+              first_name: shippingAddress.first_name,
+              last_name: shippingAddress.last_name,
+              phone: shippingAddress.phone,
+              email: order.email
+            }
+            result.billing = {
+              address_1: billingAddress.address1,
+              address_2: billingAddress.address2,
+              address_3: billingAddress.province,
+              postcode: billingAddress.zip,
+              country: billingAddress.country_code,
+              city: billingAddress.city,
+              first_name: billingAddress.first_name,
+              last_name: billingAddress.last_name,
+              phone: billingAddress.phone,
+              email: order.email
+            }
+            result.isSOF = true
+            result.firstName = order?.customer?.first_name || ''
+            result.lastName = order?.customer?.last_name || ''
           }
 
           itemCount = result.orderItems.length
@@ -211,3 +259,16 @@ function checkNextPage(link) {
 
   return nextPage
 }
+
+function getSellercraftStatus(fulfillmentStatus, paymentStatus) {
+  if (
+    (fulfillmentStatus == 'unfulfilled' || !fulfillmentStatus) &&
+    (paymentStatus == 'pending' || paymentStatus == 'unpaid')
+  )
+    return 'payment_pending'
+  if ((fulfillmentStatus == 'unfulfilled' || !fulfillmentStatus) && paymentStatus == 'paid') return 'processing'
+  if (fulfillmentStatus == 'fulfilled' && paymentStatus == 'paid') return 'shipped'
+  if (paymentStatus == 'refunded') return 'refunded'
+  if (paymentStatus == 'voided') return 'cancelled'
+  if (paymentStatus == 'overdue') return 'cancelled'
+}

package/server/controllers/shopify/apis/get-store-product-variation-stock.ts

@@ -0,0 +1,17 @@
+export function getStoreProductVariationStock() {
+  return {
+    path: '/variants/{variantId}.json',
+    method: 'get',
+    denormalize(req) {
+      let { variantId } = req
+      return {
+        resource: {
+          variantId
+        }
+      }
+    },
+    normalize(res) {
+      return res?.variant?.inventory_quantity
+    }
+  }
+}

package/server/controllers/shopify/apis/get-store-products.ts

@@ -9,13 +9,18 @@ export function getStoreProducts() {
     method: 'get',
     path: '/products.json',
     denormalize(req) {
-      var { pagination, pageInfo } = req || {}
+      var { pagination, pageInfo, fromUpdatedDate, toUpdatedDate } = req || {}
       var { page, limit } = pagination || { page: 0, limit: 100 }
 
       var payload: any = {
         limit: limit
       }
 
+      if (fromUpdatedDate && toUpdatedDate) {
+        payload.updated_at_max = toUpdatedDate
+        payload.updated_at_min = fromUpdatedDate
+      }
+
       if (pageInfo) payload.page_info = pageInfo
 
       return { payload }
@@ -72,7 +77,24 @@ export function getStoreProducts() {
           marketplaceStatus: product.status,
           hasVariation: true,
           categoryId: product?.collection_id ? product.collection_id : null,
-          attributes: [],
+          attributes: product?.options?.map(option => {
+            return {
+              native_attribute_id: option.id,
+              attribute_key: option.name,
+              values: option.values
+            }
+          }) || [],
+          sellercraftAttributes: [
+            {
+              native_attribute_id: 'description',
+              attribute_key: 'description',
+              display_name: 'Description',
+              values: [product.body_html]
+            }
+          ],
+          images: product?.images?.map(image => {
+            return image.src
+          }) || [],
           variations: productVariations.map(variant => {
             return {
               variationId: variant.id,
@@ -83,10 +105,14 @@ export function getStoreProducts() {
               inventoryPolicy: variant.inventory_policy,
               inventoryItemId: variant.inventory_item_id,
               locationId: variant.location_id,
+              extraMetadata: {
+                inventoryItemId: variant.inventory_item_id,
+                locationId: variant.location_id,  
+              },
               primaryUnit: variant.weight_unit,
               primaryUnitValue: variant.weight,
               costPrice: variant.price,
-              sellPrice: variant.compare_at_price,
+              sellPrice: variant.compare_at_price || variant.price,
               attributes: [
                 {
                   attributeId: variant.option1,
@@ -101,6 +127,15 @@ export function getStoreProducts() {
                   name: variant.option3
                 }
               ],
+              sellercraftAttributes: product?.options.map(option => {
+                return {
+                  native_attribute_id: option.name,
+                  attribute_key: option.name,
+                  display_name: option.name,
+                  values: [variant[`option${option.position}`]]
+                }
+              }) || [],
+              weight: variant.grams,
               presentmentPrices: variant?.presentment_prices
                 ? variant.presentment_prices.map(presentmentPrice => {
                     return {

package/server/controllers/shopify/apis/index.ts

@@ -7,3 +7,7 @@ export * from './update-store-product-variation-stock'
 export * from './update-order-status'
 export * from './set-store-order-status-ready-to-ship'
 export * from './get-store-order'
+export * from './update-store-product-variation-price'
+export * from './update-store-product-price'
+export * from './update-store-product-stock'
+export * from './get-store-product-variation-stock'

package/server/controllers/shopify/apis/update-order-status.ts

@@ -1,15 +1,27 @@
-/* https://shopify.dev/api/admin-rest/2021-10/resources/fulfillment#[post]/admin/api/2021-10/orders/{order_id}/fulfillments/{fulfillment_id}/complete.json */
+/* https://shopify.dev/api/admin-rest/2021-10/resources/fulfillment#[post]/admin/api/2021-10/fulfillments.json */
 
 export function updateOrderStatus() {
   return {
-    path: '/orders/{orderId}/fulfillments/{fulfillmentId}/complete.json',
     method: 'post',
+    path: '/orders/{orderId}/fulfillments.json',
     denormalize(req) {
-      const { orderId, fulfillmentId } = req
+      const { orderId, trackingNo, locations, carrier, status } = req || {}
+
+      if (status != 'READY_TO_SHIP') {
+        throw new Error('Shopify cannot create fulfillment, order status is not READY_TO_SHIP')
+      }
+
       return {
+        payload: {
+          fulfillment: {
+            location_id: locations[0],
+            tracking_number: trackingNo,
+            notify_customer: true,
+            tracking_company: carrier
+          }
+        },
         resource: {
-          orderId: orderId,
-          fulfillmentId: fulfillmentId.toString()
+          orderId
         }
       }
     },

package/server/controllers/shopify/apis/update-store-product-price.ts

@@ -0,0 +1,26 @@
+/*https://shopify.dev/api/admin-rest/2021-10/resources/product-variant#put-variants-variant-id */
+
+export function updateStoreProductPrice() {
+  return {
+    path: '/variants/{variantId}.json',
+    method: 'put',
+    denormalize(req) {
+      let { costPrice, sellPrice, variationId } = req
+
+      return {
+        payload: {
+          variant: {
+            price: costPrice,
+            compare_at_price: sellPrice
+          }
+        },
+        resource: {
+          variantId: variationId
+        }
+      }
+    },
+    normalize(res) {
+      return res
+    }
+  }
+}

package/server/controllers/shopify/apis/update-store-product-stock.ts

@@ -0,0 +1,20 @@
+export function updateStoreProductStock() {
+  return {
+    method: 'post',
+    path: '/inventory_levels/adjust.json',
+    denormalize(req) {
+      const { inventoryItemId, locationId: location_id, qty } = (Array.isArray(req) ? req[0] : req) || {}
+
+      return {
+        payload: {
+          inventory_item_id: parseInt(inventoryItemId),
+          location_id,
+          available_adjustment: parseInt(qty)
+        }
+      }
+    },
+    normalize(res) {
+      return res
+    }
+  }
+}

package/server/controllers/shopify/apis/update-store-product-variation-price.ts

@@ -0,0 +1,26 @@
+/*https://shopify.dev/api/admin-rest/2021-10/resources/product-variant#put-variants-variant-id */
+
+export function updateStoreProductVariationPrice() {
+  return {
+    path: '/variants/{variantId}.json',
+    method: 'put',
+    denormalize(req) {
+      let { costPrice, sellPrice, variationId } = req
+
+      return {
+        payload: {
+          variant: {
+            price: costPrice,
+            compare_at_price: sellPrice
+          }
+        },
+        resource: {
+          variantId: variationId
+        }
+      }
+    },
+    normalize(res) {
+      return res
+    }
+  }
+}

package/server/controllers/shopify/apis/update-store-product-variation-stock.ts

@@ -3,7 +3,7 @@ export function updateStoreProductVariationStock() {
     method: 'post',
     path: '/inventory_levels/adjust.json',
     denormalize(req) {
-      const { inventoryItemId, locationId: location_id, qty } = req[0]
+      const { inventoryItemId, locationId: location_id, qty } = (Array.isArray(req) ? req[0] : req) || {}
 
       return {
         payload: {

package/server/controllers/shopify/shopify.ts

@@ -2,6 +2,8 @@ import fetch from 'node-fetch'
 import crypto from 'crypto'
 import querystring from 'querystring'
 
+import { createPayloadLog } from '@things-factory/integration-base'
+
 const debug = require('debug')('things-factory:integration-marketplace:shopify')
 
 export type ShopifyConfig = {
@@ -77,6 +79,11 @@ export class Shopify {
     var result = await response.json()
     result.link = link
 
+    try {
+      createPayloadLog(shop, path, qs || '', result, {
+        state: { domain: null }
+      })
+    } catch (e) {}
     debug('response result', result)
 
     return result
@@ -101,6 +108,40 @@ export class Shopify {
     })
 
     const result = await response.json()
+    try {
+      createPayloadLog(shop, path, jsondata, result, {
+        state: { domain: null }
+      })
+    } catch (e) {}
+    debug('response result', result)
+
+    return result
+  }
+
+  async put(path: string, data: any = {}) {
+    const { shop, accessToken } = this.config
+
+    debug('data', data)
+
+    const jsondata = JSON.stringify(data)
+
+    const endpoint = `https://${shop}.myshopify.com/admin/api/2020-01${path}`
+
+    const response = await fetch(endpoint, {
+      method: 'put',
+      headers: {
+        'Content-Type': 'application/json',
+        'X-Shopify-Access-Token': accessToken
+      },
+      body: jsondata
+    })
+
+    const result = await response.json()
+    try {
+      createPayloadLog(shop, path, jsondata, result, {
+        state: { domain: null }
+      })
+    } catch (e) {}
     debug('response result', result)
 
     return result

package/server/controllers/store-api/index.ts

@@ -66,6 +66,12 @@ export class StoreAPI {
   @api
   static getStoreOrder(store, req): any {}
 
+  @api
+  static getStoreOrderPackages(store, req): any {}
+
+  @api
+  static getStoreOrderPackage(store, req): any {}
+
   @api
   static getStoreOrderItems(store, req): any {}
 
@@ -185,4 +191,7 @@ export class StoreAPI {
 
   @api
   static getStoreOrderPayoutDates(store, req): any {}
+
+  @api
+  static getStoreProductVariationStock(store, req): any {}
 }

package/server/controllers/tiktok/apis/echo.ts

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

package/server/controllers/tiktok/apis/get-store-order-document.ts

@@ -0,0 +1,26 @@
+/* https://bytedance.feishu.cn/docs/doccnDyz5Bbk26iOdejbBRBlLrb#ytBXoS */
+
+export function getStoreOrderDocument() {
+  return {
+    method: 'get',
+    path: '/api/fulfillment/shipping_document',
+    denormalize(req) {
+      var { packageId, documentType } = req || {}
+
+      return { payload: { package_id: packageId, document_type: documentType } }
+    },
+    async normalize(res) {
+      const { data } = res
+
+      let result: any[] = [
+        {
+          file: data.doc_url,
+          fileTypeValue: 'AWB',
+          mimeType: 'application/pdf'
+        }
+      ]
+
+      return result
+    }
+  }
+}

package/server/controllers/tiktok/apis/get-store-order-package.ts

@@ -0,0 +1,46 @@
+/* https://bytedance.feishu.cn/docs/doccnDyz5Bbk26iOdejbBRBlLrb#ytBXoS */
+
+export function getStoreOrderPackage() {
+  return {
+    method: 'get',
+    path: '/api/fulfillment/detail',
+    denormalize(req) {
+      var { packageId } = req || {}
+
+      return { payload: { package_id: packageId } }
+    },
+    async normalize(res) {
+      const { data } = res
+
+      let result: any = {
+        packageId: data.package_id,
+        orderInfoList: data.order_info_list.map(itm => {
+          return {
+            orderId: itm.order_id,
+            skuList: itm.sku_list.map(sku => {
+              return {
+                skuId: sku.sku_id,
+                skuName: sku.sku_name,
+                skuImage: sku.sku_image,
+                quantity: sku.quantity
+              }
+            })
+          }
+        }),
+        packageStatus: data.package_status,
+        deliveryOption: data.delivery_option,
+        shippingProvider: data.shipping_provider,
+        shippingProviderId: data.shipping_provider_id,
+        trackingNumber: data.tracking_number,
+        orderListIdList: data.order_line_id_list,
+        pickUpType: data.pick_up_type,
+        pickUpStartTime: data.pick_up_start_time,
+        pickupEndTime: data.pick_up_end_time,
+        createTime: data.create_time,
+        updateTime: data.update_time
+      }
+
+      return result
+    }
+  }
+}

package/server/controllers/tiktok/apis/get-store-order-packages.ts

@@ -0,0 +1,43 @@
+/* https://bytedance.feishu.cn/wiki/wikcntMLczW460imZUfYqaa1Dng#jIY8hJ */
+
+import { StoreAPI } from '../../store-api'
+
+export function getStoreOrderPackages() {
+  return {
+    method: 'post',
+    path: '/api/fulfillment/search',
+    denormalize(req) {
+      var { pagination, fromDate, toDate, nextCursor } = req || {}
+      var { page, limit } = pagination || { page: 0, limit: 100 }
+
+      var create_time_from = Math.floor(new Date(fromDate).getTime() / 1000)
+      var create_time_to = Math.floor(new Date(toDate).getTime() / 1000)
+
+      var payload = {
+        page_size: limit,
+        cursor: nextCursor,
+        create_time_from,
+        create_time_to
+      }
+
+      return { payload }
+    },
+    async normalize(res, { store }) {
+      const { data } = res
+
+      var more: boolean = data?.more || false
+      var nextCursor: string = more ? data.next_cursor : null
+      const packageList: any[] = data?.package_list || []
+
+      let results: any[] = []
+      for (let i = 0; i < packageList.length; i++) {
+        const packageObj: any = packageList[i]
+        const packageDetail: any = await StoreAPI.getStoreOrderPackage(store, { packageId: packageObj.package_id })
+
+        results.push({ ...packageDetail })
+      }
+
+      return { results, more, nextCursor }
+    }
+  }
+}