1. Introduction

Standard Interface Documentation of Qianyi Third-Party Platform

2. Environmental Requirements and Basic Agreements

Authorization: accessId (customer ID / platform application ID), secretKey (secret key / platform secret key for verifying message information).

Interface address: The third party provides the service address for Qianyi to invoke.

Request Method:

• Method: POST
• Content-Type: application/x-www-form-urlencoded

Common Request:

headerParams:

AuthorInfo Specific Authorization Information

Common Response:

Signature Method:

1. Compose the json string {"accessId":"accessId","content":"Specific business Params"} with accessId and content. When content is empty, {"accessId":"accessId"}
2. Append the customer secretKey assigned by the third party to the end of the json to obtain the string to be encrypted {"accessId":"accessId","content":"Specific business Params"}secretKey
3. Perform sha1 encryption on the string to be encrypted (org.apache.commons.codec.digest.DigestUtils.sha1Hex(string to be encrypted))
4. Assign the signature to the sign field of the common request

Service Request Address (Service Endpoints)

Request domain name: The corresponding request address is provided by the docking service provider

Platform Authorization Field Mapping Relationship

3. Obtain Token

Method Name:

• getToken

POST /extApi/platform/getToken

Interface Params:

Return Information:

Request | Sample:

{

}

Return | Sample:

4. Refresh Token

Method Name:

• refreshToken

POST /extApi/platform/refreshToken

Interface Params:

Return Information:

Request | Sample:

Return | Sample:

5. Push Authorization Information (Pushed by Qianyi ERP to External Services)

Method Name:

• pushAuthorizationInfo

POST /extApi/platform/pushAuthorizationInfo

Interface Params:

Return Information:

Request | Sample:

{
    "accessId": "787878787",
    "content": "{\"platform\":\"MOMO\",\"shopId\":108894,\"wobHookUrl\":\"https://www.qianyierp.com\"}",
    "sign": "18a5182a8d3f09577dd48ac4ef2da615809d25ba",
    "method": "pushAuthorizationInfo"
}

Return | Sample:

{
    "success": true,
    "message": "",
    "shopId": 108894
}

6. Obtain Order Information

Method Name:

• getOrder

POST /extApi/platform/getOrder

Interface Params:

Return Information:

orderInfo (Order Details)

orderTag (Order Tags)

buyerInfo (Buyer Information)

onlineOrderInfo (Online Message Information)

orderSku (Online Order Details)

Request | Sample:{

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

Return | Sample:

{
    "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
                }
            ]
        }
    ]
}

7. Push Order Information (Pushed by External Services to Qianyi ERP)

Method Name:

• pushOrder

POST /extApi/platform/pushOrder

Interface Params:

orderTag (Order Tags)

buyerInfo (Buyer Information)

onlineOrderInfo (Online Message Information)

orderSku (Online Order Details)

Return Information:

Request | Sample:

{
  "accessId": "787878787",
  "method": "pushOrder",
  "sign": "856e36c54c62b6c501df7a9801e84a9adff80e06",
  "content": "{
            "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
                }
            ]
        }"  
}

Return | Sample:

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

8. Get Order Online Status Information

Method Name:

• getOrderOnlineStatus

POST /extApi/platform/getOrderOnlineStatus

Interface Params:

Return Information:

OnlineStatus:

Request | Sample:

Return | Sample:

9. Feedback Platform Shipping (RTS)

Method Name:

• readyToShip

POST /extApi/platform/readyToShip

Interface Params:

onlineOrderItem (Package Item Details)

Return Information:

Request | Sample:

{
    "accessId": "787878787",
    "content": "{\"onlineSkuId\":\"item123\",\"platform\":\"MOMO\",\"shopId\":108874}",
    "sign": "4be109ea00dd93be2a5fad16f477a8bbec989e16",
    "method": "readyToShip"
}

Return | Sample:

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

10. Get Product Information

Method Name:

• getProduct

POST /extApi/platform/getProduct

Interface Params:

Return Information:

itemInfo (Product Detail Information)

warehouseStock (Multi-Warehouse Stock Information)

Request | Sample:

{
    "accessId": "787878787",
    "content": "{\"onlineItemId\":[\"2222\"],\"pageNo\":1,\"pageSize\":100,\"platform\":\"MOMO\",\"shopId\":108874}",
    "sign": "eb79547647d81907691d2033106b28171c05bc7e",
    "method": "getProduct"
}

Return | Sample:

{
    "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
                }
            ]
        }
    ]
}

11. Get Product Status

Method Name:

• getProductStatus

POST /extApi/platform/getProductStatus

Interface Params:

Return Information:

OnlineStatus:

Request | Sample:

Return | Sample:

12. Update Product Inventory

Method Name:

• updateInventory

POST /extApi/platform/updateInventory

Interface Params:

SellerStock (Platform Stock Information)

Return Information:

Failure (Failure Information)

Request | Sample:

{
    "accessId": "787878787",
    "content": "{\"onlineSkuId\":\"item123\",\"platform\":\"MOMO\",\"shopId\":108874}",
    "sign": "4be109ea00dd93be2a5fad16f477a8bbec989e16",
    "method": "updateInventory"
}

Return | Sample:

{
    "success": true,
    "message": "",
    "failureList": [
    {
        "onlineItemId":"123",
            "onlineSkuId":"item123"
    }
     ]
}

13. Platform Logistics

13.1. Initialize Logistics Information

Method Name:

• initLogistics

POST /extApi/platform/initLogistics

Interface Params:

Return Information:

LogisticsInfo Online logistics information

Request | Sample:

{
    "accessId":"787878787",
    "content":"{\"platform\":\"MOMO\",\"shopId\":108874}",
    "sign":"ec8e3bd387bc177db22ca4d8fdd4d8af49a52e4b"
}

Return | Sample:

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

13.2. Get trackingNumber

Method Name:

• getTrackNumber

POST /extApi/platform/getTrackNumber

Interface Params:

onlineItemInfo (Online Item Information)

Return Information:

labelData (Label Data Information)

Request | Sample:

{"accessId":"787878787","content":"{\"logisticsCode\":\"物流code1\",\"logisticsName\":\"物流name1\",\"onlineItemInfoList\":[{\"onlineItemId\":\"item123\",\"onlineSkuId\":\"sku123\",\"quantity\":2}],\"onlineOrderId\":\"order12345\",\"platform\":\"MOMO\",\"shopId\":108874}","sign":"3b95dae713298b5d63b679956874c1b3267e01f3"}

Return | Sample:

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

13.3. Cancel trackingNumber

Method Name:

• cancelLogisticsOrder

POST /extApi/platform/cancelLogisticsOrder

Interface Params:

onlineItemInfo (Online Item Information)

Return Information:

Request | Sample:

Return | Sample:

13.4. Get Label

Method Name:

• getLabelData

POST /extApi/platform/getLabelData

Interface Params:

onlineItemInfo (Online Item Information)

Return Information:

labelData (Label Data Information)

Request | Sample:

{"accessId":"787878787","content":"{\"onlineOrderId\":\"order12345\",\"platform\":\"MOMO\"}","sign":"3e93d3736a0ed6a0da1da39ae7ead2fd2a7493eb"}

Return | Sample:

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

13.5. Logistics Node Information Acquisition

Method Name:

• getTrackingInfo

POST /extApi/platform/getTrackingInfo

Interface Params:

Return Information:

LogisticsEvent (Logistics Details Information)

Request | Sample:

Return | Sample:

14. Get Platform Warehouse

Method Name:

• getPlatformWarehouse

POST /extApi/platform/getPlatformWarehouse

Interface Params:

Return Information:

platformWarehouse (Platform Warehouse Information)

Request | Sample:

{
    "accessId": "787878787",
    "content": "{\"extraPlatform\":\"MOMO\",\"shopId\":108874}",
    "sign": "1ac97de2845109b8f32d1d3c9303221064d33deb",
    "method": "getPlatformWarehouse"
}

Return | Sample:

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