淘宝开放平台

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
behavior_query_dto	BehaviorQueryDTO	必须			请求入参
└ scroll_id String 可选 Hoi0/XwuV6N3DbqMPbZLvA== 前一次请求返回的scrollId └ start_time String 必须 2000-01-01 06:00:00.999 开始时间，日期格式：yyyy-MM-dd HH:mm:ss.SSS └ end_time String 必须 2000-01-01 07:00:00.999 结束时间（不可与开始日期跨天），日期格式：yyyy-MM-dd HH:mm:ss.SSS └ seller_id Number 可选 123 商家id └ algo_order_flag Number 可选 0 null or 0 : 不包含智能回传订单 1 : 包含智能回传订单 2 ：仅包含智能回传订单

名称	类型	示例值	描述
result	Result		返回结果
└ success Boolean true 是否成功 model BehaviorResultDTO {} 返回值 └ scroll_id String Hoi0/XwuV6N3DbqMPbZLvA== 滚动id order_items OrderItem [] 订单明细集合 └ user_id String xxx 用户id └ main_order_id Number 111 主订单id └ sub_order_id Number 111 子订单id └ auction_id Number 111 商品id └ auction_name String 商品名商品名称 └ pay_fee Number 100 支付金额 └ order_status Number 1 订单状态：1:下单，2:支付，3:退款 └ is_ad_order Number 1 是否为投放订单：1是，0否 └ is_pass_back_order Number 1 是否回传：1是，0否 └ user_action_time String 2000-01-01 00:00:00 投放时间 └ order_trade_time String 2000-01-01 00:00:00 交易时间 └ order_refund_time String 2000-01-01 00:00:00 退款时间 └ refund_fee Number 100 退款金额 └ account_id Number 111 投放账号id └ account_name String 账号名投放账号名称 └ ad_id Number 111 广告计划id └ ad_name String xxx 广告计划名称 └ ad_creative_id Number 111 广告创意id └ date String 2000-01-01 00:00:00 数据日期 └ mid1 Number 0 针对巨量广告体验版，图片素材宏参数（下发原始素材id） └ mid2 Number 0 针对巨量广告体验版，标题素材宏参数（下发原始素材id） └ mid3 Number 0 针对巨量广告体验版，视频素材宏参数（下发原始素材id） └ project_id Number 0 巨量升级版本，项目ID └ promotion_id Number 0 巨量升级版本，广告ID └ brand_id Number 0 品牌id └ brand_name String 品牌品牌名称 └ auction_price Number 100 商品单价 └ buy_amount Number 1 购买件数 └ is_attr_by_others Number 0 是否其他平台归因，0否1是 └ cid String xxx cid └ rid String xxx 媒体请求id └ order_create_time String 2000-01-01 00:00:00 订单创建时间 └ source String 1 服务商定义的渠道ID └ seller_id Number 32 商家ID └ is_algo_order Number 0 1:智能回传订单，0:非智能回传订单 └ actual_fee Number 100 实际需要支付的金额 └ step_trade_status Number 1 预售状态：0-非预售单、1- 预付、2- 付尾款、3- 预付关闭 └ shop_name String xxx 店铺名称 └ attr_mode String 1 1表示曝光监测数据、2表示点击监测数据、3表示进店数据 └ item_promotion_price Number 123 商品普惠价，单位分 └ gift_fee Number 100 补贴金额 └ is_gift_order Number 1 是否补贴订单：1-是 └ msg_info String null 响应信息 └ msg_code String null 响应码

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaAlihealthYtWtOrderDataPullRequest req = new AlibabaAlihealthYtWtOrderDataPullRequest();
AlibabaAlihealthYtWtOrderDataPullRequest.BehaviorQueryDTO obj1 = new AlibabaAlihealthYtWtOrderDataPullRequest.BehaviorQueryDTO();
obj1.setScrollId("Hoi0/XwuV6N3DbqMPbZLvA==");
obj1.setStartTime("2000-01-01 06:00:00.999");
obj1.setEndTime("2000-01-01 07:00:00.999");
obj1.setSellerId(123L);
obj1.setAlgoOrderFlag(0L);
req.setBehaviorQueryDto(obj1);
AlibabaAlihealthYtWtOrderDataPullResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaAlihealthYtWtOrderDataPullRequest req = new AlibabaAlihealthYtWtOrderDataPullRequest();
AlibabaAlihealthYtWtOrderDataPullRequest.BehaviorQueryDTODomain obj1 = new AlibabaAlihealthYtWtOrderDataPullRequest.BehaviorQueryDTODomain();
obj1.ScrollId = "Hoi0/XwuV6N3DbqMPbZLvA==";
obj1.StartTime = "2000-01-01 06:00:00.999";
obj1.EndTime = "2000-01-01 07:00:00.999";
obj1.SellerId = 123L;
obj1.AlgoOrderFlag = 0L;
req.BehaviorQueryDto_ = obj1;
AlibabaAlihealthYtWtOrderDataPullResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaAlihealthYtWtOrderDataPullRequest;
$behavior_query_dto = new BehaviorQueryDTO;
$behavior_query_dto->scroll_id="Hoi0/XwuV6N3DbqMPbZLvA==";
$behavior_query_dto->start_time="2000-01-01 06:00:00.999";
$behavior_query_dto->end_time="2000-01-01 07:00:00.999";
$behavior_query_dto->seller_id="123";
$behavior_query_dto->algo_order_flag="0";
$req->setBehaviorQueryDto(json_encode($behavior_query_dto));
$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.alihealth.yt.wt.order.data.pull' \
-d 'partner_id=apidoc' \
-d 'sign=1BC4F577B8B8897B77E10D9194E1BA29' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-17+22%3A10%3A01' \
-d 'v=2.0' \
-d 'behavior_query_dto=null'

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

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

req.behavior_query_dto="数据结构示例JSON格式"
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.alihealth.yt.wt.order.data.pull");
add_param(pRequest,"behavior_query_dto","数据结构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.alihealth.yt.wt.order.data.pull', {
	'behavior_query_dto':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_alihealth_yt_wt_order_data_pull_response>
    <result>
        <success>true</success>
        <model>
            <scroll_id>Hoi0/XwuV6N3DbqMPbZLvA==</scroll_id>
            <order_items>
                <order_item>
                    <user_id>xxx</user_id>
                    <main_order_id>111</main_order_id>
                    <sub_order_id>111</sub_order_id>
                    <auction_id>111</auction_id>
                    <auction_name>商品名</auction_name>
                    <pay_fee>100</pay_fee>
                    <order_status>1</order_status>
                    <is_ad_order>1</is_ad_order>
                    <is_pass_back_order>1</is_pass_back_order>
                    <user_action_time>2000-01-01 00:00:00</user_action_time>
                    <order_trade_time>2000-01-01 00:00:00</order_trade_time>
                    <order_refund_time>2000-01-01 00:00:00</order_refund_time>
                    <refund_fee>100</refund_fee>
                    <account_id>111</account_id>
                    <account_name>账号名</account_name>
                    <ad_id>111</ad_id>
                    <ad_name>xxx</ad_name>
                    <ad_creative_id>111</ad_creative_id>
                    <date>2000-01-01 00:00:00</date>
                    <mid1>0</mid1>
                    <mid2>0</mid2>
                    <mid3>0</mid3>
                    <project_id>0</project_id>
                    <promotion_id>0</promotion_id>
                    <brand_id>0</brand_id>
                    <brand_name>品牌</brand_name>
                    <auction_price>100</auction_price>
                    <buy_amount>1</buy_amount>
                    <is_attr_by_others>0</is_attr_by_others>
                    <cid>xxx</cid>
                    <rid>xxx</rid>
                    <order_create_time>2000-01-01 00:00:00</order_create_time>
                    <source>1</source>
                    <seller_id>32</seller_id>
                    <is_algo_order>0</is_algo_order>
                    <actual_fee>100</actual_fee>
                    <step_trade_status>1</step_trade_status>
                    <shop_name>xxx</shop_name>
                    <attr_mode>1</attr_mode>
                    <item_promotion_price>123</item_promotion_price>
                    <gift_fee>100</gift_fee>
                    <is_gift_order>1</is_gift_order>
                </order_item>
            </order_items>
        </model>
        <msg_info>null</msg_info>
        <msg_code>null</msg_code>
    </result>
</alibaba_alihealth_yt_wt_order_data_pull_response>

{
    "alibaba_alihealth_yt_wt_order_data_pull_response":{
        "result":{
            "success":true,
            "model":{
                "scroll_id":"Hoi0\/XwuV6N3DbqMPbZLvA==",
                "order_items":{
                    "order_item":[
                        {
                            "user_id":"xxx",
                            "main_order_id":111,
                            "sub_order_id":111,
                            "auction_id":111,
                            "auction_name":"商品名",
                            "pay_fee":100,
                            "order_status":1,
                            "is_ad_order":1,
                            "is_pass_back_order":1,
                            "user_action_time":"2000-01-01 00:00:00",
                            "order_trade_time":"2000-01-01 00:00:00",
                            "order_refund_time":"2000-01-01 00:00:00",
                            "refund_fee":100,
                            "account_id":111,
                            "account_name":"账号名",
                            "ad_id":111,
                            "ad_name":"xxx",
                            "ad_creative_id":111,
                            "date":"2000-01-01 00:00:00",
                            "mid1":0,
                            "mid2":0,
                            "mid3":0,
                            "project_id":0,
                            "promotion_id":0,
                            "brand_id":0,
                            "brand_name":"品牌",
                            "auction_price":100,
                            "buy_amount":1,
                            "is_attr_by_others":0,
                            "cid":"xxx",
                            "rid":"xxx",
                            "order_create_time":"2000-01-01 00:00:00",
                            "source":"1",
                            "seller_id":32,
                            "is_algo_order":0,
                            "actual_fee":100,
                            "step_trade_status":1,
                            "shop_name":"xxx",
                            "attr_mode":"1",
                            "item_promotion_price":123,
                            "gift_fee":100,
                            "is_gift_order":1
                        }
                    ]
                }
            },
            "msg_info":"null",
            "msg_code":"null"
        }
    }
}

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

错误码	错误描述	解决方案
isv.missing-date-parameter	日期不能为空	根据文档提示填写日期参数
isv.invalid-date-parameter	日期格式错误	根据文档提示填写正确的日期格式
isv.invalid-scrollid-parameter	scroll_id非法	请勿任意填写该参数
isv.system-busy	系统繁忙	请联系技术支持
isv.service-unavailable	服务不可用	请联系技术支持
isv.visit-busy	访问频繁	降低访问频次

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

DSP-API

alibaba.alihealth.yt.wt.order.data.pull (阿里健康外投订单明细拉取)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ