文档中心
一、拦截改址接口 二、支持的快递公司编码 API调试工具

一、拦截改址接口

该接口支持对“运输中且未签收”的快件进行拦截改址处理,方便服务平台、商家、用户在线发起服务直连快递公司。

1.1 接口格式

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

1.2 请求地址

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

请求参数:

参数名是否必填类型说明
methodstring业务类型(默认:interceptOrder)
keystring授权码,请申请企业版获取
signstring32位大写,签名,用于验证身份,按MD5 (param +t+key+ secret)的顺序进行MD5加密,不需要加上“+”号secret在企业管理后台查看
tstring时间戳如:1576123932000
paramparam由其他字段拼接

param数据结构:

参数名是否必填类型说明
kuaidicomstring快递公司的编码,一律用小写字母,请查看参数字典
kuaidinumstring快递单号
interceptTypestring拦截类型,RETURN_SEND_STATION: 退回寄件网点;RETURN_SEND_ADDR: 退回寄件地址;MODIFY_ADDR: 修改地址
partnerIdstring电子面单客户账户或月结账号,需贵司向当地快递公司网点申请(参考电子面单申请指南); 是否必填该属性,请查看参数字典
partnerKeystring电子面单密码,需贵司向当地快递公司网点申请; 是否必填该属性,请查看参数字典
partnerSecretstring电子面单密钥,需贵司向当地快递公司网点申请; 是否必填该属性,请查看参数字典
partnerNamestring电子面单客户账户名称,需贵司向当地快递公司网点申请; 是否必填该属性,请查看参数字典
netstring收件网点名称,由快递公司当地网点分配。 是否必填该属性,请查看参数字典
codestring电子面单承载编号,需贵司向当地快递公司网点申请; 是否必填该属性,请查看参数字典
reasonstring拦截原因
orderidstring订单id
ΘrecManInforecMan收件人信息,interceptType为MODIFY_ADDR时必填
¬namestring收件人姓名
¬mobilestring收件人的手机号,手机号和电话号二者其一必填
¬telstring收件人的电话号,手机号和电话号二者其一必填
¬printAddrstring收件人所在完整地址,如广东深圳市深圳市南山区科技南十二路2号金蝶软件园B10
¬companystring收件人所在公司名称
saltstring签名用随机字符串,用于回调拦截结果中验证签名sign
callbackUrlstring回调地址(中通、极兔、圆通必填)
appKeystring需拦截非快递100渠道下单的中通件时则填入,从中通后台服务商模式下授权至ISV(快递100管家)后可获得,详看中通服务商系统用户接入指南的第四点
appSecretstring需拦截非快递100渠道下单的中通件时则填入,从中通后台服务商模式下授权至ISV(快递100管家)后可获得,详看中通服务商系统用户接入指南的第四点

1.3 返回结果

字段类型说明备注
successboolean提交结果true提交成功,false失败
codestring返回编码
messagestring返回报文描述
datastring相应数据

1.4 请求参数示例

method = interceptOrder
key = kytRsteof
sign = 4 BBDE07660E5EFF90873642CFAE9A8DD
t = 1470304729724
param = {
	"orderId": "",
	"kuaidicom": "debangkuaidi",
	"kuaidinum": "2222",
	"partnerId": "22222",
	"partnerKey": "",
	"partnerSecret": "",
	"interceptType": "MODIFY_ADDR",
	"code": "",
	"net": "",
	"reason": "",
	"recManInfo": {
		"name": "测试",
		"mobile": "138888888888",
		"printAddr": "广东深圳市南山区金蝶软件园"
	}
}

1.5 返回结果示例

成功示例:

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

错误示例:

{
	"code": 30005,
	"message": "快递公司返回异常: 拦截失败运单拦截,计价失败,未查询到该运单信息",
	"time": 0,
	"success": false
} 

返回信息代码含义:

信息代码信息内容描述原因及建议处理方式
-1服务器错误快递100的服务器出现间歇或临时性异常,有时如果因为不按规范提交请求,比如快递公司参数写错等,也会报此错误
200提交成功提交成功
30001参数错误请根据技术文档请求,注意参数类型及是否必填
30002验证签名失败检查加密方式,param +t+key+ secret的顺序进行MD5加密,加密后字符串转32位大写,不用加上“+”号
30003账号信息不正确检查key是否正确
30005快递公司返回异常按照描述可以自行检查参数的数据类型是否正确

1.7 拦截结果回调

提供统一格式的HTTP POST,并以application/x-www-form-urlencoded格式进行回调请求。

字段类型说明备注
signstring签名salt值不为null时,回调数据将包含该加密签名,加密方式:md5(param+salt)转大写,param为返回的参数。注意: salt值为空串时,推送的数据也会包含sign,此时可忽略sign的校验。
paramstring回调结果

param数据结构:

字段类型说明备注
kuaidicomstring快递公司编码
kuaidinumstring快递单号
interceptResultint拦截结果0-拦截失败,1-拦截成功,2-拦截中
interceptResultDescstring拦截结果描述拦截失败时返回
returnKuaidiNumstring退回单号拦截成功后,产⽣的退回单号(仅拦截成功状态时回传)

请求参数示例

sign = XXXX
param= {
	"interceptResult": 1,
	"kuaidicom": "jtexpress",
	"kuaidinum": "JT12345675",
	"returnKuaidiNum": "JT12345676"
}

当我方调用贵方的回调接口(callbackUrl)时,贵方需要先将我方提交的数据保存至贵方的数据库,接着向我方返回是否成功接收的响应报文及代码(成功状态码:200),即贵公司在成功接收回调的拦截结果后需响应如下内容:

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

二、支持的快递公司编码

快递公司快递编码支持拦截的类型
德邦debangwuliuMODIFY_ADDR
圆通yuantongRETURN_SEND_STATION;MODIFY_ADDR
中通zhongtongRETURN_SEND_STATION;RETURN_SEND_ADDR;MODIFY_ADDR
极兔jtexpressRETURN_SEND_ADDR ;MODIFY_ADDR
京东jdRETURN_SEND_ADDR