java接口文档模板_中通快递查询电子面单接口对接指南【快递鸟API】

java接口文档模板_中通快递查询电子面单接口对接指南【快递鸟API】_第1张图片

一、接入前准备(TO商家业务人员)

1、申请快递鸟用户ID和API key

1.1登录快递鸟官网注册页面http://www.kdniao.com/reg注册快递鸟账号;

1.2登录快递鸟用户管理后台,进入“我的会员中心”进行实名认证;

1.3认证成功后,进入“产品服务管理”,开通会员服务(可开通免费套餐测试)。

2、申请中通快递电子面单客户号

申请中通客户号有以下两种方式,互不冲突,任选其一即可(不支持菜鸟、京东、拼多多电子面单客户号);

2.1、线下与当地中通速递网点签订合作协议,并申请中通快递自有电子面单客户号;

2.2、在快递鸟官网申请,申请路径:用户管理后台——电子面单——申请新的物流服务商——申请中通快递——填写信息后提交,待快递公司总部审核通过后(一般在2-3个工作日审核通过,如长时间未审核,建议直接联系网点催促审核或进行线下申请),会有短信通知到申请人手机号上,使用前需联系网点充值单号。

注:获取到的电子面单客户号不需要在快递鸟官网后台添加,直接通过接口传值下单即可;

3、购买打印机、打印纸

3.1、打印机:

电子面单模板对打印机品牌、型号等没有要求,只要是热敏打印机即可,常见品牌如:斑马、得力、快麦、汉印、佳博等。

打印机可由快递网点提供或者在淘宝京东上购买,安装打印机及驱动程序联系打印机提供方;

3.2、打印纸:

中通快递使用的打印纸是100mm*180mm(切点110/70),打印纸可由快递网点提供或者在淘宝京东上购买,购买时可选择全白热敏纸。

二、开发接入(TO商家技术开发人员)

1、下载最新快递鸟技术文档和对接攻略

在技术QQ群/快递鸟官网http://kdniao.com/documents下载;

2、参照技术文档开发

2.1 关于请求内容

以java为例:

java接口文档模板_中通快递查询电子面单接口对接指南【快递鸟API】_第2张图片

2.2关于中通快递客户号接口传值

CustomerName传值商家ID,

CustomerPwd传值商家接口密码(通过快递鸟官网申请的则此字段无需传值),

客户号配置页需留两个栏位(需正确对应以上两个字段)由发货商家填写,商家自己开发的系统也建议保留配置页,万一账号更换了呢?

PayType传值付款方式(支持:1-现付,3-月结);

2.3 关于快递类型

中通快递快递类型如下

快递类型 ExpType传值

普通订单 1

线下订单 2

COD订单 3

限时物流 4

快递保障订单 5

2.4 关于中通快递增值服务传值

代收货款

字段传值:"AddService":[{"Name":"COD","Value":"1000","CustomerID":"1234567891"}]

订阅物流节点短信通知

物流节点短信包含:寄件短信、派件短信、签收短信、问题件短信等;

字段传值:IsSendMessage 0-不需要,1-需要

短信通知是收费服务,需联系快递鸟购买会员套餐或短信套餐后方可使用。

3、电子面单模板样式

中通快递模板共2个规格,具体如下

二联180(默认模板,TemplateSize传值为空)

java接口文档模板_中通快递查询电子面单接口对接指南【快递鸟API】_第3张图片

二联180新(TemplateSize传值180)

java接口文档模板_中通快递查询电子面单接口对接指南【快递鸟API】_第4张图片

4、电子面单模板处理

用户可根据自身的实际情况及未来发展的需要来决定是否需要接口返回模板(参数:IsReturnPrintTemplate 0-不需要,1-需要),推荐平台/工具/ERP类用户自行开发设计,直接发货商家使用接口返回的模板,如有特殊需求可自行开发;

4.1 平台性/工具/ERP类用户

因其系统使用商家较多,同一模板无法满足所有商家需求,推荐根据商家需求自行设计面单模板。

优势:灵活性高,不受快递鸟模板变动的影响,商家体验更好

劣势:对用户技术能力有一定要求

4.2 直接发货商家

A、 对模板无要求,快递鸟接口返回的模板已能满足的商家,可直接使用。

优势:接入成本低,方便易用,可使用快递鸟批量打印功能

劣势:灵活性不高

B、 对模板有一定要求,快递鸟接口返回的模板无法完全满足的商家,可对返回的html模板报文进行处理,或自行设计面单模板样式。

优势:接入成本较低,方便快捷

劣势:对用户技术能力稍有要求

三、接口使用(TO商家系统操作人员)

使用过程中如遇到问题,先联系公司内部技术人员排查,如需快递鸟协助请让技术人员联系。

可能遇到的问题:

1、电子面单接口下单返回”单号不足”“余量不足”“没有可用单号”“没有库存”是什么意思?

答:电子面单客户号需有足够的单号才能下单成功,当单号不足时请联系网点进行充值;

2、接口返回“校验码有误”是什么原因?

答:快递公司不支持的特殊字符:' " # & + % < >

请确认请求数据(包含收寄方姓名、电话、地址、商品名称等所有订单数据)中是否含有以上特殊字符;

3、电子面单下单返回结果false,错误码106,订单号已下单成功?

答:电子面单下单接口订单号OrderCode不能重复使用,重复使用会报错且返回的面单是此订单号上次下单的内容;

4、电子面单返回“暂无打印模板”是什么原因?

答:默认的模板TemplateSize无需传值,非默认模板传对应模板尺寸,不可传值不存在的模板尺寸代码;

5、电子面单接口下单返回“203填写的快递公司电子面单账号密码有误,请核实确认"是什么原因?

答:是电子面单账户异常,需要联系网点确认拿到正确的商家ID和商家接口密码;

6、电子面单生成后可以取消吗?不发货的话单号会作废吗?

答:快递公司有单号回收机制,未使用的单号会自动回收。具体回收规则请与快递公司网点确认;

中通快递单号查询接口对接指南

目的

便于快递鸟用户理解快递单号查询接口作用并正确应用到实际场景。

接口作用

轨迹类接口包含:即时查询接口和物流跟踪接口。

即时查询接口:实时查询某个快递单号当前的物流状态;

物流跟踪接口:监控某个快递单号完整的物流状态。

应用场景

可应用于电商平台、自营商城、ERP、打单工具、楼宇/物业系统、云打印、微信小程序/公众号、APP、OA等需要查看物流信息的场景。

接口逻辑

说明:

快递鸟接口作为数据中转站,不对物流信息做处理,不做语言转换,只对数据字段做转换,分析物流状态;

快递鸟接口返回的物流轨迹信息按照发生时间的升序排列。

应用方法:

接口返回物流信息后直接展示

优势:方便简单

劣势:受网络影响,响应较慢,用户体验欠佳

接口返回物流信息后保存在本地数据库,当用户查询时调用本地数据再做展示

优势:本地调用响应快,不受网络影响,用户体验好

劣势:需本地保存

应用实例

类似微信扫一扫查快递,通过扫一扫功能扫描面单上的条码跟踪物流状态(需结合快递鸟单号识别接口使用);——适用即时查询接口

前端展示单号轨迹框,由用户填写单号后查询对应物流信息(可结合快递鸟单号识别接口使用);——适用即时查询接口

输入中通快递单号,显示可能属于的快递公司列表

选择中通快递公司后,展示详细的物流信息。

电商平台、自营商城等展示订单的物流信息,可监控平台商家是否按时发货;——适用物流跟踪接口

APP上展示订单流转路径;——适用物流跟踪接口

发送物流节点短信通知;——适用物流跟踪接口

数据报表;——适用物流跟踪接口

物流体验:分析每天快件状态,统计揽收率、签收率、问题件率等;——适用物流跟踪接口

退货险:平台根据快件流转的时间、揽件城市、签收城市等数据判断商家是否虚假退货;——适用物流跟踪接口

轨迹拼接:转动公司/平台,将海外订单的物流信息和国内清关后的物流信息拼接在一起,方便买家查询海淘订单;——适用物流跟踪接口

对接指南

1、登录快递鸟官网注册页面注册快递鸟账号

网址:快递单号查询接口_电子面单_APIKey授权申请-快递鸟账号注册

2、登录快递鸟用户管理后台

网址:用户登录_快递鸟API让物流接口对接更简单

注:登录快递鸟用户管理后台后获得用户ID和APIKey,此用于保证应用来源的可靠性,避免应用伪造,被不法使用。

3、进入“我的会员中心”进行实名认证

注:

3.1、认证类型、应用类型根据用户实际情况选择即可,接口返回数据与选择结果无关;

3.2、标记为*的为必填,要求上传清晰、jpg格式且小于2M的证件图片;

3.3、技术对接人信息为用户方对接工程师的信息;

3.4、如有其他疑问可进入官网加入商务合作群进行咨询。

4、认证成功后,进入“产品服务管理”,开通相关会员服务

注:

4.1、物流查询(免费版)会员套餐为免费版,有效期1年结束后,如在近3个月内有数据交互系统会自动免费续期;

4.2、如有其他疑问可进入官网加入商务合作群进行咨询。

5、开发对接

5.1、即时查询(RequestType:1002/8001)

5.1.1、请求接口之前需要先实名认证,开通相关会员服务,否则会请求失败并返回提示“未申请开通接口”;

5.1.2、接口开发可以下载“快递鸟接口技术文档”进行参考;即时查询,参考技术文档中的4.1或5.1.1部分;

5.1.3、接口开发可以下载“即时查询demo”进行参考(仅提供了.NET、Java、PHP三种语言demo);

5.1.4、查看快递公司对应快递鸟的编码可以下载“2019快递鸟接口支持快递公司编码列表.xlsx”。

5.1.5、接入过程中如有疑问请先参考快递鸟官网常见问题进行解决(http://www.kdniao.com/help),也可以进入快递鸟官网加入技术对接群进行咨询。

注:快递鸟官网-帮助与文档地址(快递物流api接口文档下载_电子面单接口文档-快递鸟code接口文档 )

快递鸟API接口DEMO下载:快递鸟「即时查询DEMO」让对接更简单

你可能感兴趣的:(java接口文档模板,小程序调用快递鸟接口,无法嵌入互操作类型,请改用适用的接口)