菜鸟电子面单云打印取号接口
菜鸟电子面单云打印取号接口,一次最多可以取号100个,多个订单放到请求报文的tradeOrderInfoDtos集合中。
1.请求参数:
参数名 | 类型 | 说明 | 示例 |
---|---|---|---|
appid | String | 合作伙伴AppId | uwkahf@jfs92 |
timestamp | String | 当前时间戳 | |
seller_nick | String | 授权菜鸟账号,非店铺名称 | kingdo |
sign | String | 接口签名 | 如何计算生成见示例代码 |
业务参数
参数名称 | 参数类型 | 是否必须 | 示例值 | 参数描述 |
---|---|---|---|---|
request_data | json | 是 | 电子面单取号参数 |
request_data的示例
{
"cpCode" : "SF",
"sender" : {
"address" : {
"city" : "上海市",
"detail" : "江桥镇金园四路23232号",
"district" : "嘉定区",
"province" : "上海",
"town" : ""
},
"mobile" : "13800138000",
"name" : "张三",
"phone" : "",
"tid" : "",
"caid" : ""
},
"tradeOrderInfoDtos" : [ {
"logisticsServices" : "",
"objectId" : "test001",
"orderInfo" : {
"orderChannelsType" : "OTHERS",
"tradeOrderList" : [ "1234567890" ]
},
"packageInfo" : {
"id" : "PKG003",
"items" : [ {
"count" : 1,
"name" : "商品A"
} ],
"volume" : null,
"weight" : null,
"totalPackagesCount" : null,
"packagingDescription" : "",
"goodsDescription" : "文件"
},
"recipient" : {
"address" : {
"city" : "深圳市",
"detail" : "深南大道10000号",
"district" : "南山区",
"province" : "广东",
"town" : ""
},
"mobile" : "13900139000",
"name" : "李四",
"phone" : "",
"tid" : "",
"caid" : ""
},
"templateUrl" : "https://cloudprint.cainiao.com/template/standard/474941/38",
"userId" : null,
"deliverExtendInfo" : "",
"extraInfo" : ""
} ],
"storeCode" : "",
"resourceCode" : "",
"dmsSorting" : null,
"needEncrypt" : true,
"multiPackagesShipment" : null,
"extraInfo" : "{\"payMethod\":\"1\"}",
"customerCode" : "",
"brandCode" : "SF",
"productCode" : "",
"callDoorPickUp" : null,
"doorPickUpTime" : "",
"doorPickUpEndTime" : ""
}
完整的请求参数字段,参见https://open.cainiao.com/api-doc/detail?category=link&type=merchant_electronic_sheet&apiId=TMS_WAYBILL_GET
2. 请求示例代码(Java)
@Test
public void caiNiaoTmsWaybillGet() throws Exception {
String reqData = "{\n" + " \"cpCode\" : \"SF\",\n" + " \"sender\" : {\n" + " \"address\" : {\n" + " \"city\" : \"上海市\",\n" + " \"detail\" : \"江桥镇金园四路东\",\n" + " \"district\" : \"嘉定区\",\n" + " \"province\" : \"上海\",\n" + " \"town\" : \"\"\n" + " },\n" + " \"mobile\" : \"13800138000\",\n" + " \"name\" : \"张三\",\n" + " \"phone\" : \"\",\n" + " \"tid\" : \"\",\n" + " \"caid\" : \"\"\n" + " },\n" + " \"tradeOrderInfoDtos\" : [ {\n" + " \"logisticsServices\" : \"\",\n" + " \"objectId\" : \"test001\",\n" + " \"orderInfo\" : {\n" + " \"orderChannelsType\" : \"OTHERS\",\n" + " \"tradeOrderList\" : [ \"1234567890\" ]\n" + " },\n" + " \"packageInfo\" : {\n" + " \"id\" : \"PKG003\",\n" + " \"items\" : [ {\n" + " \"count\" : 1,\n" + " \"name\" : \"商品A\"\n" + " } ],\n" + " \"volume\" : null,\n" + " \"weight\" : null,\n" + " \"totalPackagesCount\" : null,\n" + " \"packagingDescription\" : \"\",\n" + " \"goodsDescription\" : \"文件\"\n" + " },\n" + " \"recipient\" : {\n" + " \"address\" : {\n" + " \"city\" : \"深圳市\",\n" + " \"detail\" : \"深南大道10000号\",\n" + " \"district\" : \"南山区\",\n" + " \"province\" : \"广东\",\n" + " \"town\" : \"\"\n" + " },\n" + " \"mobile\" : \"13900139000\",\n" + " \"name\" : \"李四\",\n" + " \"phone\" : \"\",\n" + " \"tid\" : \"\",\n" + " \"caid\" : \"\"\n" + " },\n" + " \"templateUrl\" : \"https://cloudprint.cainiao.com/template/standard/474941/38\",\n" + " \"userId\" : null,\n" + " \"deliverExtendInfo\" : \"\",\n" + " \"extraInfo\" : \"\"\n" + " } ],\n" + " \"storeCode\" : \"\",\n" + " \"resourceCode\" : \"\",\n" + " \"dmsSorting\" : null,\n" + " \"needEncrypt\" : true,\n" + " \"multiPackagesShipment\" : null,\n" + " \"extraInfo\" : \"{\\\"payMethod\\\":\\\"1\\\"}\",\n" + " \"customerCode\" : \"\",\n" + " \"brandCode\" : \"SF\",\n" + " \"productCode\" : \"\",\n" + " \"callDoorPickUp\" : null,\n" + " \"doorPickUpTime\" : \"\",\n" + " \"doorPickUpEndTime\" : \"\"\n" + "}";
Map<String, String> data = new HashMap<String, String>();
data.put("appid", Config.AppId);
data.put("seller_nick", Config.CaiNiaoSellerNick);
Long timestamp = System.currentTimeMillis() / 1000;
data.put("timestamp", timestamp.toString());
data.put("request_data","reqData" );
// 参数签名
data.put("sign", Utils.Sign(data,Config.AppSecret));
doHttpRequest(Config.CaiNiaoTmsWaybillGet, data);
}
3. 返回结果如下:
{
"code": 0,
"message": "ok",
"data": [
{
"objectId": "test001",
"waybillCode": "SF328178xxxxx",
"printData": "{\"encryptedData\":\"AES:rU904rj6UH2oqfSUb43+Z199vDU2TLZvI9FiRxe849U40jVdd1uwOMU8V5uy2rbtBmqcbp+zOrNnrTQamk/6ftoQhFjvmGX0xyruzYYueMmWLu1MK08rbUOXpJMHdaud/+T+bvkSF+xwhEvdYcvRHL1yp+6u/FoT3Fa9ppnxembcIupDgDgvp7hLw18Txk7CBCGwlLYZhoZL4xN8mts=\",\"signature\":\"MD:ev+Ir+V4g99MEEdI4QX/LA==\",\"templateURL\":\"https://cloudprint.cainiao.com/template/standard/474941/38\",\"ver\":\"waybill_print_secret_version_1\"}",
"parentWaybillCode": "",
"extraInfo": "{\"proCode\":\"特快\",\"remark\":\"\",\"limitTypeCode\":\"T4\"}",
"cpCode": "SF",
"realCpCode": "SF",
"code": 0,
"message": ""
}
],
"trace_id": "31badedf-353e-427b-bfd6-2c1ceb57d5cf"
}
说明: code为0表示成功,非0为失败,message会包含失败原因。由允许多个订单号取号,每个订单的成功与否,见data内层的code(0表示成功,非0为失败) 和message。
文档更新时间: 2025-09-25 23:47 作者:admin