淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
request_param	GroupingActivitySquareQueryRequest	必须			入参
└ instance_id String 可选 123 活动实例id └ channel_shop_id String 可选 12 渠道店id └ from_share_url Boolean 可选 true 是否是通过分享方式进入"拼团广场"。注：从"主会场"点击进入时，fromShareUrl为false；从分享链接/盒口令进入时，fromShareUrl为true └ terminal String 可选 jlgo_wx_applet terminal └ out_user_id String 可选 1233 三方用户id └ third_union_id String 可选 1122 用户union_id share_info ShareInfo 可选 shareInfo 分享回流相关信息 └ share_id_type String 可选 shareIdType 分享id类型，HEMA_SECRET_USERID、JLGO_USERID └ share_id String 可选 shareId 分享id

名称	类型	示例值	描述
result	Result	result	result
└ code String SUCCESS code data GroupingActivitySquareResponse data data my_starting_activitys GroupingActivityResponse [] myStartingActivitys 我进行中的团列表 grouping_activity GroupingActivityDTO groupingActivity 拼团活动 └ activity_end_time Date 2021-10-11 00:00:00 活动结束时间 └ activity_id Number 11111 活动id └ act_type Number 1 1:小团 2:大团 └ activity_start_time Date 2021-10-11 00:00:00 活动开始时间 └ act_status Number 0 活动状态，0-未开始，1-进行中，2-已结束 └ capacity Number 10 几人团，成团人数 product ProductDTO product 团商品信息 └ item_id Number 123244 com.wdk.vertical.open.client.dto.nbpt.ProductDTO └ sale_unit String 元销售单位 └ title String 吃的商品标题 └ inventory Number 100 库存 └ normal_price Number 50 日常价 └ sale_unit_str String /盒销售单位端上表达，如/盒、/g └ normal_price_str String ￥5.1 日常价端上表达 └ activity_price Number 50 拼团价 └ activity_price_str String ￥5.1 拼团价端上表达 └ pic_url String http://ssd 商品图片 └ buy_promotion_limit_str String 限购2件限购数量端上表达，如限购2件 └ sku_code String 123 skucode grouping_activity_instance GroupingActivityInstanceDTO groupingActivityInstance 拼团实例 └ hm_main_order_id String 12233 相关盒马单号（若未参与团，则此处为空） └ instance_id String 112233L 实例id └ player_avatars String [] ["http://q", "http://q"] 头像url └ rest_progress Number 3 还差几人成团，若已成团，该值为0 └ has_activity Boolean true 当前自提点是否有本商品的拼团活动 └ current_progress Number 2 当前拼团进度 └ pt_title String 18人已参团，120人可成团拼团文案 └ instance_status Number 1 活动实例状态，0-未开始，1-进行中，2-已成团，3-成团失败 └ join_status Boolean false 当前用户是否已参团，false-未参团，true-已参团 shared_activity GroupingActivityResponse sharedActivity 别人分享的团 grouping_activity GroupingActivityDTO groupingActivity 拼团活动 └ activity_end_time Date 2021-10-11 00:00:00 活动结束时间 └ activity_id Number 11111 活动id └ act_type Number 1 1:小团 2:大团 └ activity_start_time Date 2021-10-11 00:00:00 活动开始时间 └ act_status Number 0 活动状态，0-未开始，1-进行中，2-已结束 └ capacity Number 10 几人团，成团人数 product ProductDTO product 团商品信息 └ item_id Number 123244 商品id └ title String 吃的商品标题 └ inventory Number 100 库存 └ normal_price Number 50 商品日常价 └ sale_unit_str String /盒销售单位端上表达，如/盒、/g └ normal_price_str String ￥5.1 日常价端上表达 └ activity_price Number 50 活动价 └ activity_price_str String ￥5.1 活动价端上表达 └ pic_url String http://ssd 商品图片 └ buy_promotion_limit_str String 限购2件限购表达 └ sku_code String 123 skucode └ buy_promotion_limit Number 2 限购数量 grouping_activity_instance GroupingActivityInstanceDTO groupingActivityInstance 拼团实例 └ hm_main_order_id String 12233 相关盒马单号（若未参与团，则此处为空） └ instance_id String 112233L 活动实例Id └ player_avatars String [] ["http://q", "http://q"] 头像 └ rest_progress Number 3 还差几人成团，若已成团，该值为0 └ has_activity Boolean true 当前自提点是否有本商品的拼团活动 └ current_progress Number 2 当前拼团进度 └ pt_title String 18人已参团，120人可成团拼团文案 └ instance_status Number 1 活动实例状态，0-未开始，1-进行中，2-已成团，3-成团失败 └ join_status Boolean false 当前用户是否已参团，false-未参团，true-已参团 more_starting_activitys GroupingActivityResponse [] moreStartingActivitys 更多进行中的团列表 grouping_activity GroupingActivityDTO groupingActivity 拼团活动 └ activity_end_time Date 2021-10-11 00:00:00 活动结束时间 └ activity_id Number 11111 活动id └ act_type Number 1 活动状态，0-未开始，1-进行中，2-已结束 └ activity_start_time Date 2021-10-11 00:00:00 活动开始时间 └ act_status Number 0 活动状态，0-未开始，1-进行中，2-已结束 └ capacity Number 10 几人团，成团人数 product ProductDTO product 拼团商品 └ item_id Number 123244 itemid └ title String 吃的商品标题 └ inventory Number 100 库存 └ normal_price Number 50 商品日常价 └ sale_unit_str String /盒销售单位端上表达，如/盒、/g └ normal_price_str String ￥5.1 商品日常价端上表达，如￥5.1 └ activity_price Number 50 商品成团价 └ activity_price_str String ￥5.1 商品成团价端上表达，如￥5.1 └ pic_url String http://ssd 商品图片 └ buy_promotion_limit_str String 限购2件限购数量端上表达，如限购2件 └ sku_code String 124 skuCode └ buy_promotion_limit Number 132 限购数量 grouping_activity_instance GroupingActivityInstanceDTO groupingActivityInstance 拼团实例 └ hm_main_order_id String 12233 com.wdk.vertical.open.client.dto.nbpt.GroupingActivityInstanceDTO └ instance_id String 112233L 活动实例 Id └ player_avatars String [] ["http://q", "http://q"] 参与者头像列表 └ rest_progress Number 3 还差几人成团，若已成团，该值为0 └ has_activity Boolean true 当前自提点是否有本商品的拼团活动 └ current_progress Number 2 当前拼团进度 └ pt_title String 18人已参团，120人可成团拼团文案 └ instance_status Number 1 活动实例状态，0-未开始，1-进行中，2-已成团，3-成团失败 └ join_status Boolean false 当前用户是否已参团，false-未参团，true-已参团 └ success Boolean true success └ message String 成功 message

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaWdkVerticalNbPtActivitySquareQueryRequest req = new AlibabaWdkVerticalNbPtActivitySquareQueryRequest();
AlibabaWdkVerticalNbPtActivitySquareQueryRequest.GroupingActivitySquareQueryRequest obj1 = new AlibabaWdkVerticalNbPtActivitySquareQueryRequest.GroupingActivitySquareQueryRequest();
obj1.setInstanceId("123");
obj1.setChannelShopId("12");
obj1.setFromShareUrl(true);
obj1.setTerminal("jlgo_wx_applet");
obj1.setOutUserId("1233");
obj1.setThirdUnionId("1122");
AlibabaWdkVerticalNbPtActivitySquareQueryRequest.ShareInfo obj2 = new AlibabaWdkVerticalNbPtActivitySquareQueryRequest.ShareInfo();
obj2.setShareIdType("shareIdType");
obj2.setShareId("shareId");
obj1.setShareInfo(obj2);
req.setRequestParam(obj1);
AlibabaWdkVerticalNbPtActivitySquareQueryResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaWdkVerticalNbPtActivitySquareQueryRequest req = new AlibabaWdkVerticalNbPtActivitySquareQueryRequest();
AlibabaWdkVerticalNbPtActivitySquareQueryRequest.GroupingActivitySquareQueryRequestDomain obj1 = new AlibabaWdkVerticalNbPtActivitySquareQueryRequest.GroupingActivitySquareQueryRequestDomain();
obj1.InstanceId = "123";
obj1.ChannelShopId = "12";
obj1.FromShareUrl = true;
obj1.Terminal = "jlgo_wx_applet";
obj1.OutUserId = "1233";
obj1.ThirdUnionId = "1122";
AlibabaWdkVerticalNbPtActivitySquareQueryRequest.ShareInfoDomain obj2 = new AlibabaWdkVerticalNbPtActivitySquareQueryRequest.ShareInfoDomain();
obj2.ShareIdType = "shareIdType";
obj2.ShareId = "shareId";
obj1.ShareInfo= obj2;
req.RequestParam_ = obj1;
AlibabaWdkVerticalNbPtActivitySquareQueryResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaWdkVerticalNbPtActivitySquareQueryRequest;
$request_param = new GroupingActivitySquareQueryRequest;
$request_param->instance_id="123";
$request_param->channel_shop_id="12";
$request_param->from_share_url="true";
$request_param->terminal="jlgo_wx_applet";
$request_param->out_user_id="1233";
$request_param->third_union_id="1122";
$share_info = new ShareInfo;
$share_info->share_id_type="shareIdType";
$share_info->share_id="shareId";
$request_param->share_info = $share_info;
$req->setRequestParam(json_encode($request_param));
$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=alibaba.wdk.vertical.nb.pt.activity.square.query' \
-d 'partner_id=apidoc' \
-d 'sign=E60C6A721AD685B0FED839D0AE4242AF' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-12-15+05%3A09%3A24' \
-d 'v=2.0' \
-d 'request_param=request'

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

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

req.request_param="request"
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,"alibaba.wdk.vertical.nb.pt.activity.square.query");
add_param(pRequest,"request_param","数据结构JSON示例");
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('alibaba.wdk.vertical.nb.pt.activity.square.query', {
	'request_param':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_wdk_vertical_nb_pt_activity_square_query_response>
    <result>
        <code>SUCCESS</code>
        <data>
            <my_starting_activitys>
                <grouping_activity_response>
                    <grouping_activity>
                        <activity_end_time>2021-10-11 00:00:00</activity_end_time>
                        <activity_id>11111</activity_id>
                        <act_type>1</act_type>
                        <activity_start_time>2021-10-11 00:00:00</activity_start_time>
                        <act_status>0</act_status>
                        <capacity>10</capacity>
                    </grouping_activity>
                    <product>
                        <item_id>123244</item_id>
                        <sale_unit>元</sale_unit>
                        <title>吃的</title>
                        <inventory>100</inventory>
                        <normal_price>50</normal_price>
                        <sale_unit_str>/盒</sale_unit_str>
                        <normal_price_str>￥5.1</normal_price_str>
                        <activity_price>50</activity_price>
                        <activity_price_str>￥5.1</activity_price_str>
                        <pic_url>http://ssd</pic_url>
                        <buy_promotion_limit_str>限购2件</buy_promotion_limit_str>
                        <sku_code>123</sku_code>
                    </product>
                    <grouping_activity_instance>
                        <hm_main_order_id>12233</hm_main_order_id>
                        <instance_id>112233L</instance_id>
                        <player_avatars>
                            <string>[&quot;http://q&quot;</string>
                            <string>&quot;http://q&quot;]</string>
                        </player_avatars>
                        <rest_progress>3</rest_progress>
                        <has_activity>true</has_activity>
                        <current_progress>2</current_progress>
                        <pt_title>18人已参团，120人可成团</pt_title>
                        <instance_status>1</instance_status>
                        <join_status>false</join_status>
                    </grouping_activity_instance>
                </grouping_activity_response>
            </my_starting_activitys>
            <shared_activity>
                <grouping_activity>
                    <activity_end_time>2021-10-11 00:00:00</activity_end_time>
                    <activity_id>11111</activity_id>
                    <act_type>1</act_type>
                    <activity_start_time>2021-10-11 00:00:00</activity_start_time>
                    <act_status>0</act_status>
                    <capacity>10</capacity>
                </grouping_activity>
                <product>
                    <item_id>123244</item_id>
                    <title>吃的</title>
                    <inventory>100</inventory>
                    <normal_price>50</normal_price>
                    <sale_unit_str>/盒</sale_unit_str>
                    <normal_price_str>￥5.1</normal_price_str>
                    <activity_price>50</activity_price>
                    <activity_price_str>￥5.1</activity_price_str>
                    <pic_url>http://ssd</pic_url>
                    <buy_promotion_limit_str>限购2件</buy_promotion_limit_str>
                    <sku_code>123</sku_code>
                    <buy_promotion_limit>2</buy_promotion_limit>
                </product>
                <grouping_activity_instance>
                    <hm_main_order_id>12233</hm_main_order_id>
                    <instance_id>112233L</instance_id>
                    <player_avatars>
                        <string>[&quot;http://q&quot;</string>
                        <string>&quot;http://q&quot;]</string>
                    </player_avatars>
                    <rest_progress>3</rest_progress>
                    <has_activity>true</has_activity>
                    <current_progress>2</current_progress>
                    <pt_title>18人已参团，120人可成团</pt_title>
                    <instance_status>1</instance_status>
                    <join_status>false</join_status>
                </grouping_activity_instance>
            </shared_activity>
            <more_starting_activitys>
                <grouping_activity_response>
                    <grouping_activity>
                        <activity_end_time>2021-10-11 00:00:00</activity_end_time>
                        <activity_id>11111</activity_id>
                        <act_type>1</act_type>
                        <activity_start_time>2021-10-11 00:00:00</activity_start_time>
                        <act_status>0</act_status>
                        <capacity>10</capacity>
                    </grouping_activity>
                    <product>
                        <item_id>123244</item_id>
                        <title>吃的</title>
                        <inventory>100</inventory>
                        <normal_price>50</normal_price>
                        <sale_unit_str>/盒</sale_unit_str>
                        <normal_price_str>￥5.1</normal_price_str>
                        <activity_price>50</activity_price>
                        <activity_price_str>￥5.1</activity_price_str>
                        <pic_url>http://ssd</pic_url>
                        <buy_promotion_limit_str>限购2件</buy_promotion_limit_str>
                        <sku_code>124</sku_code>
                        <buy_promotion_limit>132</buy_promotion_limit>
                    </product>
                    <grouping_activity_instance>
                        <hm_main_order_id>12233</hm_main_order_id>
                        <instance_id>112233L</instance_id>
                        <player_avatars>
                            <string>[&quot;http://q&quot;</string>
                            <string>&quot;http://q&quot;]</string>
                        </player_avatars>
                        <rest_progress>3</rest_progress>
                        <has_activity>true</has_activity>
                        <current_progress>2</current_progress>
                        <pt_title>18人已参团，120人可成团</pt_title>
                        <instance_status>1</instance_status>
                        <join_status>false</join_status>
                    </grouping_activity_instance>
                </grouping_activity_response>
            </more_starting_activitys>
        </data>
        <success>true</success>
        <message>成功</message>
    </result>
</alibaba_wdk_vertical_nb_pt_activity_square_query_response>

{
    "alibaba_wdk_vertical_nb_pt_activity_square_query_response":{
        "result":{
            "code":"SUCCESS",
            "data":{
                "my_starting_activitys":{
                    "grouping_activity_response":[
                        {
                            "grouping_activity":{
                                "activity_end_time":"2021-10-11 00:00:00",
                                "activity_id":11111,
                                "act_type":1,
                                "activity_start_time":"2021-10-11 00:00:00",
                                "act_status":0,
                                "capacity":10
                            },
                            "product":{
                                "item_id":123244,
                                "sale_unit":"元",
                                "title":"吃的",
                                "inventory":100,
                                "normal_price":50,
                                "sale_unit_str":"\/盒",
                                "normal_price_str":"￥5.1",
                                "activity_price":50,
                                "activity_price_str":"￥5.1",
                                "pic_url":"http:\/\/ssd",
                                "buy_promotion_limit_str":"限购2件",
                                "sku_code":"123"
                            },
                            "grouping_activity_instance":{
                                "hm_main_order_id":"12233",
                                "instance_id":"112233L",
                                "player_avatars":{
                                    "string":[
                                        "[\"http:\/\/q\"",
                                        " \"http:\/\/q\"]"
                                    ]
                                },
                                "rest_progress":3,
                                "has_activity":true,
                                "current_progress":2,
                                "pt_title":"18人已参团，120人可成团",
                                "instance_status":1,
                                "join_status":false
                            }
                        }
                    ]
                },
                "shared_activity":{
                    "grouping_activity":{
                        "activity_end_time":"2021-10-11 00:00:00",
                        "activity_id":11111,
                        "act_type":1,
                        "activity_start_time":"2021-10-11 00:00:00",
                        "act_status":0,
                        "capacity":10
                    },
                    "product":{
                        "item_id":123244,
                        "title":"吃的",
                        "inventory":100,
                        "normal_price":50,
                        "sale_unit_str":"\/盒",
                        "normal_price_str":"￥5.1",
                        "activity_price":50,
                        "activity_price_str":"￥5.1",
                        "pic_url":"http:\/\/ssd",
                        "buy_promotion_limit_str":"限购2件",
                        "sku_code":"123",
                        "buy_promotion_limit":2
                    },
                    "grouping_activity_instance":{
                        "hm_main_order_id":"12233",
                        "instance_id":"112233L",
                        "player_avatars":{
                            "string":[
                                "[\"http:\/\/q\"",
                                " \"http:\/\/q\"]"
                            ]
                        },
                        "rest_progress":3,
                        "has_activity":true,
                        "current_progress":2,
                        "pt_title":"18人已参团，120人可成团",
                        "instance_status":1,
                        "join_status":false
                    }
                },
                "more_starting_activitys":{
                    "grouping_activity_response":[
                        {
                            "grouping_activity":{
                                "activity_end_time":"2021-10-11 00:00:00",
                                "activity_id":11111,
                                "act_type":1,
                                "activity_start_time":"2021-10-11 00:00:00",
                                "act_status":0,
                                "capacity":10
                            },
                            "product":{
                                "item_id":123244,
                                "title":"吃的",
                                "inventory":100,
                                "normal_price":50,
                                "sale_unit_str":"\/盒",
                                "normal_price_str":"￥5.1",
                                "activity_price":50,
                                "activity_price_str":"￥5.1",
                                "pic_url":"http:\/\/ssd",
                                "buy_promotion_limit_str":"限购2件",
                                "sku_code":"124",
                                "buy_promotion_limit":132
                            },
                            "grouping_activity_instance":{
                                "hm_main_order_id":"12233",
                                "instance_id":"112233L",
                                "player_avatars":{
                                    "string":[
                                        "[\"http:\/\/q\"",
                                        " \"http:\/\/q\"]"
                                    ]
                                },
                                "rest_progress":3,
                                "has_activity":true,
                                "current_progress":2,
                                "pt_title":"18人已参团，120人可成团",
                                "instance_status":1,
                                "join_status":false
                            }
                        }
                    ]
                }
            },
            "success":true,
            "message":"成功"
        }
    }
}

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下载

开放平台

盒马接力go对接API

alibaba.wdk.vertical.nb.pt.activity.square.query (NB查询拼团广场信息)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ