1. 简介

QLINK第三方平台标准接口文档

2. 环境要求及基础约定

授权: accessId（客户ID/平台应用ID）、secretKey（密钥/平台秘钥，用于验证报文信息）。

接口地址：第三方提供服务地址供IVS调用。

请求方式：

• Method: POST
• Content-Type: application/json

header参数:

AuthorInfo 授权具体信息

公共响应:

签名方式:

1、将appKey和content组成json字符串{"appKey":"appKey","content":"具体业务参数"}，content为空时{"appKey":"appKey"}

2、将第三方分配的客户appSecret添加到json的末尾，得到待加密字串{"appKey":"appKey","content":"具体业务参数"}appSecret

3、对待加密字串做sha1加密得到签名（org.apache.commons.codec.digest.DigestUtils.sha1Hex(待加密字串)）

4、将签名赋值到公共请求的sign字段

服务请求地址(Service Endpoints)

3. 获取Token

POST /global-api/v1/platform/getToken

接口参数:

返回信息:

请求示例:

{
  "platform": "MOMO",
  "code": "AUTH_CODE_123",
  "onlineShopId": "shop123",
  "redirectUri": "https://your-app.com/callback"
}

返回示例:

{
  "success": true,
  "message": "",
  "accessToken": "ACCESS_TOKEN_XXX",
  "accessExpiresIn": 3600,
  "refreshToken": "REFRESH_TOKEN_YYY",
  "refreshExpiresIn": 14400,
  "onlineShopId": "shop123",
  "country": "sg"
}

4. 刷新Token

POST /global-api/v1/platform/refreshToken

接口参数:

返回信息:

请求示例:

{
  "platform": "MOMO",
  "refresh_token": "REFRESH_TOKEN_YYY",
  "onlineShopId": "shop123"
}

返回示例:

{
  "success": true,
  "message": "",
  "accessToken": "ACCESS_TOKEN_NEW",
  "accessExpiresIn": 3600,
  "refreshToken": "REFRESH_TOKEN_NEW",
  "refreshExpiresIn": 14400,
  "onlineShopId": "shop123",
  "country": "sg"
}

5. 获取订单信息

POST /global-api/v1/platform/getOrder

接口参数:

返回信息:

orderInfo(订单详情)

orderTag(订单标记)

buyerInfo(买家信息)

onlineOrderInfo(线上报文信息)

orderSku(线上订单明细)

请求示例:{

{
    "accessId": "787878787",
    "content": "{\"onlineOrderIdList\":[\"111\"],\"pageNo\":1,\"pageSize\":100,\"platform\":\"MOMO\",\"shopId\":108874}",
    "sign": "856e36c54c62b6c501df7a9801e84a9adff80e06",
    "method": "getOrder"
}

返回示例:

{
    "success": true,
    "message": "",
    "isLastPage": true,
    "currentPageNo": 1,
    "pageCount": 5,
    "extraPlatform": "examplePlatform",
    "orderInfoList": [
        {
            "shopId": 108874,
            "onlineShopId": "shop123",
            "onlineOrderId": "order1234567",
            "payTime": 1735641983000,
            "createTime": 1735641983000,
            "onlineOrderStatus": "cancel",
            "erpOrderStatus": "CLOSED",
            "buyerMessage": "Please ship fast",
            "sellerRemarks": "Special discount applied",
            "platformShippingTime": 1735641983000,
            "platformDeliveryTime": 1735641983000,
            "lastShipTime": 1735641983000,
            "shippingServiceSelected": "Express",
            "carrier": "Carrier123",
            "carrierName": "Example Carrier",
            "trackingNumber": "track123",
            "platformWarehouseId": "warehouse123",
            "platformWarehouse": "Main Warehouse",
            "currency": "USD",
            "paymentMethod": "PAY_ONLINE",
            "codPayAmount": 100,
            "freight": 10,
            "totalAmount": 110,
            "sellerDiscount": 5,
            "platformRebate": 2,
            "totalDiscount": 7,
            "buyerPaidShippingFee": 8,
            "platformReturnToSeller": 3,
            "orderTags": {
                "onlineShipped": 1,
                "platformFulfillment": 0,
                "preSale": 0
            },
            "buyerInfo": {
                "buyerName": "John Doe",
                "receiverName": "Jane Doe",
                "country": "USA",
                "province": "California",
                "city": "Los Angeles",
                "district": "Downtown",
                "postCode": "90001",
                "address": "123 Main St",
                "phone": "123-456-7890",
                "email": "john.doe@example.com"
            },
            "onlineOrderInfo": {
                "onlineOrderId": "order123",
                "lastModifyTime": 1735641983006,
                "orderJson": "{\"key\":\"value\"}"
            },
            "orderSkuList": [
                {
                    "onlineTransactionId": "trans123",
                    "onlineSkuTitle": "Product Title",
                    "onlineSkuCode": "sku123",
                    "onlineItemId": "item123",
                    "currency": "USD",
                    "onlineSkuQuantity": 2,
                    "itemPrice": 50,
                    "totalTax": 5,
                    "shippingPrice": 2,
                    "originalPrice": 60,
                    "paymentPrice": 55,
                    "payAmount": 110,
                    "itemTax": 3,
                    "shippingTax": 1,
                    "discountPrice": 5,
                    "totalDiscountedPrice": 50,
                    "discountFromPlatform": 2,
                    "discountFromSeller": 3
                }
            ]
        }
    ]
}

6. 推送订单信息(外部服务推送至IVSERP)

POST /global-api/v1/platform/pushOrder

接口参数:

orderTag(订单标记)

buyerInfo(买家信息)

onlineOrderInfo(线上报文信息)

orderSku(线上订单明细)

返回信息:

请求示例:

{
  "platform": "MOMO",
  "shopId": 108874,
  "onlineShopId": "shop123",
  "onlineOrderId": "order1234567",
  "payTime": 1735641983000,
  "createTime": 1735641983000,
  "onlineOrderStatus": "cancel",
  "erpOrderStatus": "CLOSED",
  "buyerMessage": "Please ship fast",
  "sellerRemarks": "Special discount applied",
  "platformShippingTime": 1735641983000,
  "platformDeliveryTime": 1735641983000,
  "lastShipTime": 1735641983000,
  "shippingServiceSelected": "Express",
  "carrier": "Carrier123",
  "carrierName": "Example Carrier",
  "trackingNumber": "track123",
  "platformWarehouseId": "warehouse123",
  "platformWarehouse": "Main Warehouse",
  "currency": "USD",
  "paymentMethod": "PAY_ONLINE",
  "codPayAmount": 100,
  "freight": 10,
  "totalAmount": 110,
  "sellerDiscount": 5,
  "platformRebate": 2,
  "totalDiscount": 7,
  "buyerPaidShippingFee": 8,
  "platformReturnToSeller": 3,
  "orderTags": {
    "onlineShipped": 1,
    "platformFulfillment": 0,
    "preSale": 0
  },
  "buyerInfo": {
    "buyerName": "John Doe",
    "receiverName": "Jane Doe",
    "country": "USA",
    "province": "California",
    "city": "Los Angeles",
    "district": "Downtown",
    "postCode": "90001",
    "address": "123 Main St",
    "phone": "123-456-7890",
    "email": "john.doe@example.com"
  },
  "onlineOrderInfo": {
    "onlineOrderId": "order123",
    "lastModifyTime": 1735641983006,
    "orderJson": "{\"key\":\"value\"}"
  },
  "orderSkuList": [
    {
      "onlineTransactionId": "trans123",
      "onlineSkuTitle": "Product Title",
      "onlineSkuCode": "sku123",
      "onlineItemId": "item123",
      "currency": "USD",
      "onlineSkuQuantity": 2,
      "itemPrice": 50,
      "totalTax": 5,
      "shippingPrice": 2,
      "originalPrice": 60,
      "paymentPrice": 55,
      "payAmount": 110,
      "itemTax": 3,
      "shippingTax": 1,
      "discountPrice": 5,
      "totalDiscountedPrice": 50,
      "discountFromPlatform": 2,
      "discountFromSeller": 3
    }
  ]
}

返回示例:

{
  "result": {
    "shopId": 108874,
    "onlineShopId": "shop123",
    "onlineOrderId": "order1234567"
  },
  "state": "success"
}

7. 获取订单线上状态信息

POST /global-api/v1/platform/getOrderOnlineStatus

接口参数:

返回信息:

OnlineStatus:

请求示例:

{
  "platform": "MOMO"
}

返回示例:

{
  "success": true,
  "message": "",
  "finishStatusList": [
    {
      "onlineStatus": "COMPLETED",
      "onlineStatusCn": "已完成",
      "onlineStatusEn": "Completed"
    }
  ],
  "cancelStatusList": [
    {
      "onlineStatus": "CANCELLED",
      "onlineStatusCn": "已取消",
      "onlineStatusEn": "Cancelled"
    }
  ]
}

8. 反馈平台发货(RTS)

POST /global-api/v1/platform/readyToShip

接口参数:

onlineOrderItem(包裹商品明细)

返回信息:

请求示例:

{
  "platform": "MOMO",
  "shopId": 108874,
  "onlineShopId": "shop123",
  "onlineOrderId": "order1234567",
  "trackingNumber": "track123",
  "platformLogisticsCode": "LOGI001",
  "onlineOrderItemList": [
    {
      "onlineOrderItemId": "detail001",
      "quantity": 2
    }
  ]
}

返回示例:

{
  "success": true,
  "message": "",
  "onlineShopId": "shop123",
  "onlineOrderId": "order1234567"
}

9. 获取商品信息

POST /global-api/v1/platform/getProduct

接口参数:

返回信息:

itemInfo(商品详情信息)

warehouseStock(多仓库存信息)

请求示例:

{
  "platform": "MOMO",
  "shopId": 108874,
  "onlineShopId": "shop123",
  "onlineItemId": ["2222"],
  "pageNo": 1,
  "pageSize": 100
}

返回示例:

{
  "success": true,
  "message": "",
  "isLastPage": true,
  "currentPageNo": 1,
  "pageCount": 5,
  "extraPlatform": "examplePlatform",
  "shopId": 1234567890,
  "onlineShopId": "shop123",
  "itemInfoList": [
    {
      "onlineItemId": "item123dfdf",
      "onlineSkuId": "sku123dfdf",
      "extraSkuId": "extrasku12dfdf3",
      "onlineSkuCode": "sku123cvcv",
      "imageUrl": "https://example.com/image.jpg",
      "onlineSkuStatus": "ACTIVE",
      "onlineSkuTitle": "Product Title",
      "onlineSkuName": "Product Name",
      "onlineSKuStock": 100,
      "weight": 0.5,
      "weightUnit": "kg",
      "color": "Red",
      "size": "M",
      "length": 30,
      "width": 20,
      "height": 10,
      "dimensionUnit": "cm",
      "price": 29.99,
      "warehouseStockList": [
        {
          "platformWarehouseId": "warehouse123",
          "availableStock": 50
        },
        {
          "platformWarehouseId": "warehouse456",
          "availableStock": 30
        }
      ]
    },
    {
      "onlineItemId": "item456",
      "onlineSkuId": "sku456",
      "extraSkuId": "extrasku456",
      "onlineSkuCode": "code456",
      "imageUrl": "https://example.com/image2.jpg",
      "onlineSkuStatus": "INACTIVE",
      "onlineSkuTitle": "Another Product Title",
      "onlineSkuName": "Another Product Name",
      "onlineSKuStock": 200,
      "weight": 1,
      "weightUnit": "kg",
      "color": "Blue",
      "size": "L",
      "length": 40,
      "width": 30,
      "height": 20,
      "dimensionUnit": "cm",
      "price": 49.99,
      "warehouseStockList": [
        {
          "platformWarehouseId": "warehouse789",
          "availableStock": 100
        }
      ]
    }
  ]
}

10. 获取商品状态

POST /global-api/v1/platform/getProductStatus

接口参数:

返回信息:

OnlineStatus:

请求示例:

{
  "platform": "MOMO"
}

返回示例:

{
  "success": true,
  "message": "",
  "statusList": [
    {
      "onlineStatus": "ACTIVE",
      "onlineStatusCn": "上架",
      "onlineStatusEn": "Active"
    },
    {
      "onlineStatus": "INACTIVE",
      "onlineStatusCn": "下架",
      "onlineStatusEn": "Inactive"
    }
  ]
}

11. 更新商品库存

POST /global-api/v1/platform/updateInventory

接口参数:

SellerStock(平台库存信息)

返回信息:

Failure(失败信息)

请求示例:

{
  "platform": "MOMO",
  "shopId": 108874,
  "onlineShopId": "shop123",
  "onlineItemId": "item123",
  "onlineSkuId": "sku123",
  "onlineStock": 100,
  "sellerStockList": [
    {
      "platformWarehouseId": "warehouse123",
      "availableStock": 80
    }
  ]
}

返回示例:

{
  "success": true,
  "message": "",
  "failureList": [
    {
      "onlineItemId": "123",
      "onlineSkuId": "item123",
      "platformWarehouseId": "warehouse123",
      "failedReason": "库存不足"
    }
  ]
}

12. 平台物流

12.1. 初始化物流信息

POST /global-api/v1/platform/initLogistics

接口参数:

返回信息:

LogisticsInfo 线上物流信息

请求示例:

{
  "platform": "MOMO",
  "shopId": 108874,
  "onlineShopId": "1111"
}

返回示例:

{
  "success": true,
  "message": "",
  "onlineShopId": "1111",
  "shopId": 1234,
  "logisticsInfoList": [
    { "logisticsCode": "物流code1", "logisticsName": "物流name1" },
    { "logisticsCode": "物流code2", "logisticsName": "物流name2" }
  ]
}

12.2. 获取运单号

POST /global-api/v1/platform/getTrackNumber

接口参数:

onlineItemInfo(线上商品信息)

返回信息:

labelData(面单数据信息)

请求示例:

{
  "platform": "MOMO",
  "shopId": 108874,
  "onlineShopId": "1111",
  "onlineOrderId": "order12345",
  "logisticsCode": "物流code1",
  "logisticsName": "物流name1",
  "onlineItemInfoList": [
    {
      "packNumber": "P001",
      "onlineItemId": "item123",
      "onlineSkuId": "sku123",
      "quantity": 2
    }
  ]
}

返回示例:

{
  "success": true,
  "message": "",
  "onlineShopId": "1111",
  "trackNumber": "123123123",
  "shippingCarrier": "123123",
  "labelDataList": [
    {
      "labelDataType": "URL",
      "labelData": "1111111"
    }
  ]
}

12.3. 取消运单号

POST /global-api/v1/platform/cancelLogisticsOrder

接口参数:

onlineItemInfo(线上商品信息)

返回信息:

请求示例:

{
  "platform": "MOMO",
  "shopId": 108874,
  "onlineShopId": "1111",
  "onlineOrderId": "order12345",
  "trackNumber": "123123123",
  "cancelReason": "customer_cancel"
}

返回示例:

{
  "success": true,
  "message": "",
  "shopId": 108874,
  "onlineShopId": "1111",
  "onlineOrderId": "order12345"
}

12.4. 获取面单

POST /global-api/v1/platform/getLabelData

接口参数:

onlineItemInfo(线上商品信息)

返回信息:

labelData(面单数据信息)

请求示例:

{
  "platform": "MOMO",
  "onlineShopId": "shop123",
  "onlineOrderId": "order12345",
  "logisticsCode": "LOGI001",
  "logisticsName": "物流name1"
}

返回示例:

{
  "success": true,
  "message": "",
  "onlineOrderId": "1111",
  "labelDataList": [
    {
      "labelDataType": "URL",
      "labelData": "https://seller.pgmall.my//index.php?route=common/order_details/printNinjaVanConnote&oid=1472701&h=1472701&ipr_token=7075e26c696f676f6c6431323f343e36123",
      "trackiNumber": "123123123",
      "shippingCarrier": "NINJAVAN"
    }
  ]
}

12.5. 物流节点信息获取

POST /global-api/v1/platform/getTrackingInfo

接口参数:

返回信息:

LogisticsEvent(物流详情信息)

请求示例:

{
  "platform": "MOMO",
  "onlineShopId": "shop123",
  "onlineOrderId": "order12345",
  "packageNumber": "PKG123"
}

返回示例:

{
  "success": true,
  "message": "",
  "onlineShopId": "shop123",
  "logisticsStatus": "IN_TRANSIT",
  "eventList": [
    {
      "event": "Your package is out for delivery.",
      "eventDate": 1735641983000
    }
  ]
}

13. 获取平台仓库

POST /global-api/v1/platform/getPlatformWarehouse

接口参数:

返回信息:

platformWarehouse(平台仓库信息)

请求示例:

{
  "platform": "MOMO",
  "shopId": 108874,
  "onlineShopId": "sdsd"
}

返回示例:

{
  "success": true,
  "messgae": "",
  "shopId": 1111,
  "onlineShopId": "sdsd",
  "platformWarehouseList": [
    {
      "platformWarehouseCode": "12112",
      "platformWarehouseName": "wwweww"
    },
    {
      "platformWarehouseCode": "32323",
      "platformWarehouseName": "sfaf"
    }
  ]
}