文档中心
一、发货单接口 二、打印回调接口

快递发货单打印技术文档

一、发货单接口

1.1 接口格式

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

1.2 请求地址

https://poll.kuaidi100.com/print/billparcels.do 请求参数:

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

param数据结构:

参数名是否必填类型说明
tempidstring通过管理后台的打印发货单模板配置信息获取
siidstring打印设备,通过打印机输出的设备码进行获取
callBackUrlstring打印状态回调地址
tab0tab*发货单表格列表内容,JsonArrayString类型,多表格时用tab0,tab1,tab2等追加对象
Θimg0object多图片时用img0,img1,img2等追加
¬typestringBASE_64:base64 图片格式;URL:图片地址;QR_CODE:二维码;CODE_128:code128格式的条形码
¬contentstring图片内容
¬widthnumber图片宽度
¬heightnumber图片高度
……string其他面单特殊需求参数显示,可以到后台-面单模板选择该模板,下方有对应产生列表

settings数据结构:

参数名是否必填类型说明
pageWidthstring宽,单位mm,默认值:100
pageHeightstring高,单位mm ,续打纸张时,该字段设置为null或空串
Θmarginsmargins 边距
¬topstring上边距,单位:mm,默认:0
¬bottomstring下边距,单位:mm,默认:0
¬leftstring左边距,单位:mm,默认:0
¬rightstring右边距,单位:mm,默认:0

1.3 请求参数示例

发货单模板示例:

注,发货单模板内容都可以自定义实现,实现规则如下:
1、自定义参数命名格式:#{xxxx}
2、表格标题的设置,右键选择表格属性->标题单元格->第一行
3、表格边框线的显示,右键->表格属性->边框设置为1->间距和边距设置为0

param参数示例:

{
  "tempid": "129906826866200576",
  "siid": "L2204140087",
  "callBackUrl": "http://www.baidu.com/fhd/callback",
  "petName": "kd100",
  "recName": "小百",
  "recPhone": "10086",
  "payTime": "2021-01-15 15:40:55",
  "expressName": "德邦快递",
  "printTime": "2021-01-15 15:41:30",
  "printCount": "1",
  "address": "广东省深圳市南山区金蝶软件园",
  "total": "21",
  "remark": "购物小票作为购物凭证,请妥善保管,您有任何疑问,请咨询服务热线 123456798",
  "img0": {
    "type": "code_128",
    "content": "887921256577",
    "width": 350,
    "height": 100
  },
  "tab0": [
    {
      "prodName": "热敏纸",
      "count": "5",
      "specs": "76*130",
      "unitPrice": "30",
      "price": "150"
    },
    {
      "prodName": "热敏纸",
      "count": "10",
      "specs": "100*180",
      "unitPrice": "50",
      "price": "500"
    },
    {
      "prodName": "续打纸",
      "count": "5",
      "specs": "",
      "unitPrice": "40",
      "price": "200"
    },
    {
      "prodName": "云打印机",
      "count": "1",
      "specs": "二代",
      "unitPrice": "499",
      "price": "499"
    }
  ]
}

settings参数示例

{
  "pageWidth": 100,
  "pageHeight": 180,
  "margins": {
    "top": 5,
    "bottom": 5,
    "left": 5,
    "right": 5
  }
}

输出效果如下:

1.4 返回结果

字段类型说明备注
resultboolean提交结果true提交成功,false失败
returnCodestring返回编码
messagestring返回报文描述
datadata

data数据结构

字段类型说明备注
taskIdstring任务ID

1.5 返回结果示例

{
  "result": true,
  "returnCode": "200",
  "message": "提交成功",
  "data": {
      "taskId":""   // 任务ID
  }
} 

1.6 信息代码含义

信息代码信息内容描述原因及建议处理方式
200提交成功提交成功
400参数错误请根据技术文档请求,注意参数类型及是否必填。
500服务器错误快递100的服务器出理间隙或临时性异常,有时如果因为不按规范提交请求,比如快递公司参数写错等,也会报此错误
503签名认证失败请检查加密方式,param + t + key + secret 的顺序进行MD5加密,加密后字符串转大写,不用加上“+”号
600您不是合法的用户(即授权Key出错)账号无可用单量,需要充值
601KEY已过期账号无可用单量,需要充值
700错误的回调地址检查回调地址,或者联系快递100工作人员

二、打印回调接口

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

2.1 接口格式

提供统一格式的HTTP POST,并返回统一格式JSON数据。 请求报头:Content-Type=application/x-www-form-urlencoded;charset=UTF-8

2.2 请求地址

请求参数:

字段类型说明备注
taskIdstring任务ID
signstring签名32位大写签名,MD5 (param +salt)
paramparam参数主体

param数据结构:

字段是否必填类型说明
statusstring状态编码,200:打印成功,201打印不成功。
messagestring状态描述

2.3 返回结果

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

2.4 返回结果示例

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

2.5 信息代码含义

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

其他信息快递100会忽略。