菜鸟裹裹API
cainiao.nborderfront.user.outside.queryoutsideuser
查询外部小件员休息
cainiao.nborderfront.gui.user.query
自提柜用户查询
cainiao.yima.locker.lockergroup.detail
查区域自提柜详情
cainiao.endpoint.locker.misc.phone.query
自提柜电话查询
cainiao.endpoint.locker.spi.order.state.sync
同步订单状态
cainiao.endpoint.locker.misc.order.tracking
自提柜订单跟踪消息
cainiao.endpoint.locker.spi.order.extend
订单延时
cainiao.guoguo.delivery.verify
查询小件员认证需求信息
cainiao.endpoint.locker.top.gui.setstatus
设置柜子状态
cainiao.endpoint.locker.top.gui.addorupdate
自提柜新增或修改接口
cainiao.endpoint.locker.top.order.tracking
事件回传接口
cainiao.endpoint.locker.top.order.query.user
查询订单用户信息
cainiao.endpoint.locker.top.order.query.package
查询订单的包裹信息
cainiao.endpoint.locker.spi.order.query_1.0
自提柜订单查询
cainiao.endpoint.locker.spi.gui.open
自提柜开柜操作
cainiao.endpoint.locker.spi.order.authcode.resend
自提柜重发取件码短信
cainiao.endpoint.locker.top.tryout.query.qrcodeinfo
查询派样活动的二维码信息
cainiao.guoguo.graborder.queryorderpricerule
查询订单计费规则
cainiao.endpoint.locker.spi.order.status.notice
自提柜订单状态同步接口
cainiao.endpoint.locker.top.sync.callback
自提柜异步回调接口
cainiao.guoguo.graborder.validategotcodebycourier
验证取件码
cainiao.guoguo.graborder.takepackagebycourier
小件员上门取件
cainiao.nbadd.appointdeliver.feedbackcodes
服务质量反馈编码列表
cainiao.endpoint.locker.spi.order.query_2.0
查询柜子订单详情
cainiao.endpoint.locker.spi.cell.query
查询柜口信息
cainiao.endpoint.locker.top.order.withhold
代扣支付
cainiao.endpoint.locker.top.withhold.query
查询能否代扣
cainiao.guoguo.delivery.userindex
获取小件员主页内容
cainiao.endpoint.locker.top.station.addorupdate
增加更新代收点
cainiao.endpoint.locker.top.order.tracking.new
事件回传接口
cainiao.endpoint.locker.top.order.noticesend.query
查询订单是否由裹裹发送消息
cainiao.endpoint.locker.top.order.notice
手动触发发短信
cainiao.guoguo.courier.manager.query
查询快递掌柜账号信息接口
cainiao.guoguo.courier.waybill.getwaybill
获取电子面点打印信息接口
cainiao.guoguo.courier.manager.bindwithauthority
绑定实名快递掌柜账号
cainiao.guoguo.courier.waybill.commonprint
蓝牙打印通用接口
cainiao.yima.business.data
通用数据接口:离职状态、透传数据等
cainiao.moduan.order.checkimage.query
查询验视图片
cainiao.moduan.order.checkimage.distance
验视照片上传距离
cainiao.moduan.order.uploadimage
开箱验视上传图片
cainiao.guoguo.courier.graborder.realnameauthenticate
寄件实名认证
cainiao.guoguo.courier.graborder.getrealnameinfobyidentitycode
扫码获取实名信息
cainiao.endpoint.locker.top.post.query
自提柜投递列表
cainiao.endpoint.locker.top.authcode.resend
重发取件码
cainiao.endpoint.locker.top.post.search
搜索自提柜投件列表
cainiao.endpoint.locker.top.post.query.nottake.package
查询未取件的包裹信息
cainiao.endpoint.locker.top.post.query.overtime.package
查询滞留件的包裹信息
cainiao.endpoint.locker.top.post.query.nottake.gui
查询未取件的柜子信息
cainiao.endpoint.locker.top.post.query.alreadytake.package
查询已取件的包裹信息
cainiao.endpoint.locker.top.authcode.resendanycp
包裹侠自提柜 重发取件码
cainiao.moduan.relation.querypartner
查询可转单同事
cainiao.moduan.fwd.creategroup
创建服务队
cainiao.moduan.fwd.querybyuserid
服务队查询
cainiao.moduan.fwd.querycandidatebymobile
手机查询候选队员
cainiao.moduan.fwd.invitemember
邀请队员
cainiao.moduan.fwd.responseinvite
回应服务队邀请
cainiao.moduan.fwd.delmember
删除队员
cainiao.endpoint.cabinet.top.exception.packages.count
异常包裹总数查询
cainiao.endpoint.cabinet.top.exception.packages.page
快递员维度,分页查询异常包裹列表
cainiao.endpoint.locker.top.modify.guestphone
修改手机号
cainiao.endpoint.locker.top.modify.guestphone.count
查询修改手机号次数
cainiao.moduan.fwd.deletegroup
解散服务队
cainiao.guoguo.courier.graborder.orderrealname
快递员端实人认证
cainiao.guoguo.courier.graborder.querygoodtypes
查询物品类型列表
cainiao.guoguo.delivery.alipay.sign.withhold
包裹侠
cainiao.endpoint.cabinet.top.pullnew.used.aoi
常用小区aoi柜子列表
cainiao.pickup.business.register.firstuse
初次申请使用菜鸟裹裹的服务
cainiao.pickup.paymentorder.get
商家寄件账单查询
cainiao.pickup.tieredpricing.get
商家寄件商家的报价单
cainiao.pickup.tieredpricing.tobeuse.get
商家寄件商家即将启用的报价单
cainiao.pickup.business.platform.preorderview.get
菜鸟商家寄件下单前获取预览信息(代理模式)
cainiao.pickup.business.platform.callguoguo
菜鸟商家寄件代理下寄件单并呼叫裹裹运力
cainiao.pickup.business.adv.multi.get
菜鸟商家寄件获取营销文案信息(支持PC,移动多端的信息获取)
cainiao.pickup.business.noticeinfo.multi.get
菜鸟裹裹通知获取(支持PC,移动等多端)
cainiao.pickup.business.agentpay.trigger
触发代扣通知
cainiao.pickup.person.relation.confirm
自提柜异常件用户身份核验
cainiao.pickup.business.market.common.activity.join
根据活动领券
cainiao.guoguo.waybill.get
菜鸟裹裹商家寄件取号接口
taobao.refund.send.bill.unsettle.query
查询退货包裹订单未结算的原因
cainiao.pickup.business.noticeinfo.multi.get (菜鸟裹裹通知获取(支持PC,移动等多端))
¥开放平台免费API
需要授权
菜鸟裹裹通知获取(支持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。
请求参数
名称
类型
是否必须
示例值
更多限制
描述
响应参数
名称
类型
示例值
描述
result
TdOpenServiceResult
{}
返回结果
data
MarketingSenseEntryInfoAll
{}
返回对象
pc
MarketingSenseEntryInfo
{}
PC端通知展示
└ resource
String
https://pic1.zhimg.com/v2-4927a421ff56548962e93b4a1e1e7413_b.jpg
通知文案的资源展示(一般是图片链接)
└ resource_url
String
http://xxx
点击通知文案资源时的跳转链接,为空表示不附带链接
└ benfit
String
限时特惠
利益点展示
└ benfit_url
String
http://xxx
利益点相关链接,为空表示不附带链接
└ copy
String
上门揽收,当日取件
通知文案
└ copy_url
String
https://www.google.com/search?q=mtop.cainiao.billing.price.query&oq=mtop.cainiao.billing.price.query&aqs=chrome..69i57j69i60.3542j0j4&sourceid=chrome&ie=UTF-8
通知文案附带链接,为空表示不附带链接
└ title
String
3月特惠寄
该通知文案的标题
└ extent_info
String
扩展信息示例
预留为扩展信息
mobile
MarketingSenseEntryInfo
{}
移动端通知展示
└ resource
String
https://pic1.zhimg.com/v2-4927a421ff56548962e93b4a1e1e7413_b.jpg
通知文案的资源展示(一般是图片链接)
└ resource_url
String
http://xxx
点击通知文案资源时的跳转链接,为空表示不附带链接
└ benefit
String
限时特惠
利益点展示
└ benefit_url
String
http://xxx
利益点相关链接,为空表示不附带链接
└ copy
String
上门揽收,当日取件
通知文案
└ copy_url
String
https://www.google.com/search?q=mtop.cainiao.billing.price.query&oq=mtop.cainiao.billing.price.query&aqs=chrome..69i57j69i60.3542j0j4&sourceid=chrome&ie=UTF-8
通知文案附带链接,为空表示不附带链接
└ title
String
3月特惠寄
该通知文案的标题
└ extent_info
String
扩展信息示例
预留为扩展信息
└ success
Boolean
true
请求是否成功
└ retry
Boolean
false
是否需要重试
└ status_code
String
系统异常
错误信息
└ status_message
String
SYSTEM_ERROR
错误码
请求示例
JAVA
.NET
PHP
CURL
Python
C/C++
NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
CainiaoPickupBusinessNoticeinfoMultiGetRequest req = new CainiaoPickupBusinessNoticeinfoMultiGetRequest();
CainiaoPickupBusinessNoticeinfoMultiGetResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());
ITopClient client = new DefaultTopClient(url, appkey, secret);
CainiaoPickupBusinessNoticeinfoMultiGetRequest req = new CainiaoPickupBusinessNoticeinfoMultiGetRequest();
CainiaoPickupBusinessNoticeinfoMultiGetResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);
$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new CainiaoPickupBusinessNoticeinfoMultiGetRequest;
$resp = $c->execute($req, $sessionKey);
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.pickup.business.noticeinfo.multi.get' \
-d 'partner_id=apidoc' \
-d 'session=01928f20-6826-436e-9259-31c05dc92ae3' \
-d 'sign=1C9A930525C02B3CB7ED8BD69ECBAC8A' \
-d 'sign_method=hmac' \
-d 'timestamp=2026-11-08+11%3A29%3A23' \
-d 'v=2.0'
# -*- coding: utf-8 -*-
import top.api
req=top.api.CainiaoPickupBusinessNoticeinfoMultiGetRequest(url,port)
req.set_app_info(top.appinfo(appkey,secret))
try:
resp= req.getResponse(sessionkey)
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.pickup.business.noticeinfo.multi.get");
pResponse = top_execute(pClient,pRequest,sessionKey);
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',
'url': 'http://gw.api.taobao.com/router/rest'
});
client.execute('cainiao.pickup.business.noticeinfo.multi.get' {
}, function(error, response) {
if (!error) console.log(response);
else console.log(error);
})
响应示例
XML示例
JSON示例
{
"cainiao_pickup_business_noticeinfo_multi_get_response":{
"result":{
"data":{
"pc":{
"resource":"https:\/\/pic1.zhimg.com\/v2-4927a421ff56548962e93b4a1e1e7413_b.jpg",
"resource_url":"http:\/\/xxx",
"benfit":"限时特惠",
"benfit_url":"http:\/\/xxx",
"copy":"上门揽收,当日取件",
"copy_url":"https:\/\/www.google.com\/search?q=mtop.cainiao.billing.price.query&oq=mtop.cainiao.billing.price.query&aqs=chrome..69i57j69i60.3542j0j4&sourceid=chrome&ie=UTF-8",
"title":"3月特惠寄",
"extent_info":"扩展信息示例"
},
"mobile":{
"resource":"https:\/\/pic1.zhimg.com\/v2-4927a421ff56548962e93b4a1e1e7413_b.jpg",
"resource_url":"http:\/\/xxx",
"benefit":"限时特惠",
"benefit_url":"http:\/\/xxx",
"copy":"上门揽收,当日取件",
"copy_url":"https:\/\/www.google.com\/search?q=mtop.cainiao.billing.price.query&oq=mtop.cainiao.billing.price.query&aqs=chrome..69i57j69i60.3542j0j4&sourceid=chrome&ie=UTF-8",
"title":"3月特惠寄",
"extent_info":"扩展信息示例"
}
},
"success":true,
"retry":false,
"status_code":"系统异常",
"status_message":"SYSTEM_ERROR"
}
}
}
异常示例
XML示例
JSON示例
50
{
"error_response":{
"msg":"Remote service error",
"code":50,
"sub_msg":"非法参数",
"sub_code":"isv.invalid-parameter"
}
}
错误码解释
错误码
错误描述
解决方案
API工具
API测试工具
错误码查询工具
SDK下载
如何获得此API
FAQ
我要提问