快递公司寄件接口

一、商家寄件下单接口

选择快递公司进行下单。

1.1 接口格式

提供统一格式的HTTP POST或GET调用接口,并返回统一格式JSON数据。

1.2 请求地址

正式请求地址：https://poll.kuaidi100.com/order/borderapi.do（订单将推至快递公司）

沙箱请求地址：https://api.kuaidi100.com/apiMock/border（订单将不推至快递公司：沙箱下单后，可通过：调试工具-商家寄件-下单回调，调试订单各阶段状态。）

请求参数：

param数据结构：

1.3 返回结果

data数据结构

eOrder数据结构

注意：eOrder实际返回的字段各家快递公司不同，以实际返回为准

1.4 提供数据内容

请求参数示例

method = bOrder
key = ******
sign = 4BBDE07660E5EFF90873642CFAE9A8DD
t = 1647258957705
param = {
	"kuaidicom": "yuantong",
	"recManName": "王超",
	"recManMobile": "13800138000",
	"recManPrintAddr": "西藏日喀则市定日县珠穆朗玛峰",
	"sendManName": "王大",
	"sendManMobile": "13800138000",
	"sendManPrintAddr": "西藏日喀则市定日县珠穆朗玛峰",
	"cargo": "文件",
	"callBackUrl": "http: //www.baidu.com",
	"payment": "SHIPPER",
	"serviceType": "标准快递",
	"weight": "1",
	"remark": "",
	"salt": "",
	"dayType": "",
	"pickupStartTime": "",
	"pickupEndTime": "",
	"passwordSigning": "Y",
	"valinsPay": "",
	"op": "0",
	"pollCallBackUrl": "",
	"resultv2": "0",
	"returnType": "",
	"siid": "",
	"tempid": "",
	"printCallBackUrl": ""
}

返回结果示例

{
	"result": true,
	"returnCode": "200",
	"message": "提交成功",
	"data": {
		"taskId": "", // 任务ID
		"orderId": "" // 订单ID
		"kuaidinum": "" // 快递单号
		"eOrder": "[\"destName\":null,\"orgName\":null,\"pkgCode\":null,\"pkgName\":null,\"bulkpen\":\"上海-S33-K27-P\",\"orgExtra\":null}]"
	}
}

说明：

二、下单回调接口

订单有状态变更是会触发回调，回调后如果没有得到合作方正确返回，会重复回调多2次，即最多回调3次。间隔30分钟。

2.1 接口格式

提供统一格式的HTTP POST,并返回统一格式JSON数据。

请求报头：Content-Type=application/x-www-form-urlencoded;charset=UTF-8

2.2 请求地址

请求参数：

param数据结构：

data数据结构：

2.3 返回结果

2.4 提供数据内容

请求参数示例

taskId = ** ** **
	sign = ** ** **
	param = {
		"kuaidicom": "yuantong",
		"kuaidinum": "1234567890",
		"status": "200",
		"message": "成功",
		"data": {
			"orderId": "*****",
			"status": "0",
			"courierName": "王大",
			"courierMobile": "13800138000",
			"weight": "1",
			"defPrice": "15.0",
			"freight": "5.1",
			"volume": "120",
			"actualWeight": "1",
			"feeDetails": [{
				"feeType": "PACKAGINGFEE",
				"feeDesc": "包装费",
				"amount": "0.8",
				"payStatus": 1
			}]，
			"printTaskId": "*****",
			"imgBase64": "*****"


		}
	}

返回结果示例

{

		"result":true,

		"returnCode":"200",

		"message":"成功"

} 

2.4 回调响应报文及错误码解释

三、商家寄件下单取消接口

对下完单且取件前的订单进行取消操作。对于不需邮寄的订单请及时进行取消，当月订单最晚需在次月8日前取消，否则将无法取消。

3.1 接口格式

提供统一格式的HTTP POST或GET调用接口,并返回统一格式JSON数据。

3.2 请求地址

https://poll.kuaidi100.com/order/borderapi.do

请求参数：

param数据结构：

3.3 返回结果

3.4 提供数据内容

请求参数示例

method = cancel
key = ******
sign = 4BBDE07660E5EFF90873642CFAE9A8DD
t = 1647258957705
param = {
	"taskId": "*****",
	"orderId": "*****",
	"cancelMsg": "暂时不寄件了"
}

返回结果示例

{

		"result":true,

		"returnCode":"200",

		"message":"取消成功",

		"data":{}

} 

说明：

四、商家寄件下单价格接口

查看从出发地到目的地的价格

4.1 接口格式

提供统一格式的HTTP POST或GET调用接口,并返回统一格式JSON数据。

4.2 请求地址

https://poll.kuaidi100.com/order/borderapi.do

请求参数：

param数据结构：

4.3 返回结果

data数据结构：

4.4 提供数据内容

请求参数示例

method = price
key = ******
sign = 4BBDE07660E5EFF90873642CFAE9A8DD
t = 1647258957705
param = {
	"kuaidicom": "yuantong",
	"sendManPrintAddr": "西藏日喀则市定日县珠穆朗玛峰",
	"recManPrintAddr": "西藏日喀则市定日县珠穆朗玛峰",
	"weight": "1",
	"serviceType": "标准快递"
}

返回结果示例

​

{
	"data": {
		"firstPrice": "8.0",
		"defPrice": "8.0",
		"defFirstPrice": "8.0",
		"price": "8.0",
		"serviceType": "标准快递",
		"overPrice": "0",
		"defOverPrice": "0",
		"kuaidiCom": "zhongtong"
	},
	"message": "成功",
	"result": true,
	"returnCode": "200"
}

说明：

五、实时快递查询接口

下单后可携带pollToken请求该接口实时查询物流轨迹信息。

注意：请控制每一单查询频率至少在半小时以上，否则会造成锁单。

5.1 请求地址

https://poll.kuaidi100.com/poll/query.do

5.2 请求类型

post

5.3 输入参数

请求参数（header）

请求参数（body）

5.4 请求参数示例

    customer = **********
    sign = ******************
    pollToken = ******************
    param = {
        "com": "ems",
        "num": "em263999513jp",
        "phone": "13868688888",
        "from": "广东省深圳市南山区",
        "to": "北京市朝阳区",
        "resultv2": "4",
        "show": "0",
        "order": "desc"
    }

5.5 返回结果

5.6 运单快递状态（state)说明

注：如需物流状态高级状态名称及状态值需要 resultv2 传 “4” 返回

5.7 正确返回示例

JSON格式

{
    "message": "ok",
    "nu": "JT0004301991791",
    "ischeck": "0",
    "com": "jtexpress",
    "status": "200",
    "data": [
        {
            "time": "2021-12-15 17:19:28",
            "context": "【杭州市】您的包裹已存放至【驿站】，记得早点来取它回家！",
            "ftime": "2021-12-15 17:19:28",
            "areaCode": "CN330102000000",//本数据元对应的行政区域编码，resultv2=1或者resultv2=4才会展示
            "areaName": "浙江,杭州市,上城区",//本数据元对应的行政区域名称，resultv2=1或者resultv2=4才会展示
            "status": "投柜或驿站",//本数据元对应的物流状态名称或者高级物流状态名称，resultv2=1或者resultv2=4才会展示
            "location": "浙江省 杭州市 上城区", //本数据元对应的快件当前地点，resultv2=4才会展示
            "areaCenter": "120.184349,30.25446", //本数据元对应的行政区域经纬度，resultv2=4才会展示
            "areaPinYin": "shang cheng qu",//本数据元对应的行政区域拼音，resultv2=4才会展示
            "statusCode": "501"//本数据元对应的高级物流状态值，resultv2=4才会展示
        },
        {
            "time": "2021-12-15 14:17:31",
            "context": "【杭州市】【杭州网点】的极兔小哥正在派件",
            "ftime": "2021-12-15 14:17:31",
            "areaCode": "CN330102000000",
            "areaName": "浙江,杭州市,上城区",
            "status": "派件",
            "location": "浙江省 杭州市 上城区",
            "areaCenter": "120.184349,30.25446",
            "areaPinYin": "shang cheng qu",
            "statusCode": "5"
        },
        {
            "time": "2021-12-15 13:58:18",
            "context": "【杭州市】 快件到达【杭州网点】",
            "ftime": "2021-12-15 13:58:18",
            "areaCode": "CN330102000000",
            "areaName": "浙江,杭州市,上城区",
            "status": "在途",
            "location": "浙江省 杭州市 上城区",
            "areaCenter": "120.184349,30.25446",
            "areaPinYin": "shang cheng qu",
            "statusCode": "0"
        },
        {
            "time": "2021-12-15 04:11:20",
            "context": "【杭州市】快件离开【杭州转运中心】已发往【杭州江干四季青网点】",
            "ftime": "2021-12-15 04:11:20",
            "areaCode": "CN330109000000",
            "areaName": "浙江,杭州市,萧山区",
            "status": "干线",
            "location": "浙江省 杭州市 萧山区",
            "areaCenter": "120.493286,30.28333",
            "areaPinYin": "xiao shan qu",
            "statusCode": "1002"
        },
        {
            "time": "2021-12-15 02:09:52",
            "context": "【杭州市】 快件到达【杭州转运中心】",
            "ftime": "2021-12-15 02:09:52",
            "areaCode": "CN330109000000",
            "areaName": "浙江,杭州市,萧山区",
            "status": "干线",
            "location": "浙江省 杭州市 萧山区",
            "areaCenter": "120.493286,30.28333",
            "areaPinYin": "xiao shan qu",
            "statusCode": "1002"
        },
        {
            "time": "2021-12-14 21:08:34",
            "context": "【上海市】快件离开【上海浦西转运中心】已发往【杭州转运中心】",
            "ftime": "2021-12-14 21:08:34",
            "areaCode": "CN310118000000",
            "areaName": "上海,上海,青浦区",
            "status": "干线",
            "location": "上海 上海市 青浦区",
            "areaCenter": "121.124178,31.150681",
            "areaPinYin": "qing pu qu",
            "statusCode": "1002"
        },
        {
            "time": "2021-12-14 20:54:22",
            "context": "【上海市】 快件到达【上海浦西转运中心】",
            "ftime": "2021-12-14 20:54:22",
            "areaCode": "CN310118000000",
            "areaName": "上海,上海,青浦区",
            "status": "干线",
            "location": "上海 上海市 青浦区",
            "areaCenter": "121.124178,31.150681",
            "areaPinYin": "qing pu qu",
            "statusCode": "1002"
        },
        {
            "time": "2021-12-14 17:25:58",
            "context": "【上海市】快件离开【上海杨浦黄兴路网点】已发往【上海浦西转运中心】",
            "ftime": "2021-12-14 17:25:58",
            "areaCode": "CN310110000000",
            "areaName": "上海,上海,杨浦区",
            "status": "干线",
            "location": "上海 上海市 杨浦区",
            "areaCenter": "121.526077,31.259541",
            "areaPinYin": "yang pu qu",
            "statusCode": "1002"
        },
        {
            "time": "2021-12-14 09:03:58",
            "context": "【上海市】【上海杨浦黄兴路网点】已取件。",
            "ftime": "2021-12-14 09:03:58",
            "areaCode": "CN310110000000",
            "areaName": "上海,上海,杨浦区",
            "status": "揽收",
            "location": "上海 上海市 杨浦区",
            "areaCenter": "121.526077,31.259541",
            "areaPinYin": "yang pu qu",
            "statusCode": "1"
        }  
    ],
    "state": "5",
    "condition": "00",
    "routeInfo": {
        "from": {
            "number": "CN310110000000",
            "name": "上海,上海,杨浦区"
        },//本数据元对应的出发地城市信息，resultv2=4才会展示
        "cur": {
            "number": "CN330102000000",
            "name": "浙江,杭州市,上城区"
        },//本数据元对应的当前城市信息，resultv2=4才会展示
        "to": null
    },//本数据元对应的目的地城市信息，resultv2=4才会展示
    "isLoop": false
}
}

5.8 错误返回示例

JSON格式

{
    "result": false,
    "returnCode": "400",
    "message": "找不到对应公司"
}

5.9 信息代码含义

六、快递信息推送接口

6.1 推送请求地址

由贵司在下单开启订阅功能中通过pollCallBackUrl字段提供

6.2 推送请求类型

post

6.3 推送输入参数*（以下为订阅参数resultv2=1时的推送返回参数示例，如使用地图订阅（resultv2=3），接口推送返回参数请参考地图轨迹推送接口文档）

请求参数（header）

请求参数（body）

6.4 推送输入参数示例

{
	"status": "polling",
	"billstatus": "got",
	"message": "寄件",
	"lastResult": {
		"message": "ok",
		"nu": "YT6186594166532",
		"ischeck": "0",
		"com": "yuantong",
		"status": "200",
		"data": [{
				"time": "2021-12-15 20:15:14",
				"context": "【苏州转运中心】 已发出 下一站 【无锡转运中心公司】",
				"ftime": "2021-12-15 20:15:14",
				"areaCode": "CN320500000000",
				"areaName": "江苏,苏州市",
				"status": "干线",
				"location": "",
				"areaCenter": "120.585315,31.298886",
				"areaPinYin": "su zhou shi",
				"statusCode": "1002"
			},
			{
				"time": "2021-12-15 20:11:25",
				"context": "【苏州转运中心公司】 已收入",
				"ftime": "2021-12-15 20:11:25",
				"areaCode": "CN320500000000",
				"areaName": "江苏,苏州市",
				"status": "干线",
				"location": "",
				"areaCenter": "120.585315,31.298886",
				"areaPinYin": "su zhou shi",
				"statusCode": "1002"
			},
			{
				"time": "2021-12-15 19:18:27",
				"context": "【江苏省无锡市锡新开发区公司】 已收入",
				"ftime": "2021-12-15 19:18:27",
				"areaCode": "CN320200000000",
				"areaName": "江苏,无锡市",
				"status": "在途",
				"location": "",
				"areaCenter": "120.31191,31.491169",
				"areaPinYin": "wu xi shi",
				"statusCode": "0"
			},
			{
				"time": "2021-12-15 17:10:09",
				"context": "【江苏省苏州市北桥公司】 已揽收",
				"ftime": "2021-12-15 17:10:09",
				"areaCode": "CN320507004000",
				"areaName": "江苏,苏州市,相城区,北桥",
				"status": "揽收",
				"location": "",
				"areaCenter": "120.606531,31.505825",
				"areaPinYin": "bei qiao jie dao",
				"statusCode": "1"
			}
		],
		"state": "0",
		"condition": "F00",
		"routeInfo": {
			"from": {
				"number": "CN320507004000",
				"name": "江苏,苏州市,相城区,北桥"
			},
			"cur": {
				"number": "CN320200000000",
				"name": "江苏,无锡市"
			},
			"to": null
		},
		"isLoop": false
	}
}

6.5 运单签收状态服务说明

注：如需物流状态高级状态名称及状态值需要 resultv2 传 “4” 返回

6.6 推送响应报文及错误码解释

6.7 推送返回示例

当我方调用贵方的回调接口（pollCallBackUrl）时，贵方需要先将我方提交的数据保存至贵方的数据库，接着向我方返回是否成功接收的响应报文及代码，即贵公司直接在回调接口的地址的response中填写如下内容：

{
    "result":true,
    "returnCode":"200",
    "message":"成功"
}      

注意：对于status= abort（message中包含“3天查询无记录”或者“60天无变化”）的快递单，也需要返回成功接收的响应报文及代码。

七、快递公司编码

八、业务类型参数表

九、费用类型(feeType)说明

十、商家寄件订单详情查询接口

查询通过商家寄件下单接口下单的订单详情信息

10.1 接口格式

提供统一格式的HTTP POST或GET调用接口,并返回统一格式JSON数据。

10.2 请求地址

https://order.kuaidi100.com/order/borderapi.do

10.3 请求参数

param数据结构：

10.4 返回结果

data数据结构

10.5 返回参数示例

{
	"data": {
		"cargo": "普货",
		"comment": null,
		"courierMobile": null,
		"courierName": null,
		"createTime": "2022-04-22 01:23:40",
		"dayType": null,
		"freight": null,
		"feeDetails": [{
			"feeType": "",
			"feeDesc": "",
			"amount": "",
			"payStatus": ""
		}]，
		"kuaidiCom": "jd",
		"kuaidiNum": "JDVC13641480904",
		"lastWeight": null,
		"orderId": "20274573",
		"payStatus": 4,
		"payment": "SHIPPER",
		"pickupEndTime": null,
		"pickupStartTime": null,
		"preWeight": "1",
		"defPrice": null,
		"recAddr": "长安塘村长兴工业区12号3楼",
		"recCity": "东莞市",
		"recDistrict": "东坑镇",
		"recMobile": "13800138000",
		"recName": "李谬朵",
		"recProvince": "广东",
		"sendAddr": "蔡子池街道新大陆国际监控室",
		"sendCity": "衡阳市",
		"sendDistrict": "耒阳市",
		"sendMobile": "13800138000",
		"sendName": "李新红",
		"sendProvince": "湖南",
		"serviceType": "特惠送",
		"status": 9,
		"taskId": "44B0108CF44728E6F8A121177E3212B2",
		"valins": null
	},
	"message": "成功",
	"result": true,
	"returnCode": "200"
}

说明：

十一、电子面单复打接口

该接口支持在提交打印请求2天内的打印任务进行复打10次的操作（仅对下单时returnType=10的支持复打操作）。

11.1 接口格式

提供统一格式的HTTP POST或GET调用接口,并返回统一格式JSON数据。

11.2 请求地址

https://api.kuaidi100.com/label/order

请求参数：

param数据结构：

11.3 返回结果

11.4 提供数据内容

打印设备复打成功返回示例

{
	"code": 200,
	"message": "success",
	"time": 0,
	"success": true
} 

错误示例：

{
	"code": 30009,
	"message": "查无此单",
	"time": 0,
	"success": false
} 

11.5 返回信息代码含义