淘宝开放平台

登录
文档中心 > API类目 > 服务平台API

服务平台API

taobao.vas.order.search (订单记录导出)

用于ISV查询自己名下的应用及收费项目的订单记录（已付款订单）。 建议用于查询前一日的历史记录，不适合用作实时数据查询。 现在只能查询90天以内的数据 该接口限制每分钟所有appkey调用总和只能有800次。

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
article_code String 必须 ts-1234 应用收费代码，从合作伙伴后台（my.open.taobao.com）-收费管理-收费项目列表 能够获得该应用的收费代码
item_code String 可选 ts-1234-1 收费项目代码，从合作伙伴后台（my.open.taobao.com）-收费管理-收费项目列表 能够获得收费项目代码
start_created Date 可选 2000-01-01 00:00:00 订单创建时间（订购时间）起始值（当start_created和end_created都不填写时，默认返回最近90天的数据）
end_created Date 可选 2000-01-01 00:00:00 订单创建时间（订购时间）结束值
biz_order_id Number 可选 12345
  • 默认值：0
    		•  订单号
    order_id Number 可选 12345
  • 默认值：0
    		•  子订单号
    biz_type Number 可选 1
  • 默认值：0
    		•  订单类型，1=新订 2=续订 3=升级 4=后台赠送 5=后台自动续订 6=订单审核后生成订购关系（暂时用不到） 空=全部
    page_size Number 可选 20 一页包含的记录数
    page_no Number 可选 1 页码
    nick String 可选 hz0799 淘宝会员名

    响应参数

    名称 类型 示例值 描述
    article_biz_orders ArticleBizOrder [] 商品订单对象
    • └ nick
    • String
    • hz0799
    • 淘宝会员名
    • └ article_name
    • String
    • 网店版
    • 应用名称
    • └ article_code
    • String
    • ts-123
    • 应用收费代码，从合作伙伴后台（my.open.taobao.com）-收费管理-收费项目列表 能够获得该应用的收费代码
    • └ article_item_name
    • String
    • 小艾分析
    • 商品模型名称
    • └ item_code
    • String
    • ts-123-1
    • 收费项目代码，从合作伙伴后台（my.open.taobao.com）-收费管理-收费项目列表 能够获得收费项目代码
    • └ create
    • Date
    • 2000-01-01 00:00:00
    • 订单创建时间（订购时间）
    • └ order_cycle
    • String
    • 1
    • 订购周期 1表示年 ，2表示月，3表示天。
    • └ biz_type
    • Number
    • 1
    • 订单类型，1=新订 2=续订 3=升级 4=后台赠送 5=后台自动续订 6=订单审核后生成订购关系（暂时用不到）
    • └ order_id
    • Number
    • 7000011
    • 子订单号
    • └ fee
    • String
    • 10
    • 原价（单位为分）
    • └ prom_fee
    • String
    • 5
    • 优惠（单位为分）
    • └ total_pay_fee
    • String
    • 5
    • 实付（单位为分）
    • └ order_cycle_start
    • Date
    • 2000-01-01 00:00:00
    • 订购周期开始时间
    • └ order_cycle_end
    • Date
    • 2000-01-01 00:00:00
    • 订购周期结束时间
    • └ refund_fee
    • String
    • 0
    • 退款（单位为分；升级时，系统会将升级前老版本按照剩余订购天数退还剩余金额）
    • └ biz_order_id
    • Number
    • 12345
    • 订单号
    • └ activity_code
    • String
    • 0
    • activityCode
    • └ order_biz_status
    • String
    • 0
    • 业务订单状态
    total_item Number 100 总记录数

    请求示例

    • JAVA
    • .NET
    • PHP
    • CURL
    • Python
    • C/C++
    • NodeJS
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
    VasOrderSearchRequest req = new VasOrderSearchRequest();
    req.setArticleCode("ts-1234");
    req.setItemCode("ts-1234-1");
    req.setStartCreated(StringUtils.parseDateTime("2000-01-01 00:00:00"));
    req.setEndCreated(StringUtils.parseDateTime("2000-01-01 00:00:00"));
    req.setBizOrderId(12345L);
    req.setOrderId(12345L);
    req.setBizType(1L);
    req.setPageSize(20L);
    req.setPageNo(1L);
    req.setNick("hz0799");
    VasOrderSearchResponse rsp = client.execute(req);
    System.out.println(rsp.getBody());

    响应示例

    • XML示例
    • JSON示例
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    <vas_order_search_response>
        <article_biz_orders>
            <article_biz_order>
                <nick>hz0799</nick>
                <article_name>网店版</article_name>
                <article_code>ts-123</article_code>
                <article_item_name>小艾分析</article_item_name>
                <item_code>ts-123-1</item_code>
                <create>2000-01-01 00:00:00</create>
                <order_cycle>1</order_cycle>
                <biz_type>1</biz_type>
                <order_id>7000011</order_id>
                <fee>10</fee>
                <prom_fee>5</prom_fee>
                <total_pay_fee>5</total_pay_fee>
                <order_cycle_start>2000-01-01 00:00:00</order_cycle_start>
                <order_cycle_end>2000-01-01 00:00:00</order_cycle_end>
                <refund_fee>0</refund_fee>
                <biz_order_id>12345</biz_order_id>
                <activity_code>0</activity_code>
                <order_biz_status>0</order_biz_status>
            </article_biz_order>
        </article_biz_orders>
        <total_item>100</total_item>
    </vas_order_search_response>

    异常示例

    • XML示例
    • JSON示例
    1
    2
    3
    4
    5
    6
    <error_response>
        <code>50</code>
        <msg>Remote service error</msg>
        <sub_code>isv.invalid-parameter</sub_code>
        <sub_msg>非法参数</sub_msg>
    </error_response>

    错误码解释

    错误码 错误描述 解决方案
    isp.system-error 系统繁忙 系统繁忙
    1000 入参无效 请检查您的参数
    9999 系统繁忙 系统繁忙
    2009 商品不存在 请检查article_code是否正确

    API工具

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

    如何获得此API

    FAQ

    我要提问
    返回
    顶部