淘宝开放平台

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
query	EBookUserOrderPageQuery	必须			query
└ order_id String 可选 2265905378956907300 订单号 └ curr_page_no Number 必须 1 页码 └ limit Number 必须 10 每页显示记录数

名称	类型	示例值	描述
error_msg	String	成功	错误提示
data	PageResult		数据
└ total Number 68 总数 └ curr_page_no Number 1 当前页 └ last_page Boolean false 是否最后一页 datas TopOrderDTO [] 订单数据 └ actual_total_fee Number 100 实际付款 └ pay_status Number 6 支付状态：// 1 - 未冻结/未付款 -> 等待买家付款 // 2 - 已冻结/已付款 -> 等待卖家发货 // 4 - 已退款 -> 交易关闭 // 6 - 已转交易 -> 交易成功 // 7 - 没有创建外部交易(支付宝交易) // 8 - 交易被淘宝关闭 // 9 - 不可付款 └ seller_open_uid String AAHc5d-EAAeGwJWdwSHnIQLz 卖家openUid └ gmt_create Number 1640140801000 创建时间 └ auction_id String 664403744383 宝贝ID └ gmt_modified Number 1640140817000 编辑时间 └ buyer_open_uid String AAHc5d-EAAeGwJWdwSHnIQLz 买家openUid └ order_id String 2355037778177907000 订单号 └ pay_time Number 1640140816000 支付时间 └ item_id Number 3890001 内容ID └ first_page Boolean true 是否第一页 └ limit Number 5 单页条数 └ page_nos Number 14 总页数
status	Boolean	true	状态：成功/失败

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaTbdxSaasclassEbookUserOrderGetRequest req = new AlibabaTbdxSaasclassEbookUserOrderGetRequest();
AlibabaTbdxSaasclassEbookUserOrderGetRequest.EBookUserOrderPageQuery obj1 = new AlibabaTbdxSaasclassEbookUserOrderGetRequest.EBookUserOrderPageQuery();
obj1.setOrderId("2265905378956907300");
obj1.setCurrPageNo(1L);
obj1.setLimit(10L);
req.setQuery(obj1);
AlibabaTbdxSaasclassEbookUserOrderGetResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaTbdxSaasclassEbookUserOrderGetRequest req = new AlibabaTbdxSaasclassEbookUserOrderGetRequest();
AlibabaTbdxSaasclassEbookUserOrderGetRequest.EBookUserOrderPageQueryDomain obj1 = new AlibabaTbdxSaasclassEbookUserOrderGetRequest.EBookUserOrderPageQueryDomain();
obj1.OrderId = "2265905378956907300";
obj1.CurrPageNo = 1L;
obj1.Limit = 10L;
req.Query_ = obj1;
AlibabaTbdxSaasclassEbookUserOrderGetResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaTbdxSaasclassEbookUserOrderGetRequest;
$query = new EBookUserOrderPageQuery;
$query->order_id="2265905378956907300";
$query->curr_page_no="1";
$query->limit="10";
$req->setQuery(json_encode($query));
$resp = $c->execute($req, $sessionKey);

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.tbdx.saasclass.ebook.user.order.get' \
-d 'partner_id=apidoc' \
-d 'session=fd4bc637-1610-47b3-974d-34c2619d74e2' \
-d 'sign=B32C3144AC280D7AE55299625788EC17' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-02+09%3A01%3A19' \
-d 'v=2.0' \
-d 'query=null'

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

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

req.query="数据结构示例JSON格式"
try:
	resp= req.getResponse(sessionkey)
	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.tbdx.saasclass.ebook.user.order.get");
add_param(pRequest,"query","数据结构JSON示例");
pResponse = top_execute(pClient,pRequest,sessionKey);
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.tbdx.saasclass.ebook.user.order.get', {
	'query':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_tbdx_saasclass_ebook_user_order_get_response>
    <error_msg>成功</error_msg>
    <data>
        <total>68</total>
        <curr_page_no>1</curr_page_no>
        <last_page>false</last_page>
        <datas>
            <top_order_d_t_o>
                <actual_total_fee>100</actual_total_fee>
                <pay_status>6</pay_status>
                <seller_open_uid>AAHc5d-EAAeGwJWdwSHnIQLz</seller_open_uid>
                <gmt_create>1640140801000</gmt_create>
                <auction_id>664403744383</auction_id>
                <gmt_modified>1640140817000</gmt_modified>
                <buyer_open_uid>AAHc5d-EAAeGwJWdwSHnIQLz</buyer_open_uid>
                <order_id>2355037778177907000</order_id>
                <pay_time>1640140816000</pay_time>
                <item_id>3890001</item_id>
            </top_order_d_t_o>
        </datas>
        <first_page>true</first_page>
        <limit>5</limit>
        <page_nos>14</page_nos>
    </data>
    <status>true</status>
</alibaba_tbdx_saasclass_ebook_user_order_get_response>

{
    "alibaba_tbdx_saasclass_ebook_user_order_get_response":{
        "error_msg":"成功",
        "data":{
            "total":68,
            "curr_page_no":1,
            "last_page":false,
            "datas":{
                "top_order_d_t_o":[
                    {
                        "actual_total_fee":100,
                        "pay_status":6,
                        "seller_open_uid":"AAHc5d-EAAeGwJWdwSHnIQLz",
                        "gmt_create":1640140801000,
                        "auction_id":"664403744383",
                        "gmt_modified":1640140817000,
                        "buyer_open_uid":"AAHc5d-EAAeGwJWdwSHnIQLz",
                        "order_id":"2355037778177907000",
                        "pay_time":1640140816000,
                        "item_id":3890001
                    }
                ]
            },
            "first_page":true,
            "limit":5,
            "page_nos":14
        },
        "status":true
    }
}

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

淘宝大学API

alibaba.tbdx.saasclass.ebook.user.order.get (用户电子书订单数据获取)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ