四、打印状态回调

通过上述接口提交的打印请求，进行打印状态返回。

3.1 接口格式

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

3.2 请求地址

由贵司在电子面单打印请求中通过callBackUrl字段提供

<form method="post" name="" action="[callbackUrl]">
    <input type="text" name="taskId" value="{XXX}" />
    <input type="text" name="param" value="{XXX}" />
    <input type="text" name="sign" value="签名字符串" />
    <input type="text" name="type" value="printStatus" />
</form>

Copy

请求参数：

字段	类型	说明	备注
taskId	string	任务ID
sign	string	加密字符串签名：MD5 (param +salt)
type	string	推送类型，默认为 printStatus
param	param	参数主体

param数据结构：

参数名	类型	说明
status	string	状态编码，200：打印成功，201打印不成功
message	string	状态描述

3.3 返回结果

字段	类型	说明	备注
result	boolean	提交结果	true提交成功，false失败
returnCode	string	返回编码
message	string	返回报文描述

3.4 返回结果示例

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

Copy

说明：

字段名称	字段含义
result	true表示成功，false表示失败。如果提交回调接口的地址失败，30分钟后重新回调，3次仍旧失败的，自动放弃
returnCode	200: 提交成功 500: 服务器错误 其他错误请自行定义
message	返回的提示

其他信息快递100会忽略。

四、OCR识别结果回调

通过上述接口提交的第三方平台打单，开启ocr后（needOcr为true时），会通过callBackUrl推送。

4.1 接口格式

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

4.2 请求地址

由贵司在电子面单打印请求中通过callBackUrl字段提供

<form method="post" name="" action="[callbackUrl]">
    <input type="text" name="taskId" value="{XXX}" />
    <input type="text" name="param" value="{XXX}" />
    <input type="text" name="sign" value="签名字符串" />
    <input type="text" name="type" value="ocr" />
</form>

Copy

请求参数：

字段	类型	说明	备注
taskId	string	任务ID
sign	string	加密字符串签名：MD5 (param +salt)
type	string	推送类型，默认为 ocr
param	param	参数主体

param数据结构：

参数名称	数据类型	是否必填	参数描述
barcode	string[]	否	条形码值
qrcode	string[]	否	二维码值
Θreceiver	Object	否	收件人信息，明细项目请展开
└ address	string	否	详细地址
└province	string	否	省
└ city	string	否	市
└ county	string	否	县/区
└ mobile	string	否	电话
└ name	string	否	姓名
└ text	string	否	原始文本
└confidence	number	否	可信度，仅供参考
Θsender	Object	否	寄件人信息，明细项目请展开
└ address	string	否	详细地址
└province	string	否	省
└ city	string	否	市
└ county	string	否	县/区
└ mobile	string	否	电话
└ name	string	否	姓名
└ text	string	否	原始文本
└confidence	number	否	可信度
Θbulkpen	Object	否	大头笔信息，明细项目请展开
└confidence	number	否	可信度
└ text	string	否	原始文本

4.3 返回结果

字段	类型	说明	备注
result	boolean	提交结果	true提交成功，false失败
returnCode	string	返回编码
message	string	返回报文描述

4.4 返回结果示例

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

Copy

说明：

字段名称	字段含义
result	true表示成功，false表示失败。如果提交回调接口的地址失败，30分钟后重新回调，3次仍旧失败的，自动放弃
returnCode	200: 提交成功 500: 服务器错误 其他错误请自行定义
message	返回的提示

其他信息快递100会忽略。

五、订阅/ocr异常结果回调

开启订阅或ocr后，如果当前账号没有余额，将会通过callBackUrl推送

5.1 接口格式

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

5.2 请求地址

由贵司在电子面单下单请求中通过callBackUrl字段提供

<form method="post" name="" action="[callbackUrl]">
    <input type="text" name="taskId" value="{XXX}" />
    <input type="text" name="param" value="{XXX}" />
    <input type="text" name="sign" value="签名字符串" />
    <input type="text" name="type" value="exception" />
</form>

Copy

请求参数：

字段	类型	说明	备注
taskId	string	任务ID
sign	string	加密字符串签名：MD5 (param +salt)
type	string	推送类型，默认为 exception
param	param	参数主体(订阅失败:key已过期 ocr失败:key已过期)

5.3 返回结果

字段	类型	说明	备注
result	boolean	提交结果	true提交成功，false失败
returnCode	string	返回编码
message	string	返回报文描述

5.4 返回结果示例

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

Copy

说明：

字段名称	字段含义
result	true表示成功，false表示失败。如果提交回调接口的地址失败，30分钟后重新回调，3次仍旧失败的，自动放弃
returnCode	200: 提交成功 500: 服务器错误 其他错误请自行定义
message	返回的提示

其他信息快递100会忽略。

六、订单拦截接口

该接口支持电子面单下单后，对在运输途中尚未签收的快件进行拦截处理。

6.1 接口格式

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

6.2 请求地址

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

请求参数：

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

param数据结构：

参数名	是否必填	类型	说明
kuaidicom	是	string	快递公司的编码，一律用小写字母，请查看参数字典
kuaidinum	是	string	快递单号
interceptType	是	string	拦截类型，RETURN_SEND_STATION: 退回寄件网点；RETURN_SEND_ADDR: 退回寄件地址；MODIFY_ADDR: 修改地址
partnerId	是	string	电子面单客户账户或月结账号，需贵司向当地快递公司网点申请（参考电子面单申请指南）； 是否必填该属性，请查看参数字典
partnerKey	否	string	电子面单密码，需贵司向当地快递公司网点申请； 是否必填该属性，请查看参数字典
partnerSecret	否	string	电子面单密钥，需贵司向当地快递公司网点申请； 是否必填该属性，请查看参数字典
partnerName	否	string	电子面单客户账户名称，需贵司向当地快递公司网点申请； 是否必填该属性，请查看参数字典
net	否	string	收件网点名称,由快递公司当地网点分配。 是否必填该属性，请查看参数字典
code	否	string	电子面单承载编号，需贵司向当地快递公司网点申请； 是否必填该属性，请查看参数字典
reason	否	string	拦截原因
ΘrecMan	否	recMan	收件人信息，interceptType为MODIFY_ADDR时必填
￢name	是	string	收件人姓名
￢mobile	是	string	收件人的手机号，手机号和电话号二者其一必填
￢tel	是	string	收件人的电话号，手机号和电话号二者其一必填
￢printAddr	是	string	收件人所在完整地址，如广东深圳市深圳市南山区科技南十二路2号金蝶软件园B10
￢company	否	string	收件人所在公司名称

6.3 返回结果

字段	类型	说明	备注
success	boolean	提交结果	true提交成功，false失败
code	string	返回编码
message	String	返回报文描述
data	String	相应数据

6.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": "广东深圳市南山区金蝶软件园"
    }
}

Copy

6.5 返回结果示例

成功示例：

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

Copy

错误示例：

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

Copy

6.6 返回信息代码含义

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

6.7 支持的快递公司编码

快递公司	快递编码	支持拦截的类型
德邦	debangwuliu	MODIFY_ADDR
圆通	yuantong	RETURN_SEND_STATION；MODIFY_ADDR
中通	zhongtong	RETURN_SEND_STATION；RETURN_SEND_ADDR；MODIFY_ADDR