快递鸟一次性对接2000+物流接口

API服务
首页>API服务>隐私快递API

API组件列表
下单类接口
电子面单API
上门取件API
预约取件API
查询类接口
即时查询API
物流跟踪API
在途监控API
快递查询API
物流查询地图API
增值类接口
物流短信API
单号识别API
智能地址解析API
首页 > API文档 > 隐私快递API
隐私快递API
申请API
隐私快递是一种利用隐私通讯技术实现在隐藏收/发件人信息的同时，快递员通过扫描二维码或者拨打安全号码与收/发件人直接通话的方法，可以杜绝物流运输过程中，对收/发件人隐私的获取和泄露，为收/发件人提供能保护隐私信息的服务
应用场景功能说明使用流程API参数接入流程demo下载
应用场景
（1）电商买家在提交订单时，勾选隐私快递选项
（2）打单工具在商户打单时选择隐私快递模式
（3）ERP集成隐私电子面单打单功能，供商户使用
（4）APP、公众号、网站等下单模块，集成隐私快递功能
功能说明
使用流程
API参数
一、接口描述/说明
安全号码
（1）接口需要指定快递单号的快递公司编码，格式不对或则编码错误都会返失败的信息。
如：EMS物流单号应选择快递公司编码（EMS）查看快递公司编码
（2）返回的物流跟踪信息按照发生的时间升序排列。
（3）接口指令3001。
（4）接口支持的消息接收方式为HTTP POST，请求方法的编码格式(utf-8)："application/x-www-form-urlencoded;charset=utf-8"。
（5）接口地址： API测试地址：http://sandboxapi.kdniao.com:8080/kdniaosandbox/gateway/exterfaceInvoke.json
API正式地址：https://api.kdniao.com/api/apiservice
请求系统级参数说明：
参数名称类型说明必须要求
RequestDataString请求内容需进行URL(utf-8)编码。请求内容JSON格式，须和DataType一致。是
EBusinessIDString商户ID，请在我的服务页面查看。是
RequestTypeString请求指令类型：3001是
DataSignString数据内容签名：把(请求内容(未编码)+AppKey)进行MD5加密，然后Base64编码，最后 进行URL(utf-8)编码。详细过程请查看Demo。是
DataTypeString请求、返回数据类型：2-json；否
隐私电子面单
（1）电子面单接口是快递鸟提供给独立电商、仓储管理系统、物流供应链等物流系统平台使用的下单接口。
（2）为客户解决在线发货需求，商户通过网络选择快递公司发送请求通知快递公司有快递要发货。
（3） 客户把数据通过此接口转发到快递鸟，由快递鸟为您安排快递员上门取件的服务。
（4）订单编号（OrderCode）不可重复提交，重复提交系统会返回具体错误代码。
（5）接口支持的消息接收方式为HTTP POST，请求方法的编码格式(utf-8)："application/x-www-form-urlencoded;charset=utf-8"。
（6）接口地址： API测试地址：http://sandboxapi.kdniao.com:8080/kdniaosandbox/gateway/exterfaceInvoke.json
API正式地址：https://api.kdniao.com/api/EOrderService
请求系统级参数说明：
参数名称类型说明必须要求
RequestDataString请求内容需进行URL(utf-8)编码。请求内容JSON格式，须和DataType一致。是
EBusinessIDString商户ID，请在我的服务页面查看。是
RequestTypeString请求指令类型：1007是
DataSignString数据内容签名：把(请求内容(未编码)+AppKey)进行MD5加密，然后Base64编码，最后 进行URL(utf-8)编码。详细过程请查看Demo。是
DataTypeString请求、返回数据类型：只支持JSON格式否
二、接口参数
安全号码
请求内容字段定义：
参数名称类型说明是否必须
OrderCodeString订单编号是
ShipperCodeString快递公司编码是
LogisticCodeString快递单号是
ReceiverCompanyString收件人公司否
NameString收件人是
TelString电话与手机，必填一个是
MobileString
PostCodeString收件人邮编否
ProvinceNameString收件省（如广东省，不要缺少“省”）是
CityNameString收件市（如深圳市，不要缺少“市”）是
ExpAreaNameString收件区（如福田区，不要缺少“区”或“县”）否
AddressString收件人详细地址是
SenderCompanyString发件人公司否
NameString发件人是
TelString电话与手机，必填一个是
MobileString
PostCodeString发件人邮编否
ProvinceNameString发件省（如广东省，不要缺少“省”）是
CityNameString发件市（如深圳市，不要缺少“市”）是
ExpAreaNameString发件区（如福田区，不要缺少“区”或“县”）否
AddressString发件人详细地址是
HideTypeInt安全号生成规则（1，隐藏收件人信息，2.隐身发件人信息，3.同时隐藏收件人，发件人信息）是
返回参数定义：
参数名称类型说明是否必须
OrderCodeString订单编号是
ShipperCodeString快递公司编码是
LogisticCodeString快递单号是
ReceiverSafePhoneString收件人安全电话是
ReceiverPhoneString收件人电话是
SenderSafePhoneString寄件人安全电话是
SenderPhoneString寄件人电话是
ReceiverSafePhoneString收件人安全电话是
DialPageString拨号页面网址（转换成二维码可扫描拨号）是
ResultCodeString错误编码是
SuccessBool成功与否是
ReasonString失败原因否
隐私电子面单
请求内容字段定义：
参数名称类型说明是否必须
CallBackString用户自定义回调信息否
MemberIDString会员标识否
CustomerNameString电子面单客户账号（与快递网点申请）否
CustomerPwdString电子面单密码否
SendSiteString收件网点标识否
ShipperCodeString快递公司编码是
LogisticCodeString快递单号否
OrderCodeString订单编号是
ThrOrderCodeString第三方订单编号否
MonthCodeString月结编码可选
PayTypeInt邮费支付方式:1-现付，2-到付，3-月结，4-第三方支付是
ExpTypeString快递类型：1-标准快件是
IsNoticeInt是否通知快递员上门揽件：0-通知；1-不通知；不填则默认为0否
CostDouble寄件费（运费）否
OtherCostDouble其他费用否
ReceiverCompanyString收件人公司否
NameString收件人是
TelString电话与手机，必填一个是
MobileString
PostCodeString收件人邮编否
ProvinceNameString收件省（如广东省，不要缺少“省”）是
CityNameString收件市（如深圳市，不要缺少“市”）是
ExpAreaNameString收件区（如福田区，不要缺少“区”或“县”）否
AddressString收件人详细地址是
SenderCompanyString发件人公司否
NameString发件人是
TelString电话与手机，必填一个是
MobileString
PostCodeString发件人邮编否
ProvinceNameString发件省（如广东省，不要缺少“省”）是
CityNameString发件市（如深圳市，不要缺少“市”）是
ExpAreaNameString发件区（如福田区，不要缺少“区”或“县”）否
AddressString发件人详细地址是
StartDateString上门取货时间段:"yyyy-MM-dd HH:mm:ss"格式化，本文中所有时间格式相同否
EndDateString否
WeightDouble物品总重量kg否
QuantityInt件数/包裹数否
VolumeDouble物品总体积m3否
RemarkString备注否
AddServices
AddServiceNameString增值服务名称否
ValueString增值服务值否
CustomerIDString客户标识（选填）否
Commoditys
CommodityGoodsNameString商品名称是
GoodsCodeString商品编码否
GoodsquantityInt商品数量否
GoodsPriceDouble商品价格否
GoodsWeightDouble商品重量kg否
GoodsDescString商品描述否
GoodsVolDouble商品体积m3否
IsReturnPrintTemplateString返回电子面单模板：0-不需要；1-需要否
返回参数定义：
参数名称类型说明必须要求
EBusinessIDString用户ID是
OrderOrderCodeString订单编号是
ShipperCodeString快递公司编码是
LogisticCodeString快递单号是
MarkDestinationString大头笔否
OriginCodeString始发地区域编码否
OriginNameString始发地/始发网点否
DestinatioCodeString目的地区域编码否
DestinatioNameString目的地/到达网点否
SortingCodeString分拣编码否
PackageCodeString集包编码否
SuccessBool成功与否是
ResultCodeString错误编码是
ReasonString失败原因否
UniquerRequestNumberString唯一标识是
PrintTemplateString面单打印模板否
EstimatedDeliveryTimeString订单预计到货时间yyyy-mm-dd否
CallbackString用户自定义回调信息否
SubCountInt子单数量否
SubOrdersString子单号否
SubPrintTemplatesString子单模板否
三、示例
安全号码
请求示例 JSON
{
        "OrderCode": "012657700387",
        "ShipperCode": "SF",
        "LogisticCode": "612018489480",
        "Receiver": 
        {
            "Company": "LV",
            "Name": "张勇",
            "Mobile": "15223830813",
            "ProvinceName": "重庆市",
            "CityName": "重庆市",
            "ExpAreaName": "九龙坡",
            "Address": "九龙35号"
        },
        "Sender": 
        {
            "Company": "GCCUI",
            "Name": "张勇",
            "Mobile": "15223830813",
            "ProvinceName": "北京",
            "CityName": "北京",
            "ExpAreaName": "朝阳区",
            "Address": "三里屯街道雅秀大厦"
        },
        "HideType": "3"
      }'
返回示例 JSON
{
  "EBusinessID": "1261600",
  "OrderCode": "012657700387",
  "ShipperCode": "SF",
  "Success": true,
  "Reason": "",
  "ResultCode": "100",
  "LogisticCode": "612018489480",
  "ReceiverSafePhone": "4000988856 转 167306",
  "ReceiverPhone": "15223830813",
  "SenderSafePhone": "4000988856 转 940007",
  "SenderPhone": "15223830813",
  "DialPage": "http://192.168.1.109:8083//KDN170103211401580104"
}
隐私电子面单
请求示例 JSON
{
    "OrderCode": "012657700387",
    "ShipperCode": "HTKY",
    "PayType": 1,
    "ExpType": 1,
    "Cost": 1.0,
    "OtherCost": 1.0,
    "Sender": {
      "Company": "LV",
      "Name": "Taylor",
      "Mobile": "15018442396",
      "ProvinceName": "上海",
      "CityName": "上海",
      "ExpAreaName": "青浦区",
      "Address": "明珠路73号"
    },
    "Receiver": {
      "Company": "GCCUI",
      "Name": "Yann",
      "Mobile": "15018442396",
      "ProvinceName": "北京",
      "CityName": "北京",
      "ExpAreaName": "朝阳区",
      "Address": "三里屯街道雅秀大厦"
    },
    "Commodity": [
      {
        "GoodsName": "鞋子",
        "Goodsquantity": 1,
        "GoodsWeight": 1.0
      }
    ],
    "AddService": [
      {
        "Name": "SafeMail",
        "Value": "3"
      }
    ],
    "Weight": 1.0,
    "Quantity": 1,
    "Volume": 0.0,
    "Remark": "小心轻放",
    "IsReturnPrintTemplate":1
    }
返回示例 JSON
失败：
  {
      "EBusinessID": "1237100",
      "ResultCode": "105",
      "Reason": "订单号已存在，请勿重复操作"，
      "UniquerRequestNumber":"5e66486b-8fbc-4131-b875-9b13d2ad1354"
  }
  成功：
  {
    "EBusinessID": "1237100",
    "Order": {
      "OrderCode": "012657700387",
      "ShipperCode": "HTKY",
      "LogisticCode": "50002498503427",
      "MarkDestination": "京-朝阳(京-1)",
      "OriginCode": "200000",
      "OriginName": "上海分拨中心",
      "PackageCode": "北京"
    },
    "PrintTemplate":"此处省略打印模板HTML内容",
    "EstimatedDeliveryTime":"2016-03-06",
    "Callback":"调用时传入的Callback",
    "Success": true,
    "ResultCode": "100",
    "Reason": "成功"
  }
接入流程
demo下载
接口接入技术文档
隐私快递接口Demo工具.NET版
隐私快递接口Demo工具.PHP版
隐私快递接口Demo工具.JAVA版
隐私快递接口Demo工具.PYTHON版
隐私快递接口Demo工具.GO版
隐私快递接口Demo工具.NODE.JS版

相关文档与更多帮助？

30万+
数十万客户的选择
5.8亿次+
日均处理物流数据次数
1450万+
日均千万订单数据处理
2000家+
支持全国2000+家物流商

热门产品

在途监控快递查询物流查询地图版电子面单物流管家SaaS管理工具企业寄件SaaS管理工具

解决方案

电商平台物流解决方案ISV系统商解决方案连锁门店发货解决方案商家打单发货解决方案退换货上门取件方案聚合寄件上门取件方案C2C上门取件方案国际物流查询解决方案

接口API

API接口文档快递鸟API接口DEMO下载

关于我们

公司介绍企业动态联系我们法律声明合作伙伴快递鸟接口服务协议用户隐私政策物流生态平台

友情链接

商派海淘转运FEC富润电商递易智能
咨询电话：400-8699-100服务邮箱：service@kdniao.com
微信公众号
微信订阅号
微信扫码寄件
版权所有：深圳市快金数据技术服务有限公司  粤ICP备15010928号-1增值电信业务许可证：合字B2-20230224粤公安备案号：44030402002993
技术对接x
扫码寄件x
在线咨询

Hi~ 我在线

欢迎您随时咨询
×
扫码查寄件
扫码寄件
技术对接
技术对接
试用开通