文档中心 > API类目 > 盒马接力go对接API

alibaba.wdk.vertical.nb.pt.activity.instance.query (拼团活动实例查询)

拼团活动实例查询

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
request_param GroupingActivityQueryRequest 可选 入参
  • └ out_user_id
  • String
  • 必须
  • 574943
  • 三方用户id
  • └ hm_main_order_id
  • String
  • 必须
  • 21000093984884141
  • 盒马主单号
  • └ third_union_id
  • String
  • 必须
  • 1122
  • 用户union_id

响应参数

名称 类型 示例值 描述
result Result result 结果
  • └ code
  • String
  • code
  • code
  • data
  • GroupingActivityResponse
  • data
  • data
  • grouping_activity
  • GroupingActivityDTO
  • activity
  • 活动新
  • └ activity_id
  • Number
  • 1
  • 活动id
  • └ activity_start_time
  • Date
  • 2021-11-11 00:00:00
  • 活动开始时间
  • └ activity_end_time
  • Date
  • 2021-11-22 00:00:00
  • 活动结束时间
  • └ capacity
  • Number
  • 10
  • 几人团,成团人数
  • └ activity_status
  • Number
  • 1
  • 0-未开始,1-进行中,2-已结束
  • grouping_activity_instance
  • GroupingActivityInstanceDTO
  • activityInstance
  • 活动实例信息
  • └ instance_id
  • String
  • 1
  • 活动实例id
  • └ instance_status
  • Number
  • 1
  • 活动实例状态,0-未开始,1-进行中,2-已成团,3-成团失败
  • └ player_avatars
  • String []
  • ["1","2"]
  • 参与者列表
  • └ current_progress
  • Number
  • 1
  • 当前拼团了几个人
  • └ rest_progress
  • Number
  • 2
  • 剩余拼团人数
  • └ current_progress_text
  • String
  • 还差2人可成团
  • 当前拼团进度文案
  • └ is_sponsor
  • Boolean
  • true
  • 是否是团长
  • └ success
  • Boolean
  • 0
  • 结果
  • └ message
  • String
  • null
  • 错误信息

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaWdkVerticalNbPtActivityInstanceQueryRequest req = new AlibabaWdkVerticalNbPtActivityInstanceQueryRequest();
AlibabaWdkVerticalNbPtActivityInstanceQueryRequest.GroupingActivityQueryRequest obj1 = new AlibabaWdkVerticalNbPtActivityInstanceQueryRequest.GroupingActivityQueryRequest();
obj1.setOutUserId("574943");
obj1.setHmMainOrderId("21000093984884141");
obj1.setThirdUnionId("1122");
req.setRequestParam(obj1);
AlibabaWdkVerticalNbPtActivityInstanceQueryResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<alibaba_wdk_vertical_nb_pt_activity_instance_query_response>
    <result>
        <code>code</code>
        <data>
            <grouping_activity>
                <activity_id>1</activity_id>
                <activity_start_time>2021-11-11 00:00:00</activity_start_time>
                <activity_end_time>2021-11-22 00:00:00</activity_end_time>
                <capacity>10</capacity>
                <activity_status>1</activity_status>
            </grouping_activity>
            <grouping_activity_instance>
                <instance_id>1</instance_id>
                <instance_status>1</instance_status>
                <player_avatars>
                    <string>[&quot;1&quot;</string>
                    <string>&quot;2&quot;]</string>
                </player_avatars>
                <current_progress>1</current_progress>
                <rest_progress>2</rest_progress>
                <current_progress_text>还差2人可成团</current_progress_text>
                <is_sponsor>true</is_sponsor>
            </grouping_activity_instance>
        </data>
        <success>0</success>
        <message>null</message>
    </result>
</alibaba_wdk_vertical_nb_pt_activity_instance_query_response>

异常示例

  • 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>

错误码解释

错误码 错误描述 解决方案

API工具

如何获得此API

FAQ

返回
顶部