注意:以下文档只适用于TOP接口,请谨慎使用!
查询外部小件员休息
自提柜用户查询
查区域自提柜详情
自提柜电话查询
同步订单状态
自提柜订单跟踪消息
订单延时
查询小件员认证需求信息
设置柜子状态
自提柜新增或修改接口
事件回传接口
查询订单用户信息
查询订单的包裹信息
自提柜订单查询
自提柜开柜操作
自提柜重发取件码短信
查询派样活动的二维码信息
查询订单计费规则
自提柜订单状态同步接口
自提柜异步回调接口
验证取件码
小件员上门取件
服务质量反馈编码列表
查询柜子订单详情
查询柜口信息
代扣支付
查询能否代扣
获取小件员主页内容
增加更新代收点
事件回传接口
查询订单是否由裹裹发送消息
手动触发发短信
查询快递掌柜账号信息接口
获取电子面点打印信息接口
绑定实名快递掌柜账号
蓝牙打印通用接口
通用数据接口:离职状态、透传数据等
查询验视图片
验视照片上传距离
开箱验视上传图片
寄件实名认证
扫码获取实名信息
自提柜投递列表
重发取件码
搜索自提柜投件列表
查询未取件的包裹信息
查询滞留件的包裹信息
查询未取件的柜子信息
查询已取件的包裹信息
包裹侠自提柜 重发取件码
查询可转单同事
创建服务队
服务队查询
手机查询候选队员
邀请队员
回应服务队邀请
删除队员
异常包裹总数查询
快递员维度,分页查询异常包裹列表
修改手机号
查询修改手机号次数
解散服务队
快递员端实人认证
查询物品类型列表
包裹侠
常用小区aoi柜子列表
初次申请使用菜鸟裹裹的服务
商家寄件账单查询
商家寄件商家的报价单
商家寄件商家即将启用的报价单
菜鸟商家寄件下单前获取预览信息(代理模式)
菜鸟商家寄件代理下寄件单并呼叫裹裹运力
菜鸟商家寄件获取营销文案信息(支持PC,移动多端的信息获取)
菜鸟裹裹通知获取(支持PC,移动等多端)
触发代扣通知
自提柜异常件用户身份核验
根据活动领券
菜鸟裹裹商家寄件取号接口
环境 | HTTP请求地址 | HTTPS请求地址 |
---|---|---|
正式环境 | http://gw.api.taobao.com/router/rest | https://eco.taobao.com/router/rest |
名称 | 类型 | 是否必须 | 描述 |
---|---|---|---|
method | String | 是 | API接口名称。 |
app_key | String | 是 | TOP分配给应用的AppKey。 |
target_app_key | String | 否 | 被调用的目标AppKey,仅当被调用的API为第三方ISV提供时有效。 |
sign_method | String | 是 | 签名的摘要算法,可选值为:hmac,md5。 |
sign | String | 是 | API输入参数签名结果,签名算法介绍请点击这里。 |
session | String | 否 | 用户登录授权成功后,TOP颁发给应用的授权信息,详细介绍请点击这里。当此API的标签上注明:“需要授权”,则此参数必传;“不需要授权”,则此参数不需要传;“可选授权”,则此参数为可选。 |
timestamp | String | 是 | 时间戳,格式为yyyy-MM-dd HH:mm:ss,时区为GMT+8,例如:2015-01-01 12:00:00。淘宝API服务端允许客户端请求最大时间误差为10分钟。 |
format | String | 否 | 响应格式。默认为xml格式,可选值:xml,json。 |
v | String | 是 | API协议版本,可选值:2.0。 |
partner_id | String | 否 | 合作伙伴身份标识。 |
simplify | Boolean | 否 | 是否采用精简JSON返回格式,仅当format=json时有效,默认值为:false。 |
名称 | 类型 | 是否必须 | 示例值 | 更多限制 | 描述 |
---|---|---|---|---|---|
gui_code | String | 必须 | 1 | 1 | |
order_code | String | 必须 | 1 | 1 | |
ts | Number | 必须 | 1 | 1 |
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
err_code | String | 1 | 1 |
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret); CainiaoEndpointLockerSpiOrderExtendRequest req = new CainiaoEndpointLockerSpiOrderExtendRequest(); req.setGuiCode("1"); req.setOrderCode("1"); req.setTs(1L); CainiaoEndpointLockerSpiOrderExtendResponse rsp = client.execute(req); System.out.println(rsp.getBody());
ITopClient client = new DefaultTopClient(url, appkey, secret); CainiaoEndpointLockerSpiOrderExtendRequest req = new CainiaoEndpointLockerSpiOrderExtendRequest(); req.GuiCode = "1"; req.OrderCode = "1"; req.Ts = 1L; CainiaoEndpointLockerSpiOrderExtendResponse rsp = client.Execute(req); Console.WriteLine(rsp.Body);
$c = new TopClient; $c->appkey = $appkey; $c->secretKey = $secret; $req = new CainiaoEndpointLockerSpiOrderExtendRequest; $req->setGuiCode("1"); $req->setOrderCode("1"); $req->setTs("1"); $resp = $c->execute($req);
curl -X POST 'http://gw.api.taobao.com/router/rest' \ -H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \ -d 'app_key=12129701' \ -d 'format=json' \ -d 'method=cainiao.endpoint.locker.spi.order.extend' \ -d 'partner_id=apidoc' \ -d 'sign=1AB05D803769B9763515718835C26C64' \ -d 'sign_method=hmac' \ -d 'timestamp=2025-05-19+17%3A47%3A39' \ -d 'v=2.0' \ -d 'gui_code=1' \ -d 'order_code=1' \ -d 'ts=1'
# -*- coding: utf-8 -*- import top.api req=top.api.CainiaoEndpointLockerSpiOrderExtendRequest(url,port) req.set_app_info(top.appinfo(appkey,secret)) req.gui_code="1" req.order_code="1" req.ts=1 try: resp= req.getResponse() print(resp) except Exception,e: print(e)
pTopRequest pRequest = alloc_top_request(); pTopResponse pResponse = NULL; pTaobaoClient pClient = alloc_taobao_client(url, appkey, appsecret); set_api_name(pRequest,"cainiao.endpoint.locker.spi.order.extend"); add_param(pRequest,"gui_code","1"); add_param(pRequest,"order_code","1"); add_param(pRequest,"ts","1"); pResponse = top_execute(pClient,pRequest,NULL); printf("ret code:%d\n",pResponse->code); if(pResponse->code == 0){ pTopResponseIterator ite = init_response_iterator(pResponse); pResultItem pResultItem = alloc_result_item(); while(parseNext(ite, pResultItem) == 0){ printf("%s:%s\n",pResultItem->key,pResultItem->value); } destroy_response_iterator(ite); destroy_result_item(pResultItem); } destroy_top_request(pRequest); destroy_top_response(pResponse); destroy_taobao_client(pClient);
TopClient = require('./topClient').TopClient; var client = new TopClient({ 'appkey': 'appkey', 'appsecret': 'secret', 'REST_URL': 'http://gw.api.taobao.com/router/rest' }); client.execute('cainiao.endpoint.locker.spi.order.extend', { 'gui_code':'1', 'order_code':'1', 'ts':'1' }, function(error, response) { if (!error) console.log(response); else console.log(error); })
<err_code>1</err_code>
{ "err_code":"1" }
<error_response> <code>50</code> <msg>Remote service error</msg> <sub_code>isv.invalid-parameter</sub_code> <sub_msg>非法参数</sub_msg> </error_response>
{ "error_response":{ "msg":"Remote service error", "code":50, "sub_msg":"非法参数", "sub_code":"isv.invalid-parameter" } }
错误码 | 错误描述 | 解决方案 |
---|