淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
order_top_cursor_query_dto	OrderTopCursorQueryDTO	可选			查询入参
└ start_time String 必须 2024-09-01 00:00:00.100 查询开始时间，日期格式：yyyy-MM-dd HH:mm:ss.SSS └ end_time String 必须 2024-09-01 00:00:05.200 查询结束时间（不可与开始日期跨天），日期格式：yyyy-MM-dd HH:mm:ss.SSS └ cursor_id String 可选 einsqpfgsgx 页码游标值：上一次请求返回的游标id；第一次请求时不传 └ prod_type Number 可选 1 产品类型：1-udsmart 2-流量通Pro

名称	类型	示例值	描述
result	OrderDetailCursorTopDTO []		订单明细详情
└ seller_id Number 123 商家id └ seller_nick String xxxxx nick └ brand_id Number xxx 品牌id └ order_id Number 111111 主订单id └ sub_order_id Number 1111112 子订单id └ item_id Number 123 商品id（点击item） └ item_name String xxx 商品名称（点击item） └ pay_item_id Number 123 商品id（下单item） └ pay_item_name String xxx 商品名称（下单item） └ order_status Number 1 订单状态：1-拍下；2-支付；3-退款；4-预售；5-收货 └ order_create_time String 2024-09-01 00:00:00 订单创建时间 └ pay_fee Number 1000 支付金额（单位分） └ due_pay_fee Number 1000 待支付金额（单位分） └ order_pay_time String 2024-09-01 00:00:00 订单支付时间，当order_status=1时无意义 └ actual_pay_fee Number 1000 实际支付金额（扣除运费、税费） └ order_refund_time String 2024-09-01 00:00:00 订单退款时间，订单支付时间，当order_status为1,2,4时无意义 └ order_refund_fee Number 1000 订单退款金额（单位分） └ is_ad_order Number 1 是否广告订单:1-是，0-不是 └ channel_id Number 1 渠道(媒体)id，1-巨量2.0，104-腾讯3.0，105-快手，108-B站 └ click_time String 2024-09-01 00:00:00 广告点击时间 └ advertiser_id Number 123 投放账户id └ mid1 String 123 针对巨量2.0，图片素材宏参（下发原始素材id） └ mid2 String 123 针对巨量2.0，标题素材宏参（下发原始素材id） └ mid3 String 123 针对巨量2.0，视频素材宏参（下发原始素材id） └ syn_click_id String xxxx 同步clickid └ syn_request_id String xxxx 同步requestid └ asyn_click_id String xxxx 异步clickid └ asyn_request_id String xxxx 异步requestid └ project_id Number 123 针对巨量2.0，项目id └ promotion_id Number 123 针对巨量2.0，广告id └ monitor_unique_id String xxxx 监测唯一id └ presale_deposit_fee Number 1000 定金金额（单位分） └ remaining_payment_fee Number 1000 尾款金额（单位分） └ is_attr_by_others Number 0 是否被其他渠道归因，1-是，被其他归因渠道包含UD智汇投、UD RTA、流量通Pro；0或空：否，仅在支付状态order_status=2时有意义 └ campaign_id Number 123 计划id └ adgroup_id Number 123 广告id └ creative_id Number 123 创意id └ buy_amount Number 1 购买件数 └ shop_name String xxxx 店铺名称 └ commission_rate String 1.5 流量通Pro订单服务费率。单位% └ commission_fee Number 1 流量通Pro订单成交预估服务费，单位分；实际服务费以后台结算为准 └ item_pic_url String https://xxxx 成交商品主图url └ c_site String 1 广告投放位置，仅channel_id=1时返回 └ c_type String 1 字节创意样式，仅channel_id=1时返回 └ b_vid String jhEX8BPpahQz3xDy B站稿件id，仅channel_id=108时返回
success	Boolean
error_code	String
cursor_id	String	einsqpfgsgx	页码游标，下一次请求传入，实现增量查询
error_msg	String

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaTaobaoUdSmartOrderDetailPullRequest req = new AlibabaTaobaoUdSmartOrderDetailPullRequest();
AlibabaTaobaoUdSmartOrderDetailPullRequest.OrderTopCursorQueryDTO obj1 = new AlibabaTaobaoUdSmartOrderDetailPullRequest.OrderTopCursorQueryDTO();
obj1.setStartTime("2024-09-01 00:00:00.100");
obj1.setEndTime("2024-09-01 00:00:05.200");
obj1.setCursorId("einsqpfgsgx");
obj1.setProdType(1L);
req.setOrderTopCursorQueryDto(obj1);
AlibabaTaobaoUdSmartOrderDetailPullResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaTaobaoUdSmartOrderDetailPullRequest req = new AlibabaTaobaoUdSmartOrderDetailPullRequest();
AlibabaTaobaoUdSmartOrderDetailPullRequest.OrderTopCursorQueryDTODomain obj1 = new AlibabaTaobaoUdSmartOrderDetailPullRequest.OrderTopCursorQueryDTODomain();
obj1.StartTime = "2024-09-01 00:00:00.100";
obj1.EndTime = "2024-09-01 00:00:05.200";
obj1.CursorId = "einsqpfgsgx";
obj1.ProdType = 1L;
req.OrderTopCursorQueryDto_ = obj1;
AlibabaTaobaoUdSmartOrderDetailPullResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaTaobaoUdSmartOrderDetailPullRequest;
$order_top_cursor_query_dto = new OrderTopCursorQueryDTO;
$order_top_cursor_query_dto->start_time="2024-09-01 00:00:00.100";
$order_top_cursor_query_dto->end_time="2024-09-01 00:00:05.200";
$order_top_cursor_query_dto->cursor_id="einsqpfgsgx";
$order_top_cursor_query_dto->prod_type="1";
$req->setOrderTopCursorQueryDto(json_encode($order_top_cursor_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.taobao.ud.smart.order.detail.pull' \
-d 'partner_id=apidoc' \
-d 'sign=2476E5A3DDF43B68047EE630B6EF75AC' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-30+17%3A32%3A25' \
-d 'v=2.0' \
-d 'order_top_cursor_query_dto=null'

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

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

req.order_top_cursor_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.taobao.ud.smart.order.detail.pull");
add_param(pRequest,"order_top_cursor_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.taobao.ud.smart.order.detail.pull', {
	'order_top_cursor_query_dto':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_taobao_ud_smart_order_detail_pull_response>
    <result>
        <order_detail_cursor_top_d_t_o>
            <seller_id>123</seller_id>
            <seller_nick>xxxxx</seller_nick>
            <brand_id>xxx</brand_id>
            <order_id>111111</order_id>
            <sub_order_id>1111112</sub_order_id>
            <item_id>123</item_id>
            <item_name>xxx</item_name>
            <pay_item_id>123</pay_item_id>
            <pay_item_name>xxx</pay_item_name>
            <order_status>1</order_status>
            <order_create_time>2024-09-01 00:00:00</order_create_time>
            <pay_fee>1000</pay_fee>
            <due_pay_fee>1000</due_pay_fee>
            <order_pay_time>2024-09-01 00:00:00</order_pay_time>
            <actual_pay_fee>1000</actual_pay_fee>
            <order_refund_time>2024-09-01 00:00:00</order_refund_time>
            <order_refund_fee>1000</order_refund_fee>
            <is_ad_order>1</is_ad_order>
            <channel_id>1</channel_id>
            <click_time>2024-09-01 00:00:00</click_time>
            <advertiser_id>123</advertiser_id>
            <mid1>123</mid1>
            <mid2>123</mid2>
            <mid3>123</mid3>
            <syn_click_id>xxxx</syn_click_id>
            <syn_request_id>xxxx</syn_request_id>
            <asyn_click_id>xxxx</asyn_click_id>
            <asyn_request_id>xxxx</asyn_request_id>
            <project_id>123</project_id>
            <promotion_id>123</promotion_id>
            <monitor_unique_id>xxxx</monitor_unique_id>
            <presale_deposit_fee>1000</presale_deposit_fee>
            <remaining_payment_fee>1000</remaining_payment_fee>
            <is_attr_by_others>0</is_attr_by_others>
            <campaign_id>123</campaign_id>
            <adgroup_id>123</adgroup_id>
            <creative_id>123</creative_id>
            <buy_amount>1</buy_amount>
            <shop_name>xxxx</shop_name>
            <commission_rate>1.5</commission_rate>
            <commission_fee>1</commission_fee>
            <item_pic_url>https://xxxx</item_pic_url>
            <c_site>1</c_site>
            <c_type>1</c_type>
            <b_vid>jhEX8BPpahQz3xDy</b_vid>
        </order_detail_cursor_top_d_t_o>
    </result>
    <cursor_id>einsqpfgsgx</cursor_id>
</alibaba_taobao_ud_smart_order_detail_pull_response>

{
    "alibaba_taobao_ud_smart_order_detail_pull_response":{
        "result":{
            "order_detail_cursor_top_d_t_o":[
                {
                    "seller_id":123,
                    "seller_nick":"xxxxx",
                    "brand_id":xxx,
                    "order_id":111111,
                    "sub_order_id":1111112,
                    "item_id":123,
                    "item_name":"xxx",
                    "pay_item_id":123,
                    "pay_item_name":"xxx",
                    "order_status":1,
                    "order_create_time":"2024-09-01 00:00:00",
                    "pay_fee":1000,
                    "due_pay_fee":1000,
                    "order_pay_time":"2024-09-01 00:00:00",
                    "actual_pay_fee":1000,
                    "order_refund_time":"2024-09-01 00:00:00",
                    "order_refund_fee":1000,
                    "is_ad_order":1,
                    "channel_id":1,
                    "click_time":"2024-09-01 00:00:00",
                    "advertiser_id":123,
                    "mid1":"123",
                    "mid2":"123",
                    "mid3":"123",
                    "syn_click_id":"xxxx",
                    "syn_request_id":"xxxx",
                    "asyn_click_id":"xxxx",
                    "asyn_request_id":"xxxx",
                    "project_id":123,
                    "promotion_id":123,
                    "monitor_unique_id":"xxxx",
                    "presale_deposit_fee":1000,
                    "remaining_payment_fee":1000,
                    "is_attr_by_others":0,
                    "campaign_id":123,
                    "adgroup_id":123,
                    "creative_id":123,
                    "buy_amount":1,
                    "shop_name":"xxxx",
                    "commission_rate":"1.5",
                    "commission_fee":1,
                    "item_pic_url":"https:\/\/xxxx",
                    "c_site":"1",
                    "c_type":"1",
                    "b_vid":"jhEX8BPpahQz3xDy"
                }
            ]
        },
        "cursor_id":"einsqpfgsgx"
    }
}

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

开放平台

阿里妈妈-UniDesk

alibaba.taobao.ud.smart.order.detail.pull (UD效果外投订单明细拉取)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ