文档中心 > API类目 > miniapp开放API

taobao.miniapp.distribution.order.get (小程序投放-查询小程序投放计划信息)

服务商可通过该API,读取自己开发的小程序对应的投放计划的相关信息

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
order_id_request DistributionOrderQueryByIdOpenRequest 必须 查询入参
  • └ order_id_list
  • Number []
  • 必须
  • [1,2,3]
  • 投放计划的id列表

响应参数

名称 类型 示例值 描述
model DistributionOrderOpenBizDto [] model 投放计划列表的详细信息
  • └ widget_version
  • String
  • 1.0.0
  • 关联的小部件版本号
  • └ widget_id
  • Number
  • 3000000xxxx
  • 关联的小部件id
  • └ time_type
  • byte
  • 0
  • 时效类型.0: 商家自定义时效,1:订购期内有效
  • └ url
  • String
  • https://m.duanqu.com?_ariver_appid=XXXXX
  • 投放的小程序url
  • └ app_id
  • Number
  • 3000xxxxxx
  • 小程序id
  • └ status
  • byte
  • 1
  • 状态,0:未开始, 1:进行中,2/3:已结束,其他为平台状态
  • └ end_time
  • Date
  • 2021-05-24 05:53:53
  • 结束时间,订购期有效的投放计划无该返回值
  • └ start_time
  • Date
  • 2021-04-24 05:53:53
  • 开始时间,订购期有效的情况无该返回值
  • └ name
  • String
  • 测试投放计划
  • 名字
  • └ id
  • Number
  • 300001
  • 唯一标识的id

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
MiniappDistributionOrderGetRequest req = new MiniappDistributionOrderGetRequest();
MiniappDistributionOrderGetRequest.DistributionOrderQueryByIdOpenRequest obj1 = new MiniappDistributionOrderGetRequest.DistributionOrderQueryByIdOpenRequest();
obj1.setOrderIdList(new Long[] { 1,2,3 };
);
req.setOrderIdRequest(obj1);
MiniappDistributionOrderGetResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<miniapp_distribution_order_get_response>
    <model>
        <distribution_order_open_biz_dto>
            <widget_version>1.0.0</widget_version>
            <widget_id>3000000xxxx</widget_id>
            <time_type>0</time_type>
            <url>https://m.duanqu.com?_ariver_appid=XXXXX</url>
            <app_id>3000xxxxxx</app_id>
            <status>1</status>
            <end_time>2021-05-24 05:53:53</end_time>
            <start_time>2021-04-24 05:53:53</start_time>
            <name>测试投放计划</name>
            <id>300001</id>
        </distribution_order_open_biz_dto>
    </model>
</miniapp_distribution_order_get_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

返回
顶部