提供统一格式的HTTPPOST或GET调用接口,并返回统一格式JSON数据。
请求参数:
param数据结构:
data数据结构
eOrder数据结构
注意:eOrder实际返回的字段各家快递公司不同,以实际返回为准
请求参数示例
{ "result":true, "returnCode":"200", "message":"提交成功", "data":{ "taskId":"",//任务ID "orderId":""//订单ID "kuaidinum":""//快递单号 "eOrder":"[\"destName\":null,\"orgName\":null,\"pkgCode\":null,\"pkgName\":null,\"bulkpen\":\"上海-S33-K27-P\",\"orgExtra\":null}]" }}说明:
订单有状态变更是会触发回调,回调后如果没有得到合作方正确返回,会重复回调多2次,即最多回调3次。间隔30分钟。
提供统一格式的HTTPPOST,并返回统一格式JSON数据。
请求报头:Content-Type=application/x-www-form-urlencoded;charset=UTF-8
data数据结构:
taskId=****** sign=****** param={ "kuaidicom":"yuantong", "kuaidinum":"1234567890", "status":"200", "message":"成功", "data":{ "orderId":"*****", "status":"0", "courierName":"王大", "courierMobile":"13800138000", "weight":"1", "defPrice":"15.0", "freight":"5.1", "volume":"120", "actualWeight":"1", "feeDetails":[{ "feeType":"PACKAGINGFEE", "feeDesc":"包装费", "amount":"0.8", "payStatus":1 }], "printTaskId":"*****", "imgBase64":"*****" } }返回结果示例
{ "result":true, "returnCode":"200", "message":"成功"}2.4回调响应报文及错误码解释字段名称字段含义resulttrue表示成功,false表示失败。如果提交回调接口的地址失败,30分钟后重新回调,3次仍旧失败的,自动放弃returnCode200:提交成功500:服务器错误其他错误请自行定义message返回的提示三、商家寄件下单取消接口对下完单且取件前的订单进行取消操作。对于不需邮寄的订单请及时进行取消,当月订单最晚需在次月8日前取消,否则将无法取消。
method=cancelkey=******sign=4BBDE07660E5EFF90873642CFAE9A8DDt=1647258957705param={ "taskId":"*****", "orderId":"*****", "cancelMsg":"暂时不寄件了"}返回结果示例
{ "result":true, "returnCode":"200", "message":"取消成功", "data":{}}说明:
查看从出发地到目的地的价格
method=pricekey=******sign=4BBDE07660E5EFF90873642CFAE9A8DDt=1647258957705param={ "kuaidicom":"yuantong", "sendManPrintAddr":"西藏日喀则市定日县珠穆朗玛峰", "recManPrintAddr":"西藏日喀则市定日县珠穆朗玛峰", "weight":"1", "serviceType":"标准快递"}返回结果示例
{ "data":{ "firstPrice":"8.0", "defPrice":"8.0", "defFirstPrice":"8.0", "price":"8.0", "serviceType":"标准快递", "overPrice":"0", "defOverPrice":"0", "kuaidiCom":"zhongtong" }, "message":"成功", "result":true, "returnCode":"200"}说明:
下单后可携带pollToken请求该接口实时查询物流轨迹信息。
注意:请控制每一单查询频率至少在半小时以上,否则会造成锁单。
post
请求参数(header)
请求参数(body)
注:如需物流状态高级状态名称及状态值需要resultv2传“4”返回
JSON格式
当我方调用贵方的回调接口(pollCallBackUrl)时,贵方需要先将我方提交的数据保存至贵方的数据库,接着向我方返回是否成功接收的响应报文及代码,即贵公司直接在回调接口的地址的response中填写如下内容:
{"result":true,"returnCode":"200","message":"成功"}注意:对于status=abort(message中包含“3天查询无记录”或者“60天无变化”)的快递单,也需要返回成功接收的响应报文及代码。
查询通过商家寄件下单接口下单的订单详情信息
{ "data":{ "cargo":"普货", "comment":null, "courierMobile":null, "courierName":null, "createTime":"2022-04-2201:23:40", "dayType":null, "freight":null, "feeDetails":[{ "feeType":"", "feeDesc":"", "amount":"", "payStatus":"" }], "kuaidiCom":"jd", "kuaidiNum":"JDVC13641480904", "lastWeight":null, "orderId":"20274573", "payStatus":4, "payment":"SHIPPER", "pickupEndTime":null, "pickupStartTime":null, "preWeight":"1", "defPrice":null, "recAddr":"长安塘村长兴工业区12号3楼", "recCity":"东莞市", "recDistrict":"东坑镇", "recMobile":"13800138000", "recName":"李谬朵", "recProvince":"广东", "sendAddr":"蔡子池街道新大陆国际监控室", "sendCity":"衡阳市", "sendDistrict":"耒阳市", "sendMobile":"13800138000", "sendName":"李新红", "sendProvince":"湖南", "serviceType":"特惠送", "status":9, "taskId":"44B0108CF44728E6F8A121177E3212B2", "valins":null }, "message":"成功", "result":true, "returnCode":"200"}说明:
该接口支持在提交打印请求2天内的打印任务进行复打10次的操作(仅对下单时returnType=10的支持复打操作)。
打印设备复打成功返回示例
{ "code":200, "message":"success", "time":0, "success":true}