博客列表 >电商快递物流电子面单HTML接口API案例代码

电商快递物流电子面单HTML接口API案例代码

快递100API
快递100API原创
2021年05月19日 14:23:081053浏览

一、电子面单HTML接口

通过快递公司或网点、菜鸟与淘宝提供的电子面单账号,提交生成电子面单号,返回固定面单模板,调用本地打印机即可打印出电子面单。

1.1 接口格式

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

1.2 请求地址

<p>http://poll.kuaidi100.com/eorderapi.do</p>

请求参数(header)

名称 类型 默认值
Content-Type string application/x-www-form-urlencoded

请求参数(body)

参数名 是否必填 类型 说明
method string 业务类型(默认:getElecOrder)
key string 授权码,请<a href="https://api.kuaidi100.com/register/enterprise" target="_blank">申请企业版</a>获取
sign string 32位大写 ,签名,用于验证身份,按MD5 (param +t+key+ secret)的顺序进行MD5加密,不需要加上“+”号,secret可在企业管理后台查看
t string 时间戳如:1576123932000
param param 由其他字段拼接

param数据结构

参数名 是否必填 类型 说明
partnerId string 电子面单客户账户或月结账号,需贵司向当地快递公司网点申请(参考<a href="https://api.kuaidi100.com/document/5f6abba0ddc961732a1c2353.html" target="_blank">电子面单申请指南</a>); 是否必填该属性,请查看<a href="https://api.kuaidi100.com/document/5f0ff6e82977d50a94e10237.html" target="_blank">参数字典</a>
partnerKey string 电子面单密码,需贵司向当地快递公司网点申请; 是否必填该属性,其他请查看<a href="https://api.kuaidi100.com/document/5f0ff6e82977d50a94e10237.html" target="_blank">参数字典</a>
partnerName string 商家名称,net为jdalpha时必填
net string 收件网点名称,由快递公司当地网点分配, 若使用淘宝授权填入(taobao),使用菜鸟授权填入(cainiao)。 是否必填该属性,请查看<a href="https://api.kuaidi100.com/document/5f0ff6e82977d50a94e10237.html" target="_blank">参数字典</a>(若通过淘宝/菜鸟授权方式获取单号partnerId,partnerKey参数为必填,参数值可通过菜鸟淘宝账号授权接口获取)
tbNet string 在使用菜鸟/淘宝/拼多多授权电子面单时,若月结账号下存在多个网点,则tbNet=”网点名称,网点编号” ,注意此处为英文逗号
kuaidicom string 快递公司的编码,一律用小写字母,见<a href="https://api.kuaidi100.com/document/5f0ff6e82977d50a94e10237.html" target="_blank">参数字典</a>
ΘrecMan object 收件人信息
¬name string 收件人姓名
¬mobile string 收件人的手机号,手机号和电话号二者其一必填
¬printAddr string 收件人所在完整地址,如广东深圳市深圳市南山区科技南十二路2号金蝶软件园B10
¬company string 收件人所在公司名称
ΘsendMan object 寄件人信息
¬name string 寄件人姓名
¬mobile string 寄件人的手机号,手机号和电话号二者其一必填
¬printAddr string 寄件人所在的完整地址,如广东深圳市深圳市南山区科技南十二路2号金蝶软件园B10
¬company string 寄件人所在公司名称
cargo string 物品名称,例:文件
count string 物品总数量 另外该属性与子单有关,如果需要子单(指同一个订单打印出多张电子面单,即同一个订单返回多个面单号),needChild = 1、count 需要大于1,如count = 2 则一个主单 一个子单,count = 3则一个主单 二个子单;返回的子单号码见返回结果的childNum字段
weight string 物品总重量KG,例:1.5,单位kg
payType string 支付方式: SHIPPER:寄方付(默认) CONSIGNEE:到付 MONTHLY:月结 THIRDPARTY:第三方支付 (详细请参考<a href="https://api.kuaidi100.com/document/5f0ff6e82977d50a94e10237.html" target="_blank">参数字典</a>)
expType string 快递类型: 标准快递(默认) 顺丰标快(陆运) EMS经济 (详细请参考<a href="https://api.kuaidi100.com/document/5f0ff6e82977d50a94e10237.html" target="_blank">参数字典</a>)
remark string 备注
面单扩展属性
valinsPay string 保价额度
collection string 代收货款额度
needChild string 是否需要子单: 1:需要 0:不需要(默认) 如果需要子单(指同一个订单打印出多张电子面单,即同一个订单返回多个面单号); needChild = 1、count 需要大于1,如count = 2 一个主单 一个子单,count = 3 一个主单 二个子单,返回的子单号码见返回结果的childNum字段
needBack string 是否需要回单: 1:需要 0:不需要(默认) 返回的回单号见返回结果的returnNum字段
orderId string 贵司内部自定义的订单编号,需要保证唯一性,非必填
needTemplate string 是否返回面单: 0:不需要(默认) 1:需要 如果需要,则返回要打印的模版的HTML代码,贵司可以直接将之显示到IE等浏览器,然后通过浏览器进行打印
salt string 签名用随机字符串
op string 是否开启订阅功能: 0:不开启(默认) 1:开启 说明开启订阅功能时:pollCallBackUrl必须填入此功能只针对有快递单号的单
pollCallBackUrl string 如果op设置为1时,pollCallBackUrl必须填入,用于跟踪回调
resultv2 string 添加此字段表示开通行政区域解析功能, 详细见:<a href="https://api.kuaidi100.com/document/5f0ffa8f2977d50a94e1023c.html#title_1" target="_blank">快递信息推送接口文档-2.3推送输入参数</a>。 0:关闭(默认) 1:开通行政区域解析功能

关于回单
支持回单的网点面单包括顺丰、顺丰快运、德邦快递、德邦物流、京东、跨越、汇森速运、加运美物流、顺心捷达;
支持回单的菜鸟面单包括申通快运、中通快运、韵达快运、德邦快运;

关于子单
支持子单的网点面单包括顺丰、顺丰快运、德邦快递、德邦物流、京东、品骏、全一快递、速尔快递、信丰物流、优速快递、宅急送、圆通承诺达、龙邦快递、D速快递、汇森速运、加运美物流、京广速递、顺心捷达、壹米滴答;
支持子单的菜鸟面单包括申通快运、中通快运、韵达快运、德邦快运、安能快运、百世快运;

1.3 请求参数示例

  1. method = getElecOrder
  2. key = kytRsteof
  3. sign = 4BBDE07660E5EFF90873642CFAE9A8DD
  4. t = 1470304729724
  5. param = {
  6. "partnerId": "******",
  7. "partnerKey": "",
  8. "net": "",
  9. "kuaidicom": "ems",
  10. "recMan": {
  11. "name": "张三",
  12. "mobile": "13751866787",
  13. "printAddr": "广东深圳市深圳市南山区科技南十二路2号金蝶软件园B10",
  14. "company": ""
  15. },
  16. "sendMan": {
  17. "name": "李四",
  18. "mobile": "13751866787",
  19. "printAddr": "广东深圳市深圳市南山区科技南十二路2号金蝶软件园",
  20. "company": ""
  21. },
  22. "cargo": "发票",
  23. "count": "1",
  24. "weight": "0.5",
  25. "payType": "SHIPPER",
  26. "expType": "标准快递",
  27. "remark": "",
  28. "valinsPay": "",
  29. "collection": "",
  30. "needChild": "0",
  31. "needBack": "0",
  32. "orderId": "2147895476",
  33. "needTemplate": "1",
  34. "salt": "",
  35. "op": "0",
  36. "pollCallBackUrl": "",
  37. "resultv2": "0"
  38. }

1.4 返回结果

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

data数据结构

字段 类型 说明 备注
taskId string 任务ID
kuaidinum string 快递单号
returnNum string 回单号
childNum string 子单号,如果有多个,逗号分隔 如果需要子单 则需要提交报文needChild = 1、count 需要大于1。 如count = 2则一个主单、一个子单,count=3则一个主单、二个子单
快递公司面单基础信息
bulkpen string 大头笔 用于显示于电子面单上规定位置,非必需,是否有值取决于快递公司
orgCode string 始发地区域编码
orgName string 始发地/始发网点名称
destCode string 目的地区域编码
destName string 目的地/到达网点
orgSortingCode string 始发分拣编码
orgSortingName string 始发分拣名称
destSortingCode string 目的分栋编码
destSortingName string 目的分栋中心名称
orgExtra string 始发其他信息
destExtra string 目的其他信息
pkgCode string 集包编码
pkgName string 集包地名称
road string 路区
qrCode string 二维码
orderNum string 快递公司订单号
expressCode string 快递业务类型编码
expressName string 快递业务类型名称
templateurl string 在线显示电子面单模版的网址 用浏览器打开该网址,就能看到生成的电子面单,直接通过浏览器的打印功能即可完成打印
template string 电子面单模板内容

1.5 返回结果示例

不带模版返回

  1. {
  2. "result": true,
  3. "message": "成功",
  4. "status": "200",
  5. "data": [
  6. {
  7. "kuaidinum": "606568155331",
  8. "returnNum": "",
  9. "childNum": "",
  10. "bulkpen": "大头笔",
  11. "orgCode": "755",
  12. "orgName": "始发地区域编码",
  13. "destCode": "755",
  14. "destName": "目的地/到达网点",
  15. "orgSortingCode": "始发分拣编码",
  16. "orgSortingName": "始发分拣名称",
  17. "destSortingCode": "目的分栋编码",
  18. "destSortingName": "目的分栋中心名称",
  19. "orgExtra": "始发其他信息",
  20. "destExtra": "目的其他信息",
  21. "pkgCode": "集包编码",
  22. "pkgName": "集包地名称",
  23. "road": "路区",
  24. "qrCode": "二维码",
  25. "orderNum": "快递公司订单号",
  26. "expressCode": "快递业务类型编码",
  27. "expressName": "标准快递",
  28. "templateurl": "http://www.kuaidi100.com/XXX"
  29. }
  30. ]
  31. }

带模板返回

  1. {
  2. "result": true,
  3. "message": "成功",
  4. "status": "200",
  5. "data": [
  6. {
  7. "kuaidinum": "611399236259",
  8. "returnNum": "",
  9. "childNum": "",
  10. "bulkpen": "大头笔",
  11. "orgCode": "755",
  12. "orgName": "始发地区域编码",
  13. "destCode": "755",
  14. "destName": "目的地/到达网点",
  15. "orgSortingCode": "始发分拣编码",
  16. "orgSortingName": "始发分拣名称",
  17. "destSortingCode": "目的分栋编码",
  18. "destSortingName": "目的分栋中心名称",
  19. "orgExtra": "始发其他信息",
  20. "destExtra": "目的其他信息",
  21. "pkgCode": "集包编码",
  22. "pkgName": "集包地名称",
  23. "road": "路区",
  24. "qrCode": "二维码",
  25. "orderNum": "快递公司订单号",
  26. "expressCode": "快递业务类型编码",
  27. "expressName": "标准快递",
  28. "templateurl": "http://ckd.im/u2WB5"
  29. "template": [
  30. "<!DOCTYPE html>
  31. <html>
  32. <head>
  33. <meta charset=\"utf-8\">
  34. <title>顺丰</title>
  35. <style>
  36. * { margin: 0;
  37. padding: 0
  38. }
  39. table {
  40. margin-top: -1px;
  41. font: 12px \"Microsoft YaHei\", Verdana,arial,sans-serif;
  42. border-collapse: collapse;
  43. }
  44. table.container {
  45. width: 375px;
  46. }
  47. table td {
  48. border: 1px solid #000;
  49. }
  50. table.nob {
  51. width: 100%;
  52. }
  53. table.nob td {
  54. border: 0;
  55. }
  56. table td.center {
  57. text-align: center;
  58. }
  59. table td.right {
  60. text-align: right;
  61. }
  62. ……………</table></body>
  63. </html>"
  64. ]
  65. }
  66. ]
  67. }

返回的打印模版示例(即template或访问templateurl后显示的效果)
将template字段写到一个html文件后通过浏览器打开并显示出来后的效果示例:顺丰:

示例图片

1.6 返回信息代码含义

信息代码 信息内容描述 原因及建议处理方式
200 成功 提交成功
401 参数错误 请根据技术文档请求,注意参数类型及是否必填。
402 未指明服务 请检查业务类型是否填错
601 KEY已过期 账号无可用单量,需要充值
601 电子面单账号校验失败,请确认账号信息是否正确 传入的电子面单账号信息错误,请联系当地网点获得正确的账号信息。
602 电子面单数量余额不足,请联系合作网点客服充值 检查提交内容,可找快递100工作人员排查
603 无法获取行政信息 请填写详细的省市区信息
604 该快递公司不支持子单号 请查看1.2支持子单的快递公司
605 该快递公司不支持回单 请查看1.2支持回单的快递公司
606 业务类型错误 从参数字典选择合适的业务类型。
607 收件人手机号或电话不能同时为空 传入收件人手机号或者电话
610 菜鸟电子面单认证信息过期,请重新授权 菜鸟授权一年有效,到期重新授权
697 电子面单请求失败,请重新打印 请根据技术文档请求,注意参数类型及是否必填。
699 请求快递公司失败,请稍候重试 请根据技术文档请求,注意参数类型及是否必填。

官方文档链接:
https://api.kuaidi100.com/document/5f0ff6c42977d50a94e10236.html
https://api.kuaidi100.com/document/6089416bdb296372f4abfc33.html

声明:本文内容转载自脚本之家,由网友自发贡献,版权归原作者所有,如您发现涉嫌抄袭侵权,请联系admin@php.cn 核实处理。
全部评论
文明上网理性发言,请遵守新闻评论服务协议