1. 简介

需要对接千易的第三方仓，需要看此文档

订单业务流程示意图：

2. 环境要求

授权：accessId（客户 ID）、secretKey（密钥，用于验证报文信息）。

接口地址：第三方提供服务地址供千易调用。 请求方式：

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

公共请求:

header参数:

公共响应:

签名方式:

1、将 accessId 和 content 组成 json 字符串

{"accessId":"accessId","content":" 具体业务参数 "} ， content 为空 时

{"accessId":"accessId"}

2、将第三方分配的客户 secretKey 添加到 json 的末尾，得到待加密字串

{"accessId":"accessId","content":"具体业务参数"}secretKey

3、对待加密字串做 sha1 加密得到签名

（org.apache.commons.codec.digest.DigestUtils.sha1Hex(待加密字串)）

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

加密前字符串样例： {"accessId":"ibxakq31y","content":"{\"pageSize\":1000,\"page\":1,\"warehouseCode\":\"WH000005\"}"}30534885b3eb4625c8c279822651683a

3. 仓库列表

描述： 获取所有的发货仓，用于后续下发入库单、库存同步、下发订单等流程

方法名:

• warehouses

返回信息:

请求示例:

{
    "accessId": "3215435",
    "method": "warehouses",
    "content": "",
    "sign": "11fbd649164860b5571cb60dfc99baccb375f392"
}

返回示例:

{
    "success": "true",
    "message": "",
    "warehouseList": [
        {
            "warehouseCode": "CA1",
            "warehouseName": "CA Warehouse"
        },
        {
            "warehouseCode": "CA2",
            "warehouseName": " CA Warehouse 2"
        }
    ]
}

4. 仓库物流列表

描述： 订单在erp审核的时候是要选物流的，我们支持仓库提供物流列表，用户在erp选择后就下发给仓库，channels接口就是用于获取仓库支持哪些物流的

方法名:

• channels

接口参数:

返回信息:

请求示例:

{
    "accessId": "3215435",
    "method": "channels",
    "content": "",
    "sign": "11fbd649164860b5571cb60dfc99baccb375f392"
}

返回示例:

{
    "success": "true",
    "message": "",
    "channelList": [
        {
            "channelCode": "FedexGround",
            "channelName": "FedEx Ground",
            "carrierName": "FEDEX"
        }
    ]
}

5. 创建订单

描述： 在千易创建订单后会向仓库请求创建订单，以便仓库备货、发货

方法名:

• createOrder

接口参数:

请求示例:

{
    "accessId": "3215435",
    "method": "createOrder",
    "content": "{\"orderNumber\":\"CESH210204147401\",\"onlineOrderId\":\"11319575377 9\",\"shopName\":\"测试\",\"logisticsCode\":\"FedexGround\",\"platform\":\"tiktok\",\"warehouseCode\":\"QY_01\",\"fr eight\":20.0,\"receiver\":{\"name\":\"Kimberly White\",\"phone\":\"1889838055188\",\"email\":\"\",\"country\":\"US\",\"state\":\"AR\",\"city\":\"Harrison\",\"district\":\"null\",\"address1\": \"TestStreet1\",\"address2\":\"\",\"postalCode\":\"72601\"},\"skuLi st\":[{\"sku\":\"CL0000000000001\",\"name\":null,\"quantity\":1,\"amo unt\":120.0,\"shippingPrice\":20.0,\"hsCode\":\"CL0000000000001\",\"chineseCustomsDeclarationName\":\" 测 试 商 品\",\"englishCustomsDeclarationName\":\"TEST\"}]}",
    "sign": "11fbd649164860b5571cb60dfc99baccb375f392"
}

返回示例:

{
    "success": "true",
    "message": "",
    "data": {
        "warehouseOrderNumber": "S111111-09987666"
    }
}

6. 取消订单

描述： 用于千易向仓库取消订单

方法名:

• cancelOrder

接口参数:

请求示例:

{
    "accessId": "3215435",
    "method": " cancelOrder",
    "content": " {\"orderNumber\":\"CESH210204147401\",\"warehouseOrderNumber\":\"CESH210204147401\"}",
    "sign": "11fbd649164860b5571cb60dfc99baccb375f392"
}

返回示例:

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

7. 查询订单信息

描述： 用于同步仓库的运单号、订单状态到千易

方法名:

• getOrder

接口参数:

返回信息:

请求示例:

{
    "accessId": "3215435",
    "method": " getOrder",
    "content": " {\"orderNumber\":\"CESH210204147401\"}",
    "sign": "11fbd649164860b5571cb60dfc99baccb375f392"
}

返回示例:

{
    "success": "true",
    "message": "",
    "data": {
        "orderNumber": "S0000001",
        "wmsStatus": "Shipped",
        "status": "SUCCESS",
        "carrierName": "FEDEX",
        "trackingNumber": "TEST0001"
    }
}

8. 库存同步

描述： 同步仓库的sku、sku库存信息到千易

方法名:

• syncInventory

接口参数:

请求示例:

{
    "accessId": "3215435",
    "method": " syncInventory",
    "content": " {\"pageSize \":\"50\",\"page \":\"1\",\"warehouseCode\":\"wms\",\"warehouseSku \":\"sku\"}",
    "sign": "11fbd649164860b5571cb60dfc99baccb375f392"
}

返回示例:

{
    "success": "true",
    "message": "",
    "isLastPage": true,
    "currentPage": 1,
    "pageCount": 1,
    "data": [
        {
            "warehouseCode": "wms",
            "warehouseSku": "sku",
            "onwayQuantity": "11",
            "pendingQuantity": "22",
            "sellableQuantity": "33",
            "unsellableQuantity": "0",
            "reservedQuantity": "22",
            "useQuantity": "11",
            "totalQuantity": "99"
        }
    ]
}

9. 入库单创建

描述： 在千易创建入库单后会向仓库请求创建入库单，目的是增加仓库sku的库存

方法名:

• createAsnOrder

接口参数:

请求示例:

{
    "accessId": "67436532",
    "method": "createAsnOrder",
    "content": "{\"skuList\":[{\"sku\":\"CLO-CNQM5069BL\",\"quantity\":2}],\"trackNumber\":\"A240925139551\",\"asnNumber\":\"A240925139551\",\"asnMarkSku\":[{\"sku\":\"CLO-CNQM5069BL\",\"quantity\":2,\"markCode\":\"QY556553-A240925139551-1\",\"boxNumber\":\"1\",\"length\":1.0,\"width\":1.0,\"height\":1.0}],\"estimatedArrivalDate\":null,\"warehouseCode\":\"53\"}",
    "sign": "1f04df03d527653ab65beafb4aa59c778ff3bd73"
}

返回示例:

{
    "success": true,
    "message": "",
    "results": [
        {
            "asnNumber": "A1234",
            "operation": "CANCEL",
            "info": ""
        }
    ]
}

10. 入库单查询

方法名: 描述： 用于同步仓库入库单的状态

• getAsnList

接口参数:

11. 入库单状态

请求示例:

{
    "accessId": "3215435",
    "method": " getAsnList",
    "content": " {\"asnNumbers\":[\"CESH210204147401\",\"warehouseCode\":\"warehouse1\"]}",
    "sign": "11fbd649164860b5571cb60dfc99baccb375f392"
}

返回示例:

{
    "success": "true",
    "message": "",
    "asnList": [
        {
            "asnNumber": "sja11122",
            "wmsStatus": "NEW",
            "finishTime": "2024-10-26 12:23:34",
            "referenceNumber": "A123445",
            "skuList": [
                {
                    "sku": "acs",
                    "name": "杯子",
                    "estimatedQuantity": 12,
                    "receivedQuantity": 12,
                    "goodQuantity": 5,
                    "badQuantity": 7
                }
            ]
        }
    ]
}

12. 入库单取消

描述： 用于取消仓库入库单

方法名:

• cancelAsnOrder

接口参数:

请求示例:

{
    "accessId": "3215435",
    "method": " cancelAsnOrder",
    "content": " {\"asnNumbers\":[\"CESH210204147401\"],\"warehouseCode\":\"warehouse1\"}",
    "sign": "11fbd649164860b5571cb60dfc99baccb375f392"
}

返回示例:

{
    "success": true,
    "message": "",
    "results": [
        {
            "asnNumber": "A1234",
            "operation": "CANCEL",
            "info": ""
        }
    ]
}

13. 商品下发仓库

描述： 在千易创建商品sku和仓库sku后下发映射关系给仓库，以便维护千易和仓库的sku映射关系,仓库商品不存在新建，存在则更新

方法名:

• insert_sku_info

接口参数:

请求示例:

{
    "method": "insert_sku_info",
    "accessId": "67436532",
    "content": "{\"itemPackage\":null,\"dimensionUnit\":\"cm\",\"length\":\"1\",\"weight\":\"1\",\"title\":\"A1234名称\",\"specifications\":\"黄-M\",\"warehouseCode\":\"53\",\"netWeight\":\"1\",\"imageUrl\":\"http://qianyierp-test.oss.aliyuncs.com/image/NjRhNzU5YWU3Y2M1NjI4YjZlNzIyZjJkYzUxYmYxNjk%3D.jpg\",\"width\":\"1\",\"sku\":\"A1234\",\"barcode\":\"A1234条码\",\"weightUnit\":\"KG\",\"height\":\"1\"}",
    "sign": "d6c07b78107f3fd6819e038257b9236a7e48e297"
}

返回示例:

{
    "success": true,
    "message": "",
    "results": [
        {
            "sku": "A1234",
            "operation": "CANCEL",
            "info": ""
        }
    ]
}

14. WebHooks

14.1. 出库单状态推送接口

描述：仓库将出库单信息推送至千易ERP，warehouseExtraType请联系千易为您提供

方法名:

• pushOrderInfo

POST /sys/automatic/receiveOdo/{warehouseExtraType}

接口参数:

sku 信息:

返回信息:

请求示例:

{
    "accessId": "QIANYI",
    "method": "pushOrderInfo",
    "content": "{\"orderNumber\":\"DA250117100074\",\"onlineOrderId\":\"\",\"warehouseCode\":\"XY002\",\"carrier\":\"\",\"trackNumber\":\"333\",\"warehouseOrderNumber\":\"\",\"wmsStatus\":\"error\",\"status\":\"FAILED\",\"skuList\":{\"sku\":\"60000-test02\",\"quantity\":4},\"errorMsg\":\"仓库接收失败\"}",
    "sign": "a125ee2d535ab0811c6d9f74d52a525534b3aee8"
}

返回信息:

{
    "success": true,
    "errorMsg": ""
}

14.2. 入库单推送接口

描述: 仓库将入库单信息推送至千易ERP，warehouseExtraType请联系千易为您提供

方法名:

• pushAsnInfo

POST /sys/automatic/receiveAsn/{warehouseExtraType}

接口参数:

返回信息:

请求示例:

{
    "accessId": "QIANYI",
    "method": "pushAsnInfo",
    "content": "{\"customerCode\":null,\"asnNumber\":\"A241022159999\",\"warehouseCode\":\"Test-bin\",\"wmsStatus\":\"RECEIVING\",\"referenceNumber\":\"A241022159999\",\"finishTime\":null,\"updateTime\":1744098883894,\"skuList\":{\"sku\":\"V-012B-R\",\"name\":\"V-012B-R\",\"estimatedQuantity\":121,\"receivedQuantity\":2,\"goodQuantity\":2,\"badQuantity\":0},\"batchNo\":\"222222-1\"}",
    "sign": "a125ee2d535ab0811c6d9f74d52a525534b3aee8"
}

返回信息

{
    "success": true,
    "errorMsg": ""
}

15. 入库单推送状态

智慧的跨境电商合作伙伴