API服务
即时查询API物流跟踪API预约取件API电子面单API单号识别API在途监控API代收货款API隐私快递API
隐私快递API
申请API
隐私快递是一种利用隐私通讯技术实现在隐藏收/发件人信息的同时,快递员通过扫描二维码或者拨打安全号码与收/发件人直接通话的方法,可以杜绝物流运输过程中,对收/发件人隐私的获取和泄露,为收/发件人提供能保护隐私信息的服务
应用场景
(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://api.kdniao.cc/api/apiservice
API正式地址:http://api.kdniao.com/api/apiservice
请求系统级参数说明:
参数名称类型说明必须要求
RequestDataString请求内容需进行URL(utf-8)编码。请求内容JSON格式,须和DataType一致。R
EBusinessIDString商户ID,请在我的服务页面查看。R
RequestTypeString请求指令类型:3001R
DataSignString数据内容签名:把(请求内容(未编码)+AppKey)进行MD5加密,然后Base64编码,最后 进行URL(utf-8)编码。详细过程请查看Demo。R
DataTypeString请求、返回数据类型:2-json;O
备注:R-必填(Required),O-可选(Optional),C-报文中该参数在一定条件下可选(Conditional)
隐私电子面单
(1)电子面单接口是快递鸟提供给独立电商、仓储管理系统、物流供应链等物流系统平台使用的下单接口。
(2)为客户解决在线发货需求,商户通过网络选择快递公司发送请求通知快递公司有快递要发货。
(3) 客户把数据通过此接口转发到快递鸟,由快递鸟为您安排快递员上门取件的服务。
(4)订单编号(OrderCode)不可重复提交,重复提交系统会返回具体错误代码。
(5)接口支持的消息接收方式为HTTP POST,请求方法的编码格式(utf-8):"application/x-www-form-urlencoded;charset=utf-8"
(6)接口地址: API测试地址:http://testapi.kdniao.cc:8081/api/EOrderService
API正式地址:http://api.kdniao.cc/api/EOrderService
请求系统级参数说明:
参数名称类型说明必须要求
RequestDataString请求内容需进行URL(utf-8)编码。请求内容JSON格式,须和DataType一致。R
EBusinessIDString商户ID,请在我的服务页面查看。R
RequestTypeString请求指令类型:1007R
DataSignString数据内容签名:把(请求内容(未编码)+AppKey)进行MD5加密,然后Base64编码,最后 进行URL(utf-8)编码。详细过程请查看Demo。R
DataTypeString请求、返回数据类型:只支持JSON格式O
备注:R-必填(Required),O-可选(Optional),C-报文中该参数在一定条件下可选(Conditional)
二、接口参数
安全号码
请求内容字段定义:
参数名称类型说明是否必须
OrderCodeString订单编号R
ShipperCodeString快递公司编码R
LogisticCodeString快递单号R
ReceiverCompanyString收件人公司O
NameString收件人R
TelString电话与手机,必填一个R
MobileString
PostCodeString收件人邮编O
ProvinceNameString收件省(如广东省,不要缺少“省”)R
CityNameString收件市(如深圳市,不要缺少“市”)R
ExpAreaNameString收件区(如福田区,不要缺少“区”或“县”)O
AddressString收件人详细地址R
SenderCompanyString发件人公司O
NameString发件人R
TelString电话与手机,必填一个R
MobileString
PostCodeString发件人邮编O
ProvinceNameString发件省(如广东省,不要缺少“省”)R
CityNameString发件市(如深圳市,不要缺少“市”)R
ExpAreaNameString发件区(如福田区,不要缺少“区”或“县”)O
AddressString发件人详细地址R
HideTypeInt安全号生成规则(1,隐藏收件人信息,2.隐身发件人信息,3.同时隐藏收件人,发件人信息)R
返回参数定义:
参数名称类型说明是否必须
OrderCodeString订单编号R
ShipperCodeString快递公司编码R
LogisticCodeString快递单号R
ReceiverSafePhoneString收件人安全电话R
ReceiverPhoneString收件人电话R
SenderSafePhoneString寄件人安全电话R
SenderPhoneString寄件人电话R
ReceiverSafePhoneString收件人安全电话R
DialPageString拨号页面网址(转换成二维码可扫描拨号)R
ResultCodeString错误编码R
SuccessBool成功与否R
ReasonString失败原因O
隐私电子面单
请求内容字段定义:
参数名称类型说明是否必须
CallBackString用户自定义回调信息O
MemberIDString会员标识O
CustomerNameString电子面单客户账号(与快递网点申请)O
CustomerPwdString电子面单密码O
SendSiteString收件网点标识O
ShipperCodeString快递公司编码R
LogisticCodeString快递单号O
OrderCodeString订单编号R
ThrOrderCodeString第三方订单编号O
MonthCodeString月结编码C
PayTypeInt邮费支付方式:1-现付,2-到付,3-月结,4-第三方支付R
ExpTypeString快递类型:1-标准快件R
IsNoticeInt是否通知快递员上门揽件:0-通知;1-不通知;不填则默认为0O
CostDouble寄件费(运费)O
OtherCostDouble其他费用O
ReceiverCompanyString收件人公司O
NameString收件人R
TelString电话与手机,必填一个R
MobileString
PostCodeString收件人邮编O
ProvinceNameString收件省(如广东省,不要缺少“省”)R
CityNameString收件市(如深圳市,不要缺少“市”)R
ExpAreaNameString收件区(如福田区,不要缺少“区”或“县”)O
AddressString收件人详细地址R
SenderCompanyString发件人公司O
NameString发件人R
TelString电话与手机,必填一个R
MobileString
PostCodeString发件人邮编O
ProvinceNameString发件省(如广东省,不要缺少“省”)R
CityNameString发件市(如深圳市,不要缺少“市”)R
ExpAreaNameString发件区(如福田区,不要缺少“区”或“县”)O
AddressString发件人详细地址R
StartDateString上门取货时间段:"yyyy-MM-dd HH:mm:ss"格式化,本文中所有时间格式相同O
EndDateStringO
WeightDouble物品总重量kgO
QuantityInt件数/包裹数O
VolumeDouble物品总体积m3O
RemarkString备注O
AddServices
AddServiceNameString增值服务名称O
ValueString增值服务值O
CustomerIDString客户标识(选填)O
Commoditys
CommodityGoodsNameString商品名称R
GoodsCodeString商品编码O
GoodsquantityInt商品数量O
GoodsPriceDouble商品价格O
GoodsWeightDouble商品重量kgO
GoodsDescString商品描述O
GoodsVolDouble商品体积m3O
IsReturnPrintTemplateString返回电子面单模板:0-不需要;1-需要O
返回参数定义:
参数名称类型说明必须要求
EBusinessIDString用户IDR
OrderOrderCodeString订单编号R
ShipperCodeString快递公司编码R
LogisticCodeString快递单号R
MarkDestinationString大头笔O
OriginCodeString始发地区域编码O
OriginNameString始发地/始发网点O
DestinatioCodeString目的地区域编码O
DestinatioNameString目的地/到达网点O
SortingCodeString分拣编码O
PackageCodeString集包编码O
SuccessBool成功与否R
ResultCodeString错误编码R
ReasonString失败原因O
UniquerRequestNumberString唯一标识R
PrintTemplateString面单打印模板O
EstimatedDeliveryTimeString订单预计到货时间yyyy-mm-ddO
CallbackString用户自定义回调信息O
SubCountInt子单数量O
SubOrdersString子单号O
SubPrintTemplatesString子单模板O
三、示例
安全号码
请求示例 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下载
在线咨询
商务合作群:
526574204
技术对接群:
340378554
400-9633321
免费获取API