淘宝开放平台 - 文档中心

请求地址：

环境	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。

名称	类型	是否必须	示例值	描述
open_id	String	可选	AAH76-HcANsWNLb8FGF6rxuZ	淘宝用户在三方程序中的id
ali_pay_uid	String	可选	12345678	支付宝id
box_id	Number	可选	128	礼盒ID，非必填

名称	类型	示例值	描述
result	Result		返回结果
module UserReceiveStatusDTO 返回模型 └ box_id Number 128 礼盒ID └ is_bbp_user Boolean true 是否是宝贝派用户 └ is_granted Boolean true 是否已经授权可以获取其信息 └ receive_status Number 0 领取状态 └ babyprofile_auth_id Number 5 宝贝档案授权信息 └ success Boolean true 请求是否成功 error_infos ErrorInfo [] 错误信息 └ error_code String 000 错误码 └ sub_error_code String 000 子错误码 └ error_message String 000 错误信息

JAVA
.NET
PHP
CURL
Python
C/C++
NodeJS

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
TmallBbpVendingboxUserstatusQueryRequest req = new TmallBbpVendingboxUserstatusQueryRequest();
req.setOpenId("AAH76-HcANsWNLb8FGF6rxuZ");
req.setAliPayUid("*1234**5678*");
req.setBoxId(128L);
TmallBbpVendingboxUserstatusQueryResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
TmallBbpVendingboxUserstatusQueryRequest req = new TmallBbpVendingboxUserstatusQueryRequest();
req.OpenId = "AAH76-HcANsWNLb8FGF6rxuZ";
req.AliPayUid = "*1234**5678*";
req.BoxId = 128L;
TmallBbpVendingboxUserstatusQueryResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new TmallBbpVendingboxUserstatusQueryRequest;
$req->setOpenId("AAH76-HcANsWNLb8FGF6rxuZ");
$req->setAliPayUid("*1234**5678*");
$req->setBoxId("128");
$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=tmall.bbp.vendingbox.userstatus.query' \
-d 'partner_id=apidoc' \
-d 'sign=0F242BDA904837D3142DA1A7B6DE2C58' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-29+06%3A56%3A58' \
-d 'v=2.0' \
-d 'ali_pay_uid=*1234**5678*' \
-d 'box_id=128' \
-d 'open_id=AAH76-HcANsWNLb8FGF6rxuZ'

# -*- coding: utf-8 -*-
import top.api

req=top.api.TmallBbpVendingboxUserstatusQueryRequest(url,port)
req.set_app_info(top.appinfo(appkey,secret))

req.open_id="AAH76-HcANsWNLb8FGF6rxuZ"
req.ali_pay_uid="*1234**5678*"
req.box_id=128
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,"tmall.bbp.vendingbox.userstatus.query");
add_param(pRequest,"open_id","AAH76-HcANsWNLb8FGF6rxuZ");
add_param(pRequest,"ali_pay_uid","*1234**5678*");
add_param(pRequest,"box_id","128");
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('tmall.bbp.vendingbox.userstatus.query', {
	'open_id':'AAH76-HcANsWNLb8FGF6rxuZ',
	'ali_pay_uid':'*1234**5678*',
	'box_id':'128'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<tmall_bbp_vendingbox_userstatus_query_response>
    <result>
        <module>
            <box_id>128</box_id>
            <is_bbp_user>true</is_bbp_user>
            <is_granted>true</is_granted>
            <receive_status>0</receive_status>
            <babyprofile_auth_id>5</babyprofile_auth_id>
        </module>
        <success>true</success>
        <error_infos>
            <error_info>
                <error_code>000</error_code>
                <sub_error_code>000</sub_error_code>
                <error_message>000</error_message>
            </error_info>
        </error_infos>
    </result>
</tmall_bbp_vendingbox_userstatus_query_response>

{
    "tmall_bbp_vendingbox_userstatus_query_response":{
        "result":{
            "module":{
                "box_id":128,
                "is_bbp_user":true,
                "is_granted":true,
                "receive_status":0,
                "babyprofile_auth_id":5
            },
            "success":true,
            "error_infos":{
                "error_info":[
                    {
                        "error_code":"000",
                        "sub_error_code":"000",
                        "error_message":"000"
                    }
                ]
            }
        }
    }
}

XML示例
JSON示例

<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"
	}
}

错误码	错误描述	解决方案

API测试工具错误码查询工具 SDK下载

开放平台

商品API

tmall.bbp.vendingbox.userstatus.query (天猫宝贝派礼盒用户领取状态获取)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ