V兔API开放平台

参数	类型	必选	描述
key	string	是	授权码，请申请企业版获取
company	string	是	订阅的快递公司的编码，一律用小写字母
number	string	是	订阅的快递单号，单号的最大长度是 40 个字符
from	string	是	快递寄件地址
to	string	是	快递收件地址
parameters	Object	是	辅助参数
--callbackurl	string	是	回调接口的地址
--salt	string	否	签名用随机字符串
--phone	string	否	收寄件人的移动电话号码（只能填写一个，顺丰速运和丰网速运必填，其他快递公司选填）
--ordertime	string	否	订单下单时间，格式“yyyy-MM-dd HH:mm:ss”

请求示例

{
  "company": "ems",
  "number": "1136281381675",
  "from": "广东省深圳市南山区",
  "to": "北京市朝阳区",
  "key": "XXX ",
  "parameters": {
    "callbackurl": "您的回调接口的地址，如http://www.您的域名.com/kuaidi?callbackid=...",
    "salt": "*",
    "phone": "",
    "ordertime": "2020-12-31 08:09:00"
  }
}

请求代码示例

cURL请求代码示例

PHP请求代码示例

JAVA请求代码示例

响应参数

名称	类型	描述
code	int	返回状态码
msg	string	返回码描述
msec	int	接口执行时间
time	int	接口返回时间
data	object	数据信息
--result	bool	true:成功 false:失败
--withholding_money	int	该接口扣费金额（点券）

返回数据

{
  "code": 0,
  "mag": "",
  "msec": "",
  "time": 1656564848,
  "data": {
    "result": true
}
}

二、推送接口

接口介绍： 地图轨迹推送服务

推送参数

参数	类型	示例值	描述
status	String	polling	监控状态：polling:监控中，shutdown:结束，abort:中止，updateall：重新推送。其中当快递单为已签收时 status=shutdown，当 message 为“3 天查询无记录”或“60 天无变化时”status= abort ，对于 status=abort 的状态，需要增加额外的处理逻辑
billstatus	String	got	包括 got、sending、check 三个状态，由于意义不大，已弃用，请忽略
message	String		监控状态相关消息，如：3 天查询无记录，60 天无变化
autoCheck	String	1	快递公司编码是否出错，0 为本推送信息对应的是贵司提交的原始快递公司编码，1 为本推送信息对应的是我方纠正后的新的快递公司编码。一个单如果我们连续 3 天都查不到结果，我方会（1）判断一次贵司提交的快递公司编码是否正确，如果正确，给贵司的回调接口（callbackurl）推送带有如下字段的信息：autoCheck=0、comOld 与 comNew 都为空；（2）如果贵司提交的快递公司编码出错，我们会帮忙用正确的快递公司编码 + 原来的运单号重新提交订阅并开启监控（后续如果监控到单号有更新就给贵司的回调接口（callbackurl）推送带有如下字段的信息：autoCheck=1、comOld= 原来的公司编码、comNew= 新的公司编码）；并且给贵方的回调接口（callbackurl）推送一条含有如下字段的信息：status=abort、autoCheck=0、comOld 为空、comNew= 纠正后的快递公司编码。
comOld	String	yuantong	贵司提交的原始的快递公司编码。详细见 autoCheck 后说明。若开启了国际版（即在订阅请求中增加字段 interCom=1），则回调请求中暂无此字段
comNew	String	ems	我司纠正后的新的快递公司编码。详细见 autoCheck 后说明。若开启了国际版（即在订阅请求中增加字段 interCom=1），则回调请求中暂无此字段
lastResult	Object		最新查询轨迹结果

响应代码

代码	代码描述	解决方案
0	成功
100	请求参数错误	检查您的请求参数是否正确
101	请求超时，请重试	检查您的网络情况或者联系客服解决
103	旺旺账号不存在	检查您输入的旺旺号是否正确
200	系统错误，请联系客服	检查您的接口地址填写是否正确，其他问题联系客服解决
203	暂不支持当前接口
204	请求异常：无该接口权限，请前往官网开通正式接口。	前往官网开通该接口权限
204	请求异常：API 调用次数不足，请前往网站兑换次数。	前往官网充值该接口调用次数
302	未授权店铺	根据返回链接进行扫码授权

地图轨迹推送服务

一，订阅接口

请求头参数

请使用新的生成 token 接口 点击查看详情

请求参数

请求示例

请求代码示例

响应参数

返回数据

二、推送接口

推送参数

响应代码

请使用新的生成 token 接口点击查看详情