快递鸟物流接口技术文档

上传人:沈*** 文档编号:99428320 上传时间:2022-05-31 格式:DOC 页数:88 大小:3.06MB
返回 下载 相关 举报
快递鸟物流接口技术文档_第1页
第1页 / 共88页
快递鸟物流接口技术文档_第2页
第2页 / 共88页
快递鸟物流接口技术文档_第3页
第3页 / 共88页
点击查看更多>>
资源描述
快递鸟接口技术文档版本日期版本说明作者2014-12-013.0重新整理,根据功能分类,部分有调整文胜2014-01-113.1对接口的说明进行了注释,提高可读性汉汶2014-01-133.2新增推送接口汉汶2015-03-113.3新增批量订阅推送接口,删除3.2版本推送接口文胜2015-10-123.4新增订单分发接口,整理电子面单接口强2016-01-193.5重新调整在线下单接口强2016-03-013.6增加智选物流接口强2016-03-013.7分发及订阅接口更新任海洋2016-04-073.7.1推送接口更新任海洋2016-05-113.7.2电子面单新增通知快递员上门字段,推送接口新增货款状态推送詹益伟2016-07-014.0全新4.0接口,新增单号识别接口、智选物流接口、更新物流轨迹接口订阅查询詹益伟2016-9-264.0.1推送接口新增DataSign字段、订阅2.0新增仓库标识ID、智选物流接口新增字段胡蕾蕾2016-11-034.1新增在途监控增值服务强2016-12-134.1.1电子面单新增第三方订单号ThrOrderCode胡蕾蕾2017-1-104.2新增隐私快递胡蕾蕾2017-2-164.2.1新增代收货款业务胡蕾蕾2017-4-134.31、即时查询接口中轨迹状态新增0-无轨迹 2、普通回调接口中删除201状态3、修改智选物流接口文档4、电子面单接口添加特殊字符提示爱2017-4-254.41、 新增申请电子面单客户号接口2、 新增电子面单余额查询接口3、 新增电子面单单号回收接口4、 新增申请客户号信息推送接口爱2017-6-224.5新增短信接口旭安2017-7-144.6电子面单接口新增支持邮政快递包裹吴明名词定义必须要求说明R必填Required。O可选OptionalC报文中该参数在一定条件下可选Conditional1前言72概述82.1用户使用流程图82.2接口规及说明92.2.1报文及报文编码92.2.2接入步骤102.2.3接口数据包结构112.2.4JSON 例112.2.5流程示意图122.2.6网关地址122.3签名说明122.3.1关于签名122.3.2DataSign签名加密代码133下单153.1预约取件接口153.1.1功能说明153.1.2接口规则153.1.3系统级和应用级输入参数153.1.4返回结果参数183.1.5Json请求示例183.1.6Json请求返回示例193.2电子面单203.2.1功能说明203.2.2接口规则203.2.3系统级和应用级输入参数203.2.4返回结果参数243.3电子面单余量查询接口253.3.1功能说明253.3.2接口规则253.3.3系统级和应用级输入参数253.3.4返回结果参数263.3.5JSON请求示例263.3.6JSON返回示例263.4电子面单单号取消273.4.1功能说明273.4.2接口规则273.4.3系统级和应用级输入参数273.4.4返回结果参数283.4.5Json请求示例283.4.6Json请求返回示例283.5申请电子面单客户号283.5.1功能说明283.5.2接口规则293.5.3系统级和应用级输入参数293.5.4返回结果参数303.5.5Json请求示例303.5.6Json请求返回示例303.6申请客户号信息推送313.6.1功能说明313.6.2接口规则313.6.3系统级和应用级输入参数313.6.4返回结果参数313.6.5Json请求示例323.6.6Json请求返回示例323.7增值服务列表323.8安全接口333.8.1功能说明333.8.2接口规则333.8.3系统级和应用级输入参数333.8.4返回结果参数353.8.5JSON请求示例353.8.6JSON请求返回示例364轨迹查询374.1物流轨迹即时查询374.1.1功能说明374.1.2接口规则374.1.3系统级和应用级输入参数374.1.4返回结果参数374.1.5JSON请求示例384.1.6JSON返回示例384.2物流轨迹订阅查询404.2.1功能说明404.2.2接口规则404.2.3系统级和应用级输入参数404.2.4返回结果参数434.2.5JSON请求示例434.2.6JSON返回示例445异步推送回调接口455.1功能说明455.2接口规则455.3系统级和应用级输入参数455.3.1订阅查询结果RequestType:101465.3.2订阅查询增值版结果RequestType:102475.3.3货款状态RequestType:107485.4返回结果参数495.5JSON请求示例495.6JSON返回示例536智能服务536.1智选物流536.1.1.功能说明536.1.2.接口规则536.1.3.应用级输入参数546.1.4.返回结果参数566.1.5.JSON请求示例576.1.6.JSON返回示例596.2运费模板导入接口616.2.1.功能说明616.2.2.接口规则616.2.3.系统级输入参数616.2.4.应用级输入参数626.2.5.返回结果参数636.2.6.JSON请求示例636.2.7.JSON返回示例646.3单号识别656.3.1.功能说明656.3.2.接口规则656.3.3.系统级和应用级输入参数656.3.4.返回结果参数667在途监控增值版667.1物流轨迹即时查询增值版667.1.1功能说明667.1.2接口规则667.1.3系统级和应用级输入参数677.1.4返回结果参数677.1.5JSON请求示例687.1.6JSON返回示例687.2物流轨迹订阅查询增值版707.2.1功能说明707.2.2接口规则717.2.3系统级和应用级输入参数717.2.4返回结果参数747.2.5JSON请求示例747.2.6JSON返回示例758短信758.1短信发送758.1.1功能说明758.1.2接口规则758.1.3返回结果参数768.1.4JSON请求示例768.1.5JSON返回示例778.2短信模板778.2.1功能说明778.2.2接口规则778.2.3系统级和应用级输入参数778.2.4返回结果参数788.2.5JSON请求示例788.2.6JSON返回示例798.3短信黑798.3.1功能说明798.3.2接口规则798.3.3系统级和应用级输入参数798.3.4返回结果参数808.3.5JSON请求示例808.3.6JSON返回示例819附录819.1快递公司编码819.2常见问题解答Q&A819.3电子面单模板规格819.4返回编码列表8310技术支持831 前言快递鸟API旨在为电商、电商平台、物流工具、仓储系统等等系统提供专业、稳定、优质的物流服务,为不同的用户量身定做了专业的API接口服务,供不同的用户各取所需。本文档就各个API接口进行详细的说明,方便快递鸟的用户快速对接,方便快捷使用快递鸟服务。2 概述2.1 用户使用流程图快递鸟API全流程服务电商流程图基于电商现有的服务流程,快递鸟为电商、电商平台、ERP系统、仓储系统等系统在用户下单、选择物流、下单、打单、轨迹跟踪等关键节点,均提供了专业、高效的API接口,方便各个平台实现一次接入,便可使用国外主流物理公司的服务。快递鸟API全流程服务工具流程图对于物流工具,基于用户的操作习惯,只需要输入单号,快递鸟即可完成后续的物流公司识别、查询轨迹等工作,为工具类用户提供一站式的服务。2.2 接口规及说明2.2.1 报文及报文编码Json格式。编码格式:UTF-8交互协议上统一用UTF-8,避免传递中文数据出现乱码。2.2.2 接入步骤 注册成为快递鸟用户。注册成功后,登录用户管理后台就可以查看到用户所属唯一的商户ID和API key。按照快递鸟官网提示进行注册申请,注册成功后登录用户管理后台,您将得到由快递鸟提供的一组商户ID和API Key。商户ID是调用接口服务的明,不可更改、不可转用,API Key是应用访问API的签名附加密钥,必须妥善保存。两者关系类似于登录和密码,两者都会在签名和业务参数中使用。注册成功登录用户管理后台可以查看商户ID和API Key,需实名认证后才能申请开通接口。(1) 开发服务开发自身业务的服务,服务需遵循接口的定义规则。(2) 查看接口调用的DEMO快递鸟物流技术接口提供调用快递鸟物流接口的DEMO,包括网上在线订单下单、物流轨迹查询等物流行业标准化的下单操作流程与数据查询格式。提交接入处理的相关代码如有不明白的地方可与快递鸟物流技术接口人协作开发。DEMO下载地址:.kdniao./download 2.2.3 接口数据包结构图例 - 数据包结构 2.2.4 JSON 例string userID = 1109259;string keyValue = 56da2cf8-c8a2-44b2-b6fa-476cd7d1ba17;/加密私钥,由发货通提供string url = api.kdniao.cc/Ebusiness/EbusinessOrderHandle.aspx; /请求地址string DataType = 2; 2-jsonstring charset=UTF-8;/字符编码采用UTF-8string jsonStr= OrderCode:,ShipperCode:SF,LogisticCode:7; / JSON字符串string datasign =Utility.UrlEncodebase64 MD5,UTF-8,Encoding.UTF8;/把进行MD5加密,然后Base64编码,最后 进行URL编码string PostStr = RequestType=1002&EBusinessID= userID &RequestData=jsonStr &DataSign= datasign&DataType=DataType; /请求报文参数string post = this.DoPost;/ 通讯协议使用协议Post请求方式2.2.5 流程示意图2.2.6 网关地址测试接口:testapi.kdniao.cc:8081/Ebusiness/EbusinessOrderHandle.aspx测试电商ID=1237100,AppKey=518a73d8-1f7f-441a-b644-33e77b49d846正式接口:api.kdniao.cc/Ebusiness/EbusinessOrderHandle.aspx2.3 签名说明2.3.1 关于签名快递鸟和第三方电子商务公司系统进行对接,有一定的安全机制。采用IP认证加签名的方式对接,具体方案如下:(1) 防止数据被篡改在POST请求中会传递5个必须R参数RequestData=数据容EBusinessID=电商IDRequestType=请求指令类型DataSign=数据容签名:把请求容未编码+ApiKey进行MD5加密,然后Base64编码,最后进行URLutf-8编码DataType=返回数据类型注:DataSign生成后,对方接收到数据后,以同样的算法进行签名,生成摘要,对比两者的摘要是否相同,如果不同,说明传递过程中发生数据篡改,对接过程中如有不明白之处可双方技术协作进行(2) 调用接口的身份认证注册成为快递鸟用户后,会生成对应的电商ID和AppKey,电商ID相当于用户名,AppKey相当于密码。注:请勿遗漏或传递可能递增大快递鸟接口调用维护举例说明:(a) 假设RequestData容为: OrderCode:,ShipperCode:SF,LogisticCode:3经过URL编码的容为%7b%27OrderCode%27%3a%27%27%2c%27ShipperCode%27%3a%27SF%27%2c%27LogisticCode%27%3a%573%27%7d,EBusinessID为1109259,AppKey为56da2cf8-c8a2-44b2-b6fa-476cd7d1ba17(b) 那么DataSign签名的容为OrderCode:,ShipperCode:SF,LogisticCode:356da2cf8-c8a2-44b2-b6fa-476cd7d1ba17,经过md5和base64后的容就为OWFhM2I5N2ViM2U2MGRkMjc4YzU2NmVlZWI3ZDk0MmE=,在经过URL编码的容为OWFhM2I5N2ViM2U2MGRkMjc4YzU2NmVlZWI3ZDk0MmE%3d最终要发送的数据为RequestType=1002&EBusinessID=1109259&RequestData =%7b%27OrderCode%27%3a%27%27%2c%27ShipperCode%27%3a%27SF%27%2c%27LogisticCode%27%3a%573%27%7d &DataSign=OWFhM2I5N2ViM2U2MGRkMjc4YzU2NmVlZWI3ZDk0MmE%3d& DataType=2(c) 接收方收到数据后,获得EBusinessID和RequestData和DataSign等这几个数据。(d) 接收方对EBusinessID得到AppKey,RequestData+AppKey的数据进行md5和base64后的容就为OWFhM2I5N2ViM2U2MGRkMjc4YzU2NmVlZWI3ZDk0MmE=(e) 接收方判断签名后的数据跟传递过来的DataSign是否一致,如果一致进行业务操作,如果不一致返回错误。2.3.2 DataSign签名加密代码/电商Sign签名/容/Appkey/URL编码 /DataSign签名Public String Encrypt if return base64MD5, charset;return base64MD5, charset;/ 字符串MD5加密/要加密的字符串/密文Private string MD5byte buffer = System.Text.Encoding.GetEncoding.GetBytes;try System.Security.Cryptography.MD5CryptoServiceProvider check; check = new System.Security.Cryptography.MD5CryptoServiceProvider;byte somme = checkputeHash;string ret = ;foreach if a ret += 0 + a.ToString;else ret += a.ToString; return ret.ToLower;catch throw; Private static string base64returnConvert.ToBase64StringSystem.Text.Encoding.GetEncoding.GetBytes;3 下单3.1 预约取件接口3.1.1 功能说明预约取件接口是快递鸟提供给独立电商、仓储管理系统、物流供应链等物流系统平台使用的下单接口,为客户解决在线发货需求,客户通过网络选择快递公司发送请求通知贵公司有快递要发货,贵公司把数据通过此接口转发到快递鸟,由快递鸟为您提供通知快递员上门取件的服务。3.1.2 接口规则、订单编号不可重复提交,重复提交系统会返回具体错误代码。 、目前预约取件接口支持了:德邦、EMS、天地华宇、百世快递、京东、龙邦快递、顺丰快递、速递、韵达快递、圆通速递、宅急送,后续更多的快递公司正在对接中。 、接口只支持Json格式参数,接口指令1001。只支持POST请求方式,utf-8编码。 、支持增值服务,保价、代收货款、货款直退、货款垫付等。、测试地址:testapi.kdniao.cc:8081/api/oorderservice/正式地址:api.kdniao.cc/api/oorderservice3.1.3 系统级和应用级输入参数系统级输入参数应用级输入参数类型是否必须描述RequestData必填参数,请求容,JSON格式,须和DataType一致WarehouseIDStringO仓库标识WarehouseAddressStringO仓库地址CallBackStringO商户标识MemberIDStringO会员标识ShipperCodeStringR快递公司编码LogisticCodeStringO快递单号OrderCodeStringR订单编号MonthCodeStringC月结编码PayTypeIntR邮费支付方式:1-现付,2-到付,3-月结,4-第三方支付ExpTypeIntR快递类型:1-标准快件CostDoubleO寄件费运费OtherCostDoubleO其他费用ReceiverCompanyStringO收件人公司NameStringR收件人TelStringR与手机,必填一个MobileStringPostCodeStringO收件人ProvinceNameStringR收件省如省,不要缺少省CityNameStringR收件市如市,不要缺少市ExpAreaNameStringO收件区如福田区,不要缺少区或县AddressStringR收件人详细地址SenderCompanyStringO发件人公司NameStringR发件人TelStringR与手机,必填一个MobileStringPostCodeStringO发件人ProvinceNameStringO发件省如省,不要缺少省CityNameStringR发件市如市,不要缺少市ExpAreaNameStringO发件区如福田区,不要缺少区或县AddressStringR发件详细地址StartDateStringO上门取货时间段:yyyy-MM-dd HH:mm:ss格式化,本文中所有时间格式相同EndDateStringOWeightDoubleO物品总重量kgQuantityIntO件数/包裹数VolumeDoubleO物品总体积m3RemarkStringO备注AddServiceNameString0增值服务名称ValueString0增值服务值CustomerIDString0客户标识CommodityGoodsNameStringR商品名称GoodsCodeStringO商品编码GoodsquantityIntO件数GoodsPriceDoubleO商品价格GoodsWeightDoubleO商品重量kgGoodsDescStringO商品描述GoodsVolDoubleO商品体积m3EBusinessIDStringR电商IDRequestTypeStringR请求指令类型:1001DataSignStringR数据容签名DataTypeStringR请求、返回数据类型:2-json;3.1.4 返回结果参数参数名称类型必须要求说明EBusinessIDStringR电商用户IDOrderOrderCodeStringR订单编号ShipperCodeStringR快递公司编码LogisticCodeStringO快递单号SuccessBoolR成功与否ResultCodeStringR结果编号ReasonStringO失败原因UniquerRequestNumberStringR唯一标识3.1.5 Json请求示例 OrderCode: 9, ShipperCode: SF, PayType: 1, MonthCode: 7553045845, ExpType: 1, Cost: 1.0, OtherCost: 1.0, Sender: Company: LV, Name: Taylor, Mobile: , ProvinceName: , CityName: , ExpAreaName: 青浦区, Address: 明珠路 , Receiver: Company: GCCUI, Name: Yann, Mobile: ,ProvinceName: , CityName: , ExpAreaName: 区, Address: 三里屯街道 , Commodity: GoodsName: 鞋子, Goodsquantity: 1, GoodsWeight: 1.0 , AddService: Name: COD, Value: 1020 , Weight: 1.0, Quantity: 1, Volume: 0.0, Remark: 小心轻放3.1.6 Json请求返回示例 EBusinessID: 1237100, Success: true, Order: OrderCode: 9, ShipperCode : SF , LogisticCode : , ResultCode: 100, Reason: 3.2 电子面单3.2.1 功能说明电子面单接口是快递鸟提供给独立电商、仓储管理系统、物流供应链等物流系统平台使用的下单接口,满足客户在线发货需求并提供打印面单的服务,客户通过网络选择物流公司发送请求通知贵公司有快递要发货,贵公司把数据通过此接口转发到快递鸟,由快递鸟为您通知对应的快递公司快递员上门取件。电子面单成功下单后,快递鸟系统将自动订阅,一旦轨迹发生变化时,快递鸟将调用客户方推送接收接口。同时若客户使用代收货款服务,快递鸟会将代收货款的货款状态独立推送给用户。3.2.2 接口规则、只支持Json格式。接口指令1007。、订单编号不可重复提交,重复提交系统会返回具体错误代码。、目前接口支持了:顺丰SF、EMSEMS、宅急送ZJS、圆通YTO、百世快递HTKY、ZTO、韵达YD、申通STO、德邦DBL、优速UC、京东JD、信丰XFEX、全峰QFKD、跨越速运KYSY、安能小包ANE、快捷快递FAST、国通GTO、天天快递HHTT、邮政快递包裹YZPY,后续更多的快递公司正在对接中。散户模式无需电子面单客户号支持快递公司:顺丰SF、EMSEMS仅支持省发货、快捷快递FAST、宅急送ZJS、邮政快递包裹YZPY,后续更多的快递公司正在对接中。、测试地址:testapi.kdniao.cc:8081/api/eorderservice/、正式地址:api.kdniao.cc/api/EOrderService 、请求报文中不允许出现以下特殊字符: # & + 3.2.3 系统级和应用级输入参数系统级输入参数应用级输入参数类型是否必须描述RequestData必填参数,请求容,JSON格式,须和DataType一致CallBackStringO用户自定义回调信息MemberIDStringO会员标识平台方与快递鸟统一用户标识的商家IDCustomerNameStringO电子面单客户账号与快递网点申请或通过快递鸟官网申请或通过申请电子面单客户号申请CustomerPwdStringO电子面单密码SendSiteStringO收件网点标识ShipperCodeStringR快递公司编码LogisticCodeStringO快递单号ThrOrderCodeStringO第三方订单号OrderCodeStringR订单编号MonthCodeStringC月结编码PayTypeIntR邮费支付方式:1-现付,2-到付,3-月结,4-第三方支付ExpTypeStringR快递类型:1-标准快件IsNoticeIntO是否通知快递员上门揽件:0-通知;1-不通知;不填则默认为1CostDoubleO寄件费运费OtherCostDoubleO其他费用ReceiverCompanyStringO收件人公司NameStringR收件人TelStringR与手机,必填一个MobileStringPostCodeStringO收件人ProvinceNameStringR收件省如省,不要缺少省CityNameStringR收件市如市,不要缺少市ExpAreaNameStringO收件区如福田区,不要缺少区或县AddressStringR收件人详细地址SenderCompanyStringO发件人公司NameStringR发件人TelStringR与手机,必填一个MobileStringPostCodeStringO发件人ProvinceNameStringR发件省如省,不要缺少省CityNameStringR发件市如市,不要缺少市ExpAreaNameStringO发件区如福田区,不要缺少区或县AddressStringR发件详细地址StartDateStringO上门取货时间段:yyyy-MM-dd HH:mm:ss格式化,本文中所有时间格式相同EndDateStringOWeightDoubleO物品总重量kgQuantityIntO件数/包裹数VolumeDoubleO物品总体积m3RemarkStringO备注AddServiceNameString0增值服务名称ValueString0增值服务值CustomerIDString0客户标识CommodityGoodsNameStringR商品名称GoodsCodeStringO商品编码GoodsquantityIntO件数GoodsPriceDoubleO商品价格GoodsWeightDoubleO商品重量kgGoodsDescStringO商品描述GoodsVolDoubleO商品体积m3IsReturnPrintTemplateStringO返回电子面单模板:0-不需要;1-需要IsSendMessageIntO是否订阅短信0-不需要;1-需要TemplateSizeStringO模板尺寸EBusinessIDStringR商户IDRequestTypeStringR请求指令类型:1007DataSignStringR数据容签名DataTypeStringR请求、返回数据类型: 2-json3.2.4 返回结果参数l 同步返回参数名称类型必须要求说明EBusinessIDStringR电商用户IDOrderOrderCodeStringR订单编号ShipperCodeStringR快递公司编码LogisticCodeStringR快递单号MarkDestinationStringO大头笔OriginCodeStringO始发地区域编码OriginNameStringO始发地/始发网点DestinatioCodeStringO目的地区域编码DestinatioNameStringO目的地/到达网点SortingCodeStringO分拣编码PackageCodeStringO集包编码SuccessBoolR成功与否ResultCodeStringR错误编码ReasonStringO失败原因UniquerRequestNumberStringR唯一标识PrintTemplateStringO面单打印模板EstimatedDeliveryTimeStringO订单预计到货时间yyyy-mm-ddCallbackStringO用户自定义回调信息SubCountIntO子单数量SubOrdersStringO子单号SubPrintTemplatesStringO子单模板ReceiverSafePhoneStringO收件人安全SenderSafePhoneString0寄件人安全DialPageStringR拨号页面网址转换成二维码可扫描拨号3.3 电子面单余量查询接口3.3.1 功能说明用户查询客户号在快递公司的单号剩余量。3.3.2 接口规则(1) 、接口只支持Json格式参数,接口指令1127。只支持POST请求方式,utf-8编码。(2) 、目前支持快递公司:优速,韵达,后续更多的快递公司正在对接中。3.3.3 系统级和应用级输入参数系统级输入参数类型应用级输入参数必须要求描述RequestData必填参数,请求容,JSON格式,须和DataType一致StringShipperCodeR快递公司编码StringCustomerNameR电子面单账号StringCustomerPwdO电子面单密码StringStationCodeO网点编码StringStationNameO网点EBusinessIDStringR电商IDRequestTypeStringR请求指令类型:1127DataSignStringR数据容签名DataTypeStringR请求、返回数据类型: 2-json;3.3.4 返回结果参数参数名称类型必须要求说明EbusinessIDStringR用户IDSuccessBoolR成功与否:true,falseReasonStringO原因ResultCodeStringR返回结果编号EorderBalanceTotalNumIntO累计充值数量,电子面单总量AvailableNumIntO可用量 ShipperCode: UC, CustomerName: 80238728, CustomerPwd: c0bfe0ba86b66bae5426303c53db0a81, StationCode: 3001, StationName: 福田网点3.3.5 JSON请求示例3.3.6 JSON返回示例 EBusinessID: 1261602, Success: true, Reason: , ResultCode: 100, EorderBalance: AvailableNum: 0, TotalNum: 0 3.4 电子面单单号取消3.4.1 功能说明快递鸟通用接口提交快递公司编码、快递单号,则可以取消提交单号。仅支持未揽件状态快递单进行取消,取消后的回收规则以快递公司为准。3.4.2 接口规则(1) 、接口指令1147。(2) 、目前支持快递公司:优速,后续更多的快递公司正在对接中。3.4.3 系统级和应用级输入参数系统级输入参数类型应用级输入参数必须要求描述RequestData必填参数,请求容,JSON格式,须和DataType一致StringShipperCodeR快递公司编码StringExpNoR运单号StringCustomerNameR客户号StringCustomerPwdO客户号密码EBusinessIDStringR电商IDRequestTypeStringR请求指令类型:1147DataSignStringR数据容签名DataTypeStringR请求、返回数据类型: 2-json;3.4.4 返回结果参数参数名称类型必须要求说明EbusinessIDStringR用户IDSuccessBoolR成功与否:true,falseResultCodeStringO结果编码ReasonStringO原因3.4.5 Json请求示例 ShipperCode: UC, ExpNo: 0, CustomerName: 80238728, CustomerPwd: c0bfe0ba86b66bae5426303c53db0a8b3.4.6 Json请求返回示例 EBusinessID: 1261602, Success: true, ResultCode: 1003.5 申请电子面单客户号3.5.1 功能说明客户通过快递鸟平台向快递公司申请客户号3.5.2 接口规则、接口只支持Json格式参数,接口指令1107。只支持POST请求方式,utf-8编码。 、测试地址:testapi.kdniao.cc:8081/api/apiservice(3) 、正式地址:api.kdniao.cc/api/apiservice(4) 、目前支持快递公司:优速,后续更多的快递公司正在对接中。3.5.3 系统级和应用级输入参数系统级输入参数类型应用级输入参数必须要求描述RequestData必填参数,请求容,JSON格式,须和DataType一致stringShipperCodeR快递公司编码StationCodeR网点编码StationNameR网点ApplyIDO申请ID用户记录在快递公司的标识CompanyO公司NameR联系人TelCMobileC手机ProvinceNameR省份ProivnceCodeO省编码CityNameR城市CityCodeO城市编码ExpAreaNameR区县ExpAreaCodeO区县编码AddressR详细地址EBusinessIDStringR电商IDRequestTypeStringR请求指令类型:1107DataSignStringR数据容签名DataTypeStringR请求、返回数据类型: 2-json;3.5.4 返回结果参数参数名称类型是否必须描述EbusinessIDStringR用户IDSuccessBoolR成功与否:true,falseResultCodeStringO结果编码ReasonStringO原因3.5.5 Json请求示例 ShipperCode: UC, Company: XXX, ApplyID: 1261602, Name: hoo123, Tel: , Mobile: , ProvinceName: 省, ProivnceCode: 440000, CityName: 市, CityCode: 440300, ExpAreaName: 宝安区, ExpAreaCode: 440306, Address: 西乡, StationCode: 西乡网点, StationName: 西乡网点3.5.6 Json请求返回示例 EBusinessID: 1261602, Success: true, Reason: 提交申请成功, ResultCode: 1003.6 申请客户号信息推送3.6.1 功能说明将审核通过客户号信息发送到用户配置的接收地址。3.6.2 接口规则、接口指令1117。 2目前支持快递公司:优速,后续更多的快递公司正在对接中。3.6.3 系统级和应用级输入参数系统级输入参数类型应用级输入参数必须要求描述PushData请求容,JSON格式,须和DataType一致StringCustomerNameR客户号StringCustomerPwdR客户号密码StringStationCodeR网点编号StringStationNameR网点名称EBusinessIDStringR用户标识RequestTypeStringR请求指令类型:1117PushTimeStringR推送时间3.6.4 返回结果参数参数名称类型必须要求说明EBusinessIDStringR请求用户标识RequestTypeStringR请求指令SuccessBoolR成功与否MessageStringO返回消息3.6.5 Json请求示例RequestData= CustomerName: 80237910, CustomerPwd: c0bfe0ba86b66bae5426303c53db0a8b, StationCode: 闵行八部, StationName: 闵行八部&EBusinessID=1261602&PushTime=2017-04-18 23:34:29&RequestType=11173.6.6 Json请求返回示例 EBusinessID: 1261602, Message: 成功, RequestType: 1117, Success: true3.7 增值服务列表名称代码说明备注普通代收货款CODValue 为货款,保留3 位小数。CustomerID为代收货款卡号快递公司自有代收货款业务货款直退CODBACK签收后快递鸟直接返款给客户,返款时效规货款垫付CODPAY最快发件后4小时快递鸟垫付返款给商家隐私快递SafeMailSafeMail安全号生成规则1:隐藏收件人信息,2:隐身发件人信息。3:同时隐藏收件人,发件人信息保价INSUREvalue 为声明价值,保留3 位小数注:使用快递鸟代收货款服务,需申请快递鸟的代收货款服务,填写用于还款的银行卡号等信息。3.8 安全接口3.8.1 功能说明用户提供的订单号及用户信息,按照规则生成安全和二维码图片返回给用户使用。由快递运单决定安全的生命周期。3.8.2 接口规则、接口只支持Json格式参数,接口指令3001。只支持POST请求方式,utf-8编码。、测试地址:testapi.kdniao
展开阅读全文
相关资源
正为您匹配相似的精品文档
相关搜索

最新文档


当前位置:首页 > 办公文档 > 工作计划


copyright@ 2023-2025  zhuangpeitu.com 装配图网版权所有   联系电话:18123376007

备案号:ICP2024067431-1 川公网安备51140202000466号


本站为文档C2C交易模式,即用户上传的文档直接被用户下载,本站只是中间服务平台,本站所有文档下载所得的收益归上传人(含作者)所有。装配图网仅提供信息存储空间,仅对用户上传内容的表现方式做保护处理,对上载内容本身不做任何修改或编辑。若文档所含内容侵犯了您的版权或隐私,请立即通知装配图网,我们立即给予删除!